Merge branch 'README' into UI_2.0
This commit is contained in:
misyaguziya
65
README.jp.md
Normal file
65
README.jp.md
Normal file
@@ -0,0 +1,65 @@
|
||||
<div align="center">
|
||||
|
||||
|
||||
[](https://github.com/misyaguziya/VRCT/releases)
|
||||
[](https://github.com/misyaguziya/VRCT/releases)
|
||||
[](https://github.com/misyaguziya/VRCT/blob/master/LICENSE)
|
||||
[](https://misyaguziya.booth.pm/items/5155325)
|
||||
|
||||
| [English](./README.md) | **日本語** |
|
||||
|
||||
<h3>
|
||||
VRCTは翻訳や文字起こしでVRChatの会話をサポートするソフトウェアです。
|
||||
</h3>
|
||||
|
||||
|
||||
|
||||
<div align="left">
|
||||
|
||||
# ダウンロード＆インストール
|
||||
好きな場所からダウンロードしてください。
|
||||
- [Github.com](https://github.com/misyaguziya/VRCT/releases/)
|
||||
- [BOOTH.pm](https://misyaguziya.booth.pm/items/5155325)
|
||||
|
||||
ダウンロードしてexeを起動するだけです。
|
||||
|
||||
# VRCTってなに？
|
||||
VRCTは話す言語の異なる人同士が会話を行うためにチャットもしくは音声の翻訳を行うことで会話をサポートするソフトウェアです。
|
||||
これらの機能はVRChat内で使用するために設計されています。
|
||||
※サポート対象外ですがその他の用途として映画鑑賞等でも使用されています。
|
||||
|
||||
VRCTはあなたの会話を以下でサポートをします。
|
||||
- 💬 **VRChatへのチャット送信機能**
|
||||
- 🌐 **翻訳機能**
|
||||
- 🎙 **マイクの文字起こし機能**
|
||||
- 🔈 **スピーカーの文字起こし機能**
|
||||
|
||||
# ドキュメント
|
||||
初期設定や基本機能、その他の機能についても記載してあります。
|
||||
- [Documents Link](https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4)
|
||||
|
||||
# 使い方(Youtube)
|
||||
<div align="center">
|
||||
|
||||
[](https://www.youtube.com/watch?v=mI4DQaeaAPI)
|
||||
|
||||
<div align="left">
|
||||
|
||||
# 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多言語対応)
|
||||
- [レラ](https://github.com/soumt-r) (翻訳:韓国語)
|
||||
- [どね]() (ロゴデザイン)
|
||||
|
||||
---
|
||||
|
||||
VRCT は VRChat によって承認されておらず、VRChat または VRChat の開発もしくは管理に公式に関与する者の見解や意見が反映されたものではありません。VRChat および関連するすべての財産は 米国VRChat, Incの商標または登録商標です。
|
||||
143
README.md
143
README.md
@@ -1,116 +1,65 @@
|
||||
<div align="center">
|
||||
|
||||
|
||||
[](https://github.com/misyaguziya/VRCT/releases)
|
||||
[](https://github.com/misyaguziya/VRCT/releases)
|
||||
[](https://github.com/misyaguziya/VRCT/blob/master/LICENSE)
|
||||
[](https://misyaguziya.booth.pm/items/5155325)
|
||||
|
||||
# VRCT (VRChat Chatbox Translator & Transcription)
|
||||
| **English** | [日本語](./README.jp.md) |
|
||||
|
||||
<h3>
|
||||
VRCT is software that supports VRChat conversations with translation and transcription.
|
||||
</h3>
|
||||
|
||||
|
||||
|
||||
<div align="left">
|
||||
|
||||
## Overview
|
||||
VRChatのChatBoxにOSC経由でメッセージを送信するツール
|
||||
翻訳エンジンを使用してメッセージとその翻訳部分を同時に送信することができる
|
||||
# Download & Install
|
||||
Download from anywhere you like.
|
||||
- [Github.com](https://github.com/misyaguziya/VRCT/releases/)
|
||||
- [BOOTH.pm](https://misyaguziya.booth.pm/items/5155325)
|
||||
|
||||
## Requirement
|
||||
- python 3.9.13
|
||||
- pillow
|
||||
- PyAudioWPatch
|
||||
- python-osc
|
||||
- customtkinter
|
||||
- deepl
|
||||
- deepl-translate(https://github.com/misyaguziya/deepl-translate)
|
||||
- translators(https://github.com/misyaguziya/translators)
|
||||
- custom_speech_recognition(https://github.com/misyaguziya/custom_speech_recognition)
|
||||
Just download and run the exe.
|
||||
|
||||
**deepl-translate/translators/custom_speech_recognitionについては追加実装をしています**
|
||||
**`pip install`でinstallした場合、動かないので注意**
|
||||
# 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.
|
||||
|
||||
## install
|
||||
```bash
|
||||
./install.bat
|
||||
```
|
||||
VRCT supports your conversations with
|
||||
- 💬 **Send chat to VRChat**
|
||||
- 🌐 **Translation**
|
||||
- 🎙 **Transcription of audio from microphone**
|
||||
- 🔈 **Transcription of audio from Speaker**
|
||||
|
||||
## Usage
|
||||
```bash
|
||||
python VRCT.py
|
||||
```
|
||||
# Documents
|
||||
Initial setup, basic functions, and other features are also described.
|
||||
- [Documents Link](https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4)
|
||||
|
||||
## Features
|
||||
# How to Use (YouTube)
|
||||
<div align="center">
|
||||
|
||||
### init
|
||||
0. VRChatのOSCを有効にする（重要）
|
||||
[](https://www.youtube.com/watch?v=mI4DQaeaAPI)
|
||||
|
||||
(任意)
|
||||
1. DeepLのAPIを使用するためにアカウント登録し、認証キーを取得する
|
||||
2. ギアアイコンのボタンでconfigウィンドウを開く
|
||||
3. ParameterタブのDeepL Auth Keyに認証キーを記載
|
||||
4. configウィンドウを閉じる
|
||||
<div align="left">
|
||||
|
||||
### Normal use
|
||||
1. メッセージボックスにメッセージを記入
|
||||
2. Enterキーを押し、メッセージを送信する
|
||||
|
||||
### About Checkboxes
|
||||
- translation: 翻訳の有効無効
|
||||
- voice2chatbox: マイクの音声を文字起こししてチャットボックスに送信する
|
||||
- speaker2log: スピーカーの音声から文字起こししてログに表示する
|
||||
- foreground: 最前面表示の有効無効
|
||||
|
||||
### About Textbox
|
||||
- log tab: すべてのログを表示
|
||||
- send tab: 送信したメッセージを表示
|
||||
- receive tab: 受信したメッセージを表示
|
||||
- system tab: 機能についてのメッセージを表示
|
||||
|
||||
### About Config Window
|
||||
- UI tab
|
||||
- Transparency: ウィンドウの透過度の調整
|
||||
- Appearance Theme: ウィンドウテーマを選択
|
||||
- UI Scaling: UIサイズを調整
|
||||
- Font Family: 表示フォントを選択
|
||||
- UI Language: UIの表示言語を選択
|
||||
- Translation tab
|
||||
- Select Translator: 翻訳エンジンの変更
|
||||
- Send Language: 送信するメッセージに対して翻訳する言語[source, target]を選択
|
||||
- Receive Language: 受信したメッセージに対して翻訳する言語[source, target]を選択
|
||||
- Transcription tab
|
||||
- Input Mic Host: マイクのホストAPIを選択
|
||||
- Input Mic Device: マイクを選択
|
||||
- Input Mic Voice Language: 入力する音声の言語
|
||||
- Input Mic Energy Threshold: 音声取得のしきい値
|
||||
- Check threshold point: Input Mic Energy Thresholdのしきい値を視覚化
|
||||
- Input Mic Dynamic Energy Threshold: 音声取得のしきい値の自動調整
|
||||
- Input Mic Phase Timeout: 文字起こしする音声時間の上限
|
||||
- Input Mic Record Timeout: 音声の区切りの無音時間
|
||||
- Input Mic Max Phrases: 保留する単語の上限
|
||||
- Input Mic Word Filter: MICの文字起こし時にWord Filterで設定した文字が入っていた場合にChatboxに表示しない (ex AAA,BBB,CCC)
|
||||
- Input Speaker Device: スピーカーを選択
|
||||
- Input Speaker Voice Language: 受信する音声の言語
|
||||
- Input Speaker Energy Threshold: 音声取得のしきい値
|
||||
- Check threshold point: Input Speaker Energy Thresholdのしきい値を視覚化
|
||||
- Input Speaker Dynamic Energy Threshold: 音声取得のしきい値の自動調整
|
||||
- Input Speaker Record Timeout: 音声の区切りの無音時間
|
||||
- Input Speaker Phase Timeout: 文字起こしする音声時間の上限
|
||||
- Input Speaker Max Phrases: 保留する単語の上限
|
||||
- Parameter tab
|
||||
- OSC IP address: 変更不要
|
||||
- OSC port: 変更不要
|
||||
- DeepL Auth key: DeepLの認証キーの設定
|
||||
- Message Format: 送信するメッセージのデコレーションの設定
|
||||
- [message]がメッセージボックスに記入したメッセージに置換される
|
||||
- [translation]が翻訳されたメッセージに置換される
|
||||
- 初期フォーマット:`[message]([translation])`
|
||||
- Others tab
|
||||
- Auto clear chat box: メッセージ送信後に書き込んだメッセージを空にする
|
||||
- **(New!) Notification XSOverlay: XSOverlayの通知機能を有効(VR only)**
|
||||
# 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)
|
||||
- Main開発
|
||||
- twitter: https://twitter.com/misya_ai
|
||||
- booth: https://misyaguziya.booth.pm/items/4814313
|
||||
- [みしゃ(misyaguzi)](https://github.com/misyaguziya) (Main Development)
|
||||
- [しいな(Shiina_12siy)](https://twitter.com/Shiina_12siy) (UI/UX, UI multilingual support)
|
||||
- [レラ](https://github.com/soumt-r) (Translation:Korean)
|
||||
- [どね]() (Logo Design)
|
||||
|
||||
しいな(Shiina_12siy)
|
||||
- Main開発, 翻訳(英語)
|
||||
---
|
||||
|
||||
レラ
|
||||
- 翻訳(韓国語)
|
||||
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.
|
||||
125
README.txt
125
README.txt
@@ -4,129 +4,14 @@
|
||||
# 概要
|
||||
VRChatで使用されるChatBoxをOSC経由でメッセージを送信するツールになります。
|
||||
翻訳エンジンを使用してメッセージとその翻訳部分を同時に送信することができます。
|
||||
(翻訳エンジンはDeepL,Google,Bingに対応)
|
||||
|
||||
# 使用方法
|
||||
初期設定時
|
||||
0. VRChatのOSCを有効にする（重要）
|
||||
|
||||
(任意)
|
||||
1. DeepLのAPIを使用するためにアカウント登録し、認証キーを取得する
|
||||
2. ギアアイコンのボタンでconfigウィンドウを開く
|
||||
3. ParameterタブのDeepL Auth Keyに認証キーを記載
|
||||
4. configウィンドウを閉じる
|
||||
|
||||
通常使用時
|
||||
1. メッセージボックスにメッセージを記入
|
||||
2. Enterキーを押し、メッセージを送信する
|
||||
|
||||
# その他の設定
|
||||
translation チェックボックス: 翻訳の有効無効
|
||||
voice2chatbox チェックボックス : マイクの音声を文字起こししてチャットボックスに送信する
|
||||
speaker2log チェックボックス : スピーカーの音声から文字起こししてログに表示する
|
||||
foreground チェックボックス: 最前面表示の有効無効
|
||||
|
||||
テキストボックス
|
||||
logタブ
|
||||
すべてのログを表示
|
||||
sendタブ
|
||||
送信したメッセージを表示
|
||||
receiveタブ
|
||||
受信したメッセージを表示
|
||||
systemタブ
|
||||
機能についてのメッセージを表示
|
||||
|
||||
configウィンドウ
|
||||
UIタブ
|
||||
Transparency: ウィンドウの透過度の調整
|
||||
Appearance Theme: ウィンドウテーマを選択
|
||||
UI Scaling: UIサイズを調整
|
||||
Font Family: 表示フォントを選択
|
||||
UI Language: UIの表示言語を選択
|
||||
Translationタブ
|
||||
Select Translator: 翻訳エンジンの変更
|
||||
Send Language: 送信するメッセージに対して翻訳する言語[source, target]を選択
|
||||
Receive Language: 受信したメッセージに対して翻訳する言語[source, target]を選択
|
||||
Transcriptionタブ
|
||||
Input Mic Host: マイクのホストAPIを選択
|
||||
Input Mic Device: マイクを選択
|
||||
Input Mic Voice Language: 入力する音声の言語
|
||||
Input Mic Energy Threshold: 音声取得のしきい値
|
||||
Check threshold point: Input Mic Energy Thresholdのしきい値を視覚化
|
||||
Input Mic Dynamic Energy Threshold: 音声取得のしきい値の自動調整
|
||||
Input Mic Record Timeout: 音声の区切りの無音時間
|
||||
Input Mic Phase Timeout: 文字起こしする音声時間の上限
|
||||
Input Mic Max Phrases: 保留する単語の上限
|
||||
Input Mic Word Filter: MICの文字起こし時にWord Filterで設定した文字が入っていた場合にChatboxに表示しない (ex AAA,BBB,CCC)
|
||||
Input Speaker Device: スピーカーを選択
|
||||
Input Speaker Voice Language: 受信する音声の言語
|
||||
Input Speaker Energy Threshold: 音声取得のしきい値
|
||||
Check threshold point: Input Speaker Energy Thresholdのしきい値を視覚化
|
||||
Input Speaker Dynamic Energy Threshold: 音声取得のしきい値の自動調整
|
||||
Input Speaker Record Timeout: 音声の区切りの無音時間
|
||||
Input Speaker Phase Timeout: 文字起こしする音声時間の上限
|
||||
Input Speaker Max Phrases: 保留する単語の上限
|
||||
Parameterタブ
|
||||
OSC IP address: 変更不要
|
||||
OSC port: 変更不要
|
||||
DeepL Auth key: DeepLの認証キーの設定
|
||||
Message Format: 送信するメッセージのデコレーションの設定
|
||||
[message]がメッセージボックスに記入したメッセージに置換される
|
||||
[translation]が翻訳されたメッセージに置換される
|
||||
初期フォーマット:"[message]([translation])"
|
||||
Othersタブ
|
||||
Auto clear chat box: メッセージ送信後に書き込んだメッセージを空にする
|
||||
(New!) Notification XSOverlay: XSOverlayの通知機能を有効(VR only)
|
||||
|
||||
設定の初期化
|
||||
config.jsonを削除
|
||||
ドキュメント(JP):https://mzsoftware.notion.site/VRCT-Documents-be79b7a165f64442ad8f326d86c22246?pvs=4
|
||||
|
||||
# お問い合わせ
|
||||
要望などはTwitterまで
|
||||
https://twitter.com/misya_ai
|
||||
Googleフォーム:https://t.co/lSlo4brZwm
|
||||
Twitter:https://twitter.com/misya_ai
|
||||
Github:https://github.com/misyaguziya/VRCT
|
||||
|
||||
# アップデート履歴
|
||||
[2023-05-29: v0.1b] v0.1b リリース
|
||||
[2023-05-30: v0.2b]
|
||||
- configボタンをギアアイコンに変更
|
||||
- 詳細情報のボタンを追加
|
||||
- 翻訳機能有効無効のチェックボックスを追加
|
||||
- 最前面表示の有効無効のチェックボックスを追加
|
||||
- いくつかのバグを修正
|
||||
[2023-06-03: v0.3b]
|
||||
- 全体的にUIを刷新
|
||||
- 透過機能を追加
|
||||
- テーマのLight/Dark/Systemのモードの変更機能を追加
|
||||
- UIのスケール変更機能を追加
|
||||
- フォントの変更機能を追加
|
||||
[2023-06-06: v0.4b]
|
||||
- 翻訳エンジンを追加
|
||||
- 入力と出力の翻訳言語を選択できるように変更
|
||||
[2023-06-20: v1.0]
|
||||
- マイクからの音声の文字起こし機能を追加
|
||||
- スピーカーからの音声の文字起こし機能を追加
|
||||
[2023-06-28: v1.1]
|
||||
- いくつかのバクを修正
|
||||
- 翻訳/文字起こし言語の表記を略称からわかりやすい文字に変更
|
||||
- 文字起こしの処理の軽量化
|
||||
[2023-07-05: v1.2]
|
||||
- 文字起こし精度の向上
|
||||
[2023-07-21: v1.3]
|
||||
- UIの表示言語を日本語/英語を選択できる機能を追加
|
||||
- Energy Thresholdの視覚化機能を追加
|
||||
- 文字起こしの誤認識対策のため、Word Filterを追加
|
||||
- WASAPI以外のHostAPIでもマイクとして使用できるようにHostAPIを選択できる機能を追加
|
||||
- メッセージ送信後に書き込んだメッセージを空にするか選択できる機能を追加
|
||||
- バグ対策のため、translation/voice2chatbox/speaker2log/foregroundは起動時はOFFになるように変更
|
||||
- バグ対策のため、スピーカーについて既定デバイス以外を選択した時にERRORが出るように変更
|
||||
- 半角入力時に一部の文字が書き込めないバグを修正
|
||||
[2023-07-22: v1.3.1]
|
||||
- UIの表示言語選択に韓国語を追加
|
||||
[2023-07-30: v1.3.2]
|
||||
- 試験的にXSOverlayへの通知機能を追加
|
||||
- checkbox ONの状態でもConfigを開けるように変更
|
||||
- 文字起こし言語の表示を修正
|
||||
- いくつかのバグを修正
|
||||
|
||||
# 注意事項
|
||||
再配布とかはやめてね
|
||||
[2023-10-21: 2.0.0] v2.0.0 リリース
|
||||
BIN
docs/main_window.png
Normal file
BIN
docs/main_window.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 155 KiB |
Reference in New Issue
Block a user