diff --git a/README.md b/README.md deleted file mode 100644 index 13c563a6..00000000 --- a/README.md +++ /dev/null @@ -1,116 +0,0 @@ -
- - - - - VRCT Logo - - -
-
- -[![GitHub release](https://img.shields.io/github/v/release/misyaguziya/VRCT.svg)](https://github.com/misyaguziya/VRCT/releases) -[![Downloads](https://img.shields.io/github/downloads/misyaguziya/VRCT/total)](https://github.com/misyaguziya/VRCT/releases) -[![Licence](https://img.shields.io/github/license/misyaguziya/VRCT)](https://github.com/misyaguziya/VRCT/blob/master/LICENSE) -[![Booth](https://img.shields.io/badge/Store-Booth.pm-red)](https://misyaguziya.booth.pm/items/5155325) -[![Github Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-30363D?&logo=GitHub-Sponsors&logoColor=EA4AAA)](https://github.com/sponsors/misyaguziya) - -

-Become a VRCT Supporter on: -

- - - - - - PIXIV FANBOX - -   - - - - - - Patreon - -   - - - - Ko-fi - -   - -
- - - - - Supporter Section Border - - -
-
- -| **English** | [日本語](./README.ja.md) | [한국어](./README.ko.md) | [繁體中文](./README.zh-Hant.md) | - -

-VRCT is software that supports VRChat conversations with translation and transcription. -

- -![](docs/main_window.png) - -
- -# Download & Install -Download from anywhere you like. -- [Github.com](https://github.com/misyaguziya/VRCT/releases/) -- [BOOTH.pm](https://misyaguziya.booth.pm/items/5155325) - -Just download and run the exe. - -# What is VRCT? -VRCT is software that supports conversations between people who speak different languages by providing chat or voice translation. -These features are designed for use within VRChat. -*Although not supported, it is also used for other purposes such as watching movies. - -VRCT supports your conversations with -- 💬 **Send chat to VRChat** -- 🌐 **Translation** -- 🎙 **Transcription of audio from microphone** -- 🔈 **Transcription of audio from Speaker** - -# Documents -Initial setup, basic functions, and other features are also described. -- [Documents Link](https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4) - -# How to Use (YouTube) -
- -[![](https://img.youtube.com/vi/rUTad037n8Q/0.jpg)](https://www.youtube.com/watch?v=rUTad037n8Q) - -
- -# If you want to run it in python -1. Install the following version of python. - `python version 3.11.5` -2. Install package and run main.py. - ```bash - ./install.bat - python main.py - ``` - -## Author -- [みしゃ(misyaguzi)](https://github.com/misyaguziya) (Main Development) -- [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI multilingual support) -- [レラ](https://github.com/soumt-r) (Technical Support) -- [どね](https://twitter.com/done_vrc) (Logo Design) - -## Thanks to our contributors - - - - ---- - -VRCT is not endorsed by VRChat and does not reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat properties. VRChat and all associated properties are trademarks or registered trademarks of VRChat Inc. VRChat © VRChat Inc. \ No newline at end of file diff --git a/README.md b/README.md new file mode 120000 index 00000000..ab3e36da --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +docs/readmes/README.en.md \ No newline at end of file diff --git a/docs/kofi_logo.png b/docs/img/kofi_logo.png similarity index 100% rename from docs/kofi_logo.png rename to docs/img/kofi_logo.png diff --git a/docs/main_window.png b/docs/img/main_window.png similarity index 100% rename from docs/main_window.png rename to docs/img/main_window.png diff --git a/docs/patreon_logo_black.png b/docs/img/patreon_logo_black.png similarity index 100% rename from docs/patreon_logo_black.png rename to docs/img/patreon_logo_black.png diff --git a/docs/patreon_logo_white.png b/docs/img/patreon_logo_white.png similarity index 100% rename from docs/patreon_logo_white.png rename to docs/img/patreon_logo_white.png diff --git a/docs/pixiv_fanbox_black.png b/docs/img/pixiv_fanbox_black.png similarity index 100% rename from docs/pixiv_fanbox_black.png rename to docs/img/pixiv_fanbox_black.png diff --git a/docs/pixiv_fanbox_white.png b/docs/img/pixiv_fanbox_white.png similarity index 100% rename from docs/pixiv_fanbox_white.png rename to docs/img/pixiv_fanbox_white.png diff --git a/docs/supporter_section_border_d.png b/docs/img/supporter_section_border_d.png similarity index 100% rename from docs/supporter_section_border_d.png rename to docs/img/supporter_section_border_d.png diff --git a/docs/supporter_section_border_l.png b/docs/img/supporter_section_border_l.png similarity index 100% rename from docs/supporter_section_border_l.png rename to docs/img/supporter_section_border_l.png diff --git a/docs/vrct_logo.png b/docs/img/vrct_logo.png similarity index 100% rename from docs/vrct_logo.png rename to docs/img/vrct_logo.png diff --git a/docs/vrct_logo_black.png b/docs/img/vrct_logo_black.png similarity index 100% rename from docs/vrct_logo_black.png rename to docs/img/vrct_logo_black.png diff --git a/docs/vrct_logo_white.png b/docs/img/vrct_logo_white.png similarity index 100% rename from docs/vrct_logo_white.png rename to docs/img/vrct_logo_white.png diff --git a/docs/readmes/README.en.md b/docs/readmes/README.en.md new file mode 100644 index 00000000..f3f35a16 --- /dev/null +++ b/docs/readmes/README.en.md @@ -0,0 +1,107 @@ +
+ + + + + VRCT Logo + + +
+
+ +[![GitHub release](https://img.shields.io/github/v/release/misyaguziya/VRCT.svg)](https://github.com/misyaguziya/VRCT/releases) +[![Downloads](https://img.shields.io/github/downloads/misyaguziya/VRCT/total)](https://github.com/misyaguziya/VRCT/releases) +[![Licence](https://img.shields.io/github/license/misyaguziya/VRCT)](https://github.com/misyaguziya/VRCT/blob/master/LICENSE) +[![Booth](https://img.shields.io/badge/Store-Booth.pm-red)](https://misyaguziya.booth.pm/items/5155325) +[![Github Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-30363D?&logo=GitHub-Sponsors&logoColor=EA4AAA)](https://github.com/sponsors/misyaguziya) + +

+Become a VRCT Supporter on: +

+ + + + + + PIXIV FANBOX + +   + + + + + + Patreon + +   + + + + Ko-fi + +   + +
+ + + + + Supporter Section Border + + +
+
+ +| **English** | [日本語](/docs/readmes/README.ja.md) | [한국어](/docs/readmes/README.ko.md) | [繁體中文](/docs/readmes/README.zh-Hant.md) | + +

+VRCT is software that supports VRChat conversations with translation and transcription. +

+ +![](/docs/img/main_window.png) + +
+ +# Download & Install +Download from anywhere you like. +- [Github.com](https://github.com/misyaguziya/VRCT/releases/) +- [BOOTH.pm](https://misyaguziya.booth.pm/items/5155325) + +Just download and run the exe. + +# What is VRCT? +VRCT is software that supports conversations between people who speak different languages by providing chat or voice translation. +These features are designed for use within VRChat. +*Although not supported, it is also used for other purposes such as watching movies. + +VRCT supports your conversations with +- 💬 **Send chat to VRChat** +- 🌐 **Translation** +- 🎙 **Transcription of audio from microphone** +- 🔈 **Transcription of audio from Speaker** + +# Documents +Initial setup, basic functions, and other features are also described. +- [Documents Link](https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4) + +# How to Use (YouTube) +
+ +[![](https://img.youtube.com/vi/rUTad037n8Q/0.jpg)](https://www.youtube.com/watch?v=rUTad037n8Q) + +
+ +## Author +- [みしゃ(misyaguzi)](https://github.com/misyaguziya) (Main Development) +- [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI multilingual support) +- [レラ](https://github.com/soumt-r) (Technical Support) +- [どね](https://twitter.com/done_vrc) (Logo Design) + +## Thanks to our contributors + + + + +--- + +VRCT is not endorsed by VRChat and does not reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat properties. VRChat and all associated properties are trademarks or registered trademarks of VRChat Inc. VRChat © VRChat Inc. \ No newline at end of file diff --git a/README.ja.md b/docs/readmes/README.ja.md similarity index 67% rename from README.ja.md rename to docs/readmes/README.ja.md index 1d7a8c2a..86efe858 100644 --- a/README.ja.md +++ b/docs/readmes/README.ja.md @@ -1,9 +1,9 @@
- - - VRCT Logo + + + VRCT Logo
@@ -21,44 +21,44 @@ Become a VRCT Supporter on: - - - PIXIV FANBOX + + + PIXIV FANBOX    - - - Patreon + + + Patreon    - Ko-fi + Ko-fi   
- - - Supporter Section Border + + + Supporter Section Border

-| [English](./README.md) | **日本語** | [한국어](./README.ko.md) | [繁體中文](./README.zh-Hant.md) | +| [English](/docs/readmes/README.en.md) | **日本語** | [한국어](/docs/readmes/README.ko.md) | [繁體中文](/docs/readmes/README.zh-Hant.md) |

VRCTは翻訳や文字起こしでVRChatの会話をサポートするソフトウェアです。

-![](docs/main_window.png) +![](/docs/img/main_window.png)
@@ -91,15 +91,6 @@ VRCTはあなたの会話を以下でサポートをします。
-# pythonで実行したい場合 -1. 以下のバージョンのpythonをインストールしてください。 - `python version 3.11.5` -2. packageのインストールとmain.pyを起動してください。 - ```bash - ./install.bat - python main.py - ``` - ## Author - [みしゃ(misyaguzi)](https://github.com/misyaguziya) (メイン開発) - [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI多言語対応) diff --git a/README.ko.md b/docs/readmes/README.ko.md similarity index 67% rename from README.ko.md rename to docs/readmes/README.ko.md index cffa325c..d09e9d36 100644 --- a/README.ko.md +++ b/docs/readmes/README.ko.md @@ -1,9 +1,9 @@
- - - VRCT Logo + + + VRCT Logo
@@ -21,44 +21,44 @@ Become a VRCT Supporter on: - - - PIXIV FANBOX + + + PIXIV FANBOX    - - - Patreon + + + Patreon    - Ko-fi + Ko-fi   
- - - Supporter Section Border + + + Supporter Section Border

-| [English](./README.md) | [日本語](./README.ja.md) | **한국어** | [繁體中文](./README.zh-Hant.md) | +| [English](/docs/readmes/README.en.md) | [日本語](/docs/readmes/README.ja.md) | **한국어** | [繁體中文](/docs/readmes/README.zh-Hant.md) |

VRCT는 음성인식 및 번역 기능을 통해 VRChat의 대화를 지원하는 소프트웨어입니다.

-![](docs/main_window.png) +![](/docs/img/main_window.png)
@@ -91,15 +91,6 @@ VRCT는 다음과 같이 당신의 대화를 도와드려요.
-# python으로 실행하고 싶은 경우 -1. 다음 버전의 python을 설치합니다. - `python version 3.11.5` -2. 패키지를 설치하고 main.py를 실행합니다. - ```bash - ./install.bat - python main.py - ``` - ## Author - [みしゃ(misyaguzi)](https://github.com/misyaguziya) (주요 개발) - [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI 다국어 지원) diff --git a/README.zh-Hant.md b/docs/readmes/README.zh-Hant.md similarity index 64% rename from README.zh-Hant.md rename to docs/readmes/README.zh-Hant.md index ea79a1b1..05a8fece 100644 --- a/README.zh-Hant.md +++ b/docs/readmes/README.zh-Hant.md @@ -1,9 +1,9 @@
- - - VRCT Logo + + + VRCT Logo
@@ -21,44 +21,44 @@ Become a VRCT Supporter on: - - - PIXIV FANBOX + + + PIXIV FANBOX    - - - Patreon + + + Patreon    - Ko-fi + Ko-fi   
- - - Supporter Section Border + + + Supporter Section Border

-| [English](./README.md) | [日本語](./README.ja.md) | [한국어](./README.ko.md) | **繁體中文** | +| [English](/docs/readmes/README.en.md) | [日本語](/docs/readmes/README.ja.md) | [한국어](/docs/readmes/README.ko.md) | **繁體中文** |

VRCT 是一個支援 VRChat 對話翻譯和紀錄的軟體。

-![](docs/main_window.png) +![](/docs/img/main_window.png)
@@ -90,15 +90,6 @@ VRCT 可以：
-# 原始碼啟動 -1. 安裝此版本的 Python。 - `python version 3.11.5` -2. 安裝 package 並啟動 main.py。 - ```bash - ./install.bat - python main.py - ``` - ## 作者 - [みしゃ(misyaguzi)](https://github.com/misyaguziya) (主要開發) - [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI 多語系支援)