RuneLingual Transcripts

Welcome to the RuneLingual Transcripts project. This project contains the source files for the RuneLingual translation plugin's transcripts.

What this repository is for

You might be wondering why transcripts aren't just included in the plugin itself as resources. That's because RuneLite has a limit of 10MiB per plugin, and the total size of the transcripts significantly exceeds this limit.

So, when you download RuneLingual from the plugin hub through RuneLite, it won't have any translation data. To solve this issue, RuneLingual downloads the transcripts from this GitHub repository, unpacks them, and uses them to translate everything in-game.

To make this work, we need:

• The translation file itself: The file with translation for many many texts found in OSRS, from English to other language.
• 'Hash files' (hashList_??.txt): These contain compressed versions of transcripts. If two files share the same hash value, they're identical. This is a reliable way to detect changes in the files.
• Character images: For languages with non-English alphabets, we create emojis for each character to display them in-game.
• Key input to alphabet: If a language uses character images, we need a file mapping keyboard inputs to these characters. This ensures correct display of the language in-game.

steps on how the RuneLingual plugin uses these files will be covered in the readme of its repository.

Directory Structure

This project is organized into three main directories:

• public/: This directory contains the finalized and published versions of our transcripts. These are the versions that are distributed to all RuneLingual users. Please do not make direct edits in this directory. Instead, make your edits in the "draft" directory and follow the steps outlined in the draft directory README to publish your changes.

• draft/: This directory is where edits should be made before they're ready to be published to all RuneLingual users. Once you've made your edits and checked that there are no problems, you can ask one of the developers to copy your changes from the draft directory to the public directory.

• updater/: This directory contains scripts and utilities to update and maintain the transcripts. These scripts fetch the latest transcripts from the source, compare the current transcripts with the latest versions, and update the transcripts in the public directory if necessary. For more information, please refer to the README in the updater directory.

Contributing

We welcome contributions to expand our language support. If you'd like to contribute or request support for another language that isn't listed, please contact us.

• If you'd like to contribute or request support for another language that isn't listed, please contact us.
• Feel free to tweak our language packs to your liking. We aim to support multiple language pack variants to accommodate different preferences.

Contact Us

For all inquiries, proposals, or contributions, don't hesitate to get in touch with us.

Should you have any queries, ideas, feedback, or other concerns, we encourage you to join our Discord server and explore the project's issues tab for any suggestions, questions, or feedback.

Disclaimer

This repository is associated with the RuneLingual project, an independent plugin currently under development. Please be aware that this project is not officially connected with Jagex, the developers of OldSchool RuneScape, or RuneLite.

License

This project is licensed under the MIT License.