A real-time chat interpreter for Korabli.
English Document
·
中文文档
Report Bug
·
Request Feature
This is a real-time chat interpreter for Korabli developed from wows-replays. It gets the chat messages from the temp.wowsreplay and tempArenaInfo.json files in the replays folder under the game root directory, translates them to the selected language and sends the result to the client via a WebSocket server. The translation is done using the Aliyun Translation API.
For clients, any WebSocket client can be used to connect to the server. The messages are turned into strings by Chatrans before sending them to the client. A available client is WebSocket-Receiver, which is a WebSocket receiving client in HTML. The demo of the client can be found here. Be cautious that since the server is using ws instead of wss, you should use http instead of https to access the website client.
- Add in-gaming chat message interpreter
The compiled executable can be found in the releases page. Choose the proper version and download the executable, such as chatrans-v0.1.1-13.1.0-x86_64-windows-msvc.zip.
You can also compile the project yourself. The following instructions will help you to compile the project.
- rustc
- Installation: Rustup
- Clone the repository.
git clone git@github.com:Yusux/Korabli-chatrans.git cd Korabli-chatrans - Pull submodules.
git submodule update --init --recursive
P.S. This part is for getting the
scriptsfolder unpacked from the game. We provide the latest scripts from the official server in Korabli-scripts, but we cannot guarantee that it will be updated in time for every server update. If the previous version of Chatrans cannot work properly after the game version is updated, please try to update this submodule first or unpack the scripts yourself and put them in theaddons/scriptsfolder. - Compile the project.
cargo build --release
- The compiled executable
chatrans.exewill be found intarget/release/directory.
By using chatrans.exe -h, you can see the help message.
Usage: chatrans.exe [OPTIONS] --replay-dir <REPLAY_DIR>
Options:
-r, --replay-dir <REPLAY_DIR>
The replay dir to use
-t, --target-language <TARGET_LANGUAGE>
The target language, where `zh` stands for Chinese, `en` stands for English. Default is `zh` [default: zh]
-i, --ip <IP>
The server ip to use [default: 0.0.0.0]
-p, --port <PORT>
The server port to use [default: 38080]
--access-key-id <ACCESS_KEY_ID>
The Aliyun access key id
--access-key-secret <ACCESS_KEY_SECRET>
The Aliyun access key secret
-h, --help
Print help
-V, --version
Print version
To enable the translation, you need to provide the access key id and access key secret of the Aliyun Translation API.
(Pricing Docs from Aliyun) Machine Translation is available in the universal edition and professional edition, and provides a free monthly quota of 1 million characters.
This should be enough for personal daily use. In this case, you can use the following command to start the server. Also, it is recommended to use sub accounts to avoid the risk of leaking the access key id and access key secret (no user data is collected by Chatrans).
.\chatrans.exe -r 'path\to\replays' --access-key-id ACCESS_KEY_ID --access-key-secret ACCESS_KEY_SECRETOpen the client and connect to the server. The messages will be sent to the client in real-time. The format of the messages is [Time] Sender to Audience: Translated |Original|.
If you don't want to use the Aliyun Translation API, you can use the following command to start the server. The messages will be sent to the client without translation.
.\chatrans.exe -r 'path\to\replays'Then on the website client, you can use an add-on called Immersive Translate to translate the messages. The add-on is available on Chrome, Firefox, Edge and so on. It is recommended to set the original language to Russian in the add-on settings.
The client can be any WebSocket client, and can be opened on any device, such as a phone, a tablet, a computer, and so on, as long as it can connect to the server under the ws protocol.
Any contributions you make are greatly appreciated. You can fork the repository and make a pull request. Also, you can open an issue if you find a bug or want to request a feature.
Distributed under the MIT License. See LICENSE for more information.