diff --git a/.github/images/CONTRIBUTING_translations_1.png b/.github/images/CONTRIBUTING_translations_1.png new file mode 100644 index 0000000..e77099d Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_1.png differ diff --git a/.github/images/CONTRIBUTING_translations_10.png b/.github/images/CONTRIBUTING_translations_10.png new file mode 100644 index 0000000..25210d4 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_10.png differ diff --git a/.github/images/CONTRIBUTING_translations_10b.png b/.github/images/CONTRIBUTING_translations_10b.png new file mode 100644 index 0000000..bb266ad Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_10b.png differ diff --git a/.github/images/CONTRIBUTING_translations_10c.png b/.github/images/CONTRIBUTING_translations_10c.png new file mode 100644 index 0000000..9e236dc Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_10c.png differ diff --git a/.github/images/CONTRIBUTING_translations_10d.png b/.github/images/CONTRIBUTING_translations_10d.png new file mode 100644 index 0000000..bfd7613 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_10d.png differ diff --git a/.github/images/CONTRIBUTING_translations_11.png b/.github/images/CONTRIBUTING_translations_11.png new file mode 100644 index 0000000..53207ed Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_11.png differ diff --git a/.github/images/CONTRIBUTING_translations_1b.png b/.github/images/CONTRIBUTING_translations_1b.png new file mode 100644 index 0000000..a257832 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_1b.png differ diff --git a/.github/images/CONTRIBUTING_translations_4.png b/.github/images/CONTRIBUTING_translations_4.png new file mode 100644 index 0000000..dcab358 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_4.png differ diff --git a/.github/images/CONTRIBUTING_translations_6.png b/.github/images/CONTRIBUTING_translations_6.png new file mode 100644 index 0000000..e073e65 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_6.png differ diff --git a/.github/images/CONTRIBUTING_translations_7.png b/.github/images/CONTRIBUTING_translations_7.png new file mode 100644 index 0000000..39cf03c Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_7.png differ diff --git a/.github/images/CONTRIBUTING_translations_8.png b/.github/images/CONTRIBUTING_translations_8.png new file mode 100644 index 0000000..6f72ea0 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_8.png differ diff --git a/.github/images/CONTRIBUTING_translations_8b.png b/.github/images/CONTRIBUTING_translations_8b.png new file mode 100644 index 0000000..103a325 Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_8b.png differ diff --git a/.github/images/CONTRIBUTING_translations_9.png b/.github/images/CONTRIBUTING_translations_9.png new file mode 100644 index 0000000..3390f1e Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_9.png differ diff --git a/.github/images/CONTRIBUTING_translations_9b.png b/.github/images/CONTRIBUTING_translations_9b.png new file mode 100644 index 0000000..46b1f9e Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_9b.png differ diff --git a/.github/images/CONTRIBUTING_translations_9c.png b/.github/images/CONTRIBUTING_translations_9c.png new file mode 100644 index 0000000..134906a Binary files /dev/null and b/.github/images/CONTRIBUTING_translations_9c.png differ diff --git a/CONTRIBUTING_translations.md b/CONTRIBUTING_translations.md new file mode 100644 index 0000000..22aa642 --- /dev/null +++ b/CONTRIBUTING_translations.md @@ -0,0 +1,58 @@ +# Contributing Translations + +This document details the intended workflow for translations of various text. The instructions assume you have access to contribute to the repository. It is still possible to submit pull requests without the ability to directly write to the repository, but it won't be possible to run the actions on the branch itself. + +Content to be translated is broken up into several different categories: +* Text centralized within spreadsheets (XLSX files) +* Text inlined within the game's scripts +* Graphics in the form of tilesets that may have an associated tilemap + +## Spreadsheets + +While it's entirely possible to manage the spreadsheet file locally on your machine with Git, the following steps rely on automation and scripts such that everything can be handled by downloading and uploading the spreadsheet file without needing to do any local setup beyond modifying the spreadsheet itself. + +The steps below outline what is necessary to create an entirely new set of changes from scratch, but if iterating on previous work, just skip to step 8. + +1. Obtain the latest XLSX file. For example for gamescene_npc, it can be found in [game/text/](game/text/gamescene_npc.xlsx) +![.github/images/CONTRIBUTING_translations_1.png](.github/images/CONTRIBUTING_translations_1.png) +-- +![.github/images/CONTRIBUTING_translations_1b.png](.github/images/CONTRIBUTING_translations_1b.png) +2. Make changes locally to the XLSX as necessary, make sure to read [this README](game/text/README.md) file and avoid making changes to read-only columns. +3. In the GitHub web interface, navigate to the folder with the spreadsheet (similar to step 1). +4. In the top-right, click the 'Add File' drop down and select **Upload files**. Make sure the branch on the left side is the translation branch and that the file name of your xlsx file matches the one in the folder. +![.github/images/CONTRIBUTING_translations_4.png](.github/images/CONTRIBUTING_translations_4.png) +5. Drag or manually select the xlsx file, make sure the name is not changed (avoid any numeric suffixes that might've been added). +6. Under the **Commit Changes** section, feel free to add a description of the changes to make it more descriptive. Make sure the **Create a new branch for this commit and start a pull request.** radio button is selected. The branch name can remain unchanged, or can be given some descriptive name. +![.github/images/CONTRIBUTING_translations_6.png](.github/images/CONTRIBUTING_translations_6.png) +7. Selecting **Propose Changes** will bring you to the **Open a pull request** page. Nothing should need to be changed, but feel free to update the description or title if desired. When ready, press the **Create pull request** button. +![.github/images/CONTRIBUTING_translations_7.png](.github/images/CONTRIBUTING_translations_7.png) +8. You should be taken to the Pull Request automatically, but if not (or you need to navigate back to it), it will be under the [Pull Requests](https://github.com/VariantXYZ/sakura-wars-gb2/pulls) tab at the top. +![.github/images/CONTRIBUTING_translations_8.png](.github/images/CONTRIBUTING_translations_8.png) +-- +![.github/images/CONTRIBUTING_translations_8b.png](.github/images/CONTRIBUTING_translations_8b.png) +9. The changes to xlsx files will automatically trigger a job to update the CSVs from the spreadsheets. It's possible to see the file changes. +![.github/images/CONTRIBUTING_translations_9.png](.github/images/CONTRIBUTING_translations_9.png) +-- +![.github/images/CONTRIBUTING_translations_9b.png](.github/images/CONTRIBUTING_translations_9b.png) +-- +![.github/images/CONTRIBUTING_translations_9c.png](.github/images/CONTRIBUTING_translations_9c.png) +10. At this stage, a branch for all the changes and pull request has been created and so it's only necessary to upload new spreadsheets to iterate changes (up until the pull request is finally merged into the translation branch). To do so, simply follow steps 4 through 6 except target your new branch and don't create a new request. Reference the images below. +![.github/images/CONTRIBUTING_translations_10.png](.github/images/CONTRIBUTING_translations_10.png) +-- +![.github/images/CONTRIBUTING_translations_10b.png](.github/images/CONTRIBUTING_translations_10b.png) +-- +![.github/images/CONTRIBUTING_translations_10c.png](.github/images/CONTRIBUTING_translations_10c.png) +-- +![.github/images/CONTRIBUTING_translations_10c.png](.github/images/CONTRIBUTING_translations_10d.png) +11. After all iteration and review is done, the pull request can be merged (if you see `build Expected — Waiting for status to be reported`, close and re-open the pull request with the button at the bottom. +-- +![.github/images/CONTRIBUTING_translations_11.png](.github/images/CONTRIBUTING_translations_11.png) + + +## Script Text + +(TBD) + +## Graphics + +(TBD) \ No newline at end of file