Allow for QB Translations of Normal and Expert Quest Books (#432 )

[FEATURE]

/* Description: */
Also moves all nodejs stuff into `tools` package.

Also adds a basic `CONTRIBUTING.md` file. 

Superseeds https://github.com/Nomi-CEu/Nomi-CEu/pull/431, which was closed as the branch needed to be renamed, due to the last two items on this list.

TODO:
- [x] Make it only run on master repo.
- [x] Remove qb-lang-revamp branch from the events
- [x] Allow workflow to run on all branches starting with test_buildscript?

/* Commits: */

* Buildscript Changes

* Make Contributing Docs a .md file

* updateqb.yml v1

* Test QB change

* Add lang file to commit file list

* Another Test Change

* Test with only lang path, + `./` at beginning of path

* Test QB change

* updateqb.yml v3

* Test QB Change

* Add some debug settings

* Remove debug, branch input. Switch to auto-commit action

* Make activate: branches prefix `test_buildscript`, commit author GHA bot

* Add branch prefix note into CONTRIBUTING.md

* Make workflow only run if on master repo

2023-09-17 22:44:48 +10:00

1.8 KiB

Raw Blame History

Contributing

More to come!

How to contribute:

Fork this repository
Add commits
PR it back!

Quest Book Contributing

Normal Mode:

Change the quest book .json located at /overrides/config/betterquesting/saved_quests/NormalQuestsDev.json.

Expert Mode:

Change the quest book ``.jsonlocated at/overrides/config/betterquesting/saved_quests/ExpertQuestsDev.json`.

Make sure when you change the files listed above! DO NOT change the lang file(s), or the main .json files, which contain translation keys.

The only exception to this rule is with QB translations. Only change the lang file(s). Notes on how to do this are stated below.

Once the changes are committed to main, GH Actions will automatically update the main QB .json files, and the English QB lang file!

Translations:

You can either make a resource pack, with a lang file located in /questbook/lang, or you can PR a lang file, placed in /overrides/resources/questbook/lang.

Note that both Normal and Expert QB translations are located there.
Each localization entry for each line or quest has a comment above, saying the quest/line id, and the mode it is related to.
The localization entries for normal and expert are seperated by a comment.
line notes above localization keys are for chapters.
db notes above localization keys are for quests.

Info for Maintainers:

Here are some basic notes. I hope that you were explained the basic gist of this project, but here are some finer details:

If you want the QB Transform Workflow to run on your branch, that isn't main, prefix the branch with test_buildscript
If you want the QB Transform Workflow to run on your fork, remove or comment out if: "${{ github.repository_owner == 'Nomi-CEu' }}" in /.github/workflows/updateqb.yml (in your fork)

1.8 KiB Raw Blame History