Welcome to the updater directory of the RuneLingual Transcript Sources. This directory contains scripts and utilities to update and maintain the transcripts used by the RuneLingual plugin.
The Updater directory contains five distinct programs, each designed to perform specific tasks for maintaining and updating transcripts. Below is a detailed description of each program's functionality:
-
main_generate_English_transcript.py: This program is responsible for updating the English transcript from the source. Read the explanation for more detail. -
update_nonEn_transcripts.py: This program reads data from the English transcript database, and updates all other language's excel transcript to include records that are not included in those files. If a translation file doesn't exist, it will create a copy of the English transcript, and add a column for translation -
update_char_images.py: This program creates character images for insertion like emojis in the RuneLite client. This is particularly useful for languages whose alphabets differ significantly from English and cannot be displayed directly through conventional means. -
'excel_to_TSV': This utility processes the Excel transcripts generated by update_nonEn_transcripts.py after translation, converting them into TSV (Tab-Separated Values) format. These TSV files should be reviewed and then moved to the public directory for use by the plugin.
For a deeper understanding of why these scripts are essential, please refer to the README in the top directory.
Firstly clone this repository, and install python to your system. (ask Chat-GPT for mor info, it's very informative!) Then, to add a new language, simply run the programs in the order listed above (1-3).
Program 3 update_char_images.py is unnecessary if the language uses the English alphabet, including characters with accents (like those in Spanish, Portuguese, Norwegian). But for languages such as Japanese, Russian, it must be configured and ran. If you're unsure, ask one of our developers and we'll be able to test it for you.
Firstly clone this repository, and install python to your system. (ask Chat-GPT for mor info, it's very informative!) Then, to update transcripts in language other than English, run program 1 and 2.
If the English transcript is already up to date, run program 2.
After cloning this repository and executing some codes, there should be a transcript for each language stated in common_func.py inside the draft folder.
The transcript file will be in Excel format. You can simply start adding translations in the translation column.
After you've made progress and want to update the plugin, you can either send the file to one of the developers in our Discord server, or make sure the language's folder in draft folder and make a pull request to the GitHub repository.
- Clone the whole repository to your local machine
- Run excel_to_TSV.py. It will turn the Excel transcript to TSV, and also update the hash file value.
- Check inside the target language in draft folder that there is a TSV version of the newly obtained translation.
- Copy the TSV version to the language's folder in public folder. If it already exists, replace it.
- Check that no files have been deleted in other languages' folder.
- After you are sure correct files are in each folder of public folder, make a pull request, and have someone accept it.
We welcome contributions to improve our updater scripts. If you'd like to contribute, please refer to the main README.md file for more information.
Need a hand or have a question? Join us on our Discord server. We're here to help and love hearing from you!
This project is licensed under the MIT License.