Please open an Issue or Discussion, or ask on Discord before opening a pull request, to make sure your work doesn't overlap with others.
(TODO: More general contributing info)
Want to help translate Swarm into another language?
- First: you're going to have to speak English. The English text is the "one true root" language that all other languages are derived from, it would be problematic to translate a translation.
- Are you just helping improve an existing language?
- Great! Just edit the file in
languages/(language-code).jsonand improve the translations included
- Great! Just edit the file in
- Do you want to add a new language?
- See example commit here: https://github.com/mcmonkeyprojects/SwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
- In short: copy/paste
languages/en.jsontolanguages/(your-code).json, fill out the info at the top, and start translating keys. - Also add
src/wwwroot/imgs/flags/(your-code).jpgas a small icon image of a flag that represents the language. - You can use https://github.com/mcmonkeyprojects/translate-tool to fill out any keys you can't be bothered filling in yourself with automatic AI-powered translation
- Are you adding new translatable keys?
- I use the hidden webconsole call
debugSubmitTranslatables()to generatelanguages/en.debugwhich contains a raw key list, and then use--add-jsonto add it in with the translate tool.
- I use the hidden webconsole call
By submitting a contribution to this repo, you agree to grant a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to Alex "mcmonkey" Goodwin to use, copy, modify, and distribute your contribution under the terms of the MIT License, view LICENSE.txt for details, and under any future license we may change to.