Skip to content

jinx-eob1/polywoof

 
 

Repository files navigation

Polywoof for RuneLite!

Translation Framework for RuneLite that can translate ACTUALLY everything1! Widget Text and UI are untouched to prevent confusion of misleading translations. Support for any type of language characters2, including Japanese, Chinese and many others. Embedded H2 SQL database3 with an organized schema for the supported languages and offline translations.

  • Translation for NPC, Player and other dialogs.
  • Translation for Game Messages and Examines.
  • Translation for NPC and Item4 names.
  • Translation for Dialog Options.
  • Translation for Overhead Text.
  • Translation5 for Scrolls, Books, Player Messages and any text on the screen.

Note

List of the Supported Languages.
H2 SQL database is located at ~/.runelite/cache/polywoof.mv.db in your Home directory.

Tip

Use DBeaver, or a similar program to view or edit the database.

Guide for DeepL

Note

API Key is REQUIRED for the DeepL backend!
Best Quality and very recommended, but not available in some regions.

  • You have to register a DeepL account, choose a free or paid DeepL API plan, create an API Key and copy it.
    • If you can't register or verify for any reason – ask someone to help you!
  • Open the config and paste the key into the API Key field, type in your destination Language and choose whatever you want to be translated in the Translation section!
    • Any additional stuff will use your API Quota, so choose wisely.

Guide for Google

Note

API Key is REQUIRED for the Google backend!
Good Choice, might withdraw your money if not careful.

  • You have to create a Google Cloud account, a Cloud Billing account and link it to your default project.
  • Enable the Translation API, create an API Key and copy it.
    • Google will charge you if the API Quota exceeds over 500,000 characters monthly, to prevent that visit the Translation API and set «v2 and v3 general model characters per day» to 16,000 (500,000 ÷ 31).
  • Open the config and paste the key into the API Key field, and you're done!

Guide for MyMemory

Note

Free Service without any fees!
Great Solution for everyone, has a lot of quota but not so perfect.

  • You don't really have to do anything, just leave something in the Email Address field other than blank text.
    • Optionally, you can enter your email address for an additional API Quota of 50,000 (instead of 5,000) characters per day.

Frequently Asked Questions

  • Not working at all, nothing appears, nothing works.
    • You haven't set the required API Key in the config, or got a wrong one.
  • Can't see any words, squares appear but not text.
    • Your Language requires a different charset, try to change the Font or leave the field empty.
  • DeepL or Google are not available in my country, what should I do?
    • I've pointed out in the Guide, you should ask your friends for help.
  • What happens when the quota exceed the limit?
    • Nothing horrible if you have limited your Google API usage, but you have to wait till the ending of the month.
  • I've put everything in the config, but it's translating to English.
    • You've selected the wrong backend in the config, Generic backend for debugging purposes only.
  • How to change where the text boxes appear?
    • Just like any other elements, hold the Alt Key and drag.
  • Can you add an Interface translation? Do you have a plan to make an Unofficial translation?
    • The plugin is designed to be a quick-and-easy Framework and Helper for automatic translations that still require basic English knowledge, not a translation project. Although it's very possible to make it based on the plugin.
  • Please, add a different translation backend, like ChatGPT.
    • I've tried my best to make the code expandable, feel free to Contribute.
  • Some books, text or scrolls are not translating, can you translate these?
    • The UI in this game is very unpredictable, you can translate these manually via the Quick Actions.
  • How to Export or Transfer my saved translations? How to share these with my friends?
    • You have to copy the mentioned H2 SQL file to the same directory on another computer.

Important

If you've encountered any Bugs or need Help – please, join our Discord server!

Early Release Rework

DigitalOcean Referral Badge

Люблю Дэйвика.. 💕
Благодарности Эвилу за помощь! ✨

Footnotes

  1. Not interaction Menus, not Stats, not other basic UI elements.

  2. You may have to specify your own font via the config.

  3. Translations via Quick Actions won't be saved into the database, only temporarily.

  4. Only when you click Examine.

  5. Available only via the context menu of the Quick Actions button.

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%