Update Text_KinkyDungeon_RU.txt

.gitattributes

@@ -0,0 +1,17 @@
+*.txt		text
+*.[tj]s		text
+*.py		text
+*.yml		text
+*.yaml		text
+*.csv		text
+*.tps		text
+*.md		text
+*.json		text
+*.css		text
+
+*.png		-text
+*.webp		-text
+*.ttf		-text
+*.ogg		-text
+*.aesprite	-text
+*.zip		-text

.github/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+
+# How to contribute
+
+### Translation work
+
+Thank you for your interest in contributing to the translation work! If you want to translate this project, please follow the steps below:
+
+For some nouns, you can refer to the [Noun Explanation](#Noun-Explanation) section.
+
+> For users who are not familiar with Git, to quickly translate.
+
+#### Get started
+
+1. First. You need to enter the folder where the text resources of this project's `newartwork` branch are located. You can [click here to enter](/Screens/MiniGame/KinkyDungeon/)
+
+2. Find the corresponding language file you want to translate in the directory and click to enter.
+
+> The naming format of the language resource file is `Text_KinkyDungeon_<language abbreviation>.txt`
+> Such as `Text_KinkyDungeon_EN.txt` is the English translation file (of course, this does not exist)
+
+3. Click the edit button in the upper right corner of the editing box. You may be prompted to Fork the project, follow the prompts to operate.
+
+> If you are not the first time to participate in the translation and have Forked the project, you can directly edit in your Fork project. Note: Before editing, please switch to the `newartwork` branch and **synchronize**.
+
+![img](https://docs.github.com/assets/cb-47646/mw-1440/images/help/repository/edit-file-edit-button.webp)
+
+4. Use `Ctrl + F` or other search functions to find the text you want to translate. You can start the translation work.
+
+
+##### Writing rules
+
+One line of original text, then the next line is the translated text。
+
+*(Ensure original text on odd lines, translation on even lines)*
+
+Such as:
+`````
+Original text 1
+Translated text 1
+Original text 2
+Translated text 2
+`````
+
+##### Untranslated content
+
+If you do not have specific text to translate, you can find the original text that starts with `###`, which is the format of the text that starts with `### Original text` and has not been translated.
+
+The method is: remove the `### ` in it (note, do not delete the original text), and then write the translated text on the next line.
+
+> You don't need to worry about the position and the spaces at the beginning and end. You only need to keep the original text and the translated text in the correct order.
+
+##### Other
+
+- If you have accumulated some translation content and don't want to find and modify them one by one, you can write *original text-translation* according to the rules at any place, and the first pair of translation pairs that meet the requirements will be retained after submission. (It is best to write at the beginning, because the first submission will cover the later ones)
+
+- **If you think that submitting and editing is too cumbersome, you can create an `issue`, write the accumulated translation content in it, and indicate the language file.** [Reference document](https://docs.github.com/en/issues/tracking-your-work-with-issues/quickstart)
+
+> Note: When pasting translation content, please wrap it in **a pair** of ` ``` ` (backticks) .
+
+Such as:
+`````
+Text_KinkyDungeon_EN.txt
+```
+Original text 1
+Translated text 1
+Original text 2
+Translated text 2
+```
+`````
+
+#### Finish and submit
+
+After completing the translation, you can click the `Commit changes...` button in the upper right corner of the editing box, keep the default or fill in the commit information and submit.
+
+In the `base` item at the top, you should choose `newartwork` Branches.
+
+> *So far, follow the prompts all the way, the following content may be confusing, it is not recommended to continue reading if you have no questions.*
+
+After submitting, you will enter the `Comparing changes` page. You can view your submission content on this page. After confirming that there is no error, click `Create pull request` and wait for approval.
+
+![img](https://camo.githubusercontent.com/34a2cf737ba2f5943e3e469aa231e95a0ee4d0888c10dcaa169c1f8413d43333/68747470733a2f2f6669727374636f6e747269627574696f6e732e6769746875622e696f2f6173736574732f526561646d652f7375626d69742d70756c6c2d726571756573742e706e67)
+
+If you did not enter or accidentally leave the page, you can return to the `newartwork` branch of this project. You should see a yellow prompt box at the top of the project. Click `Compare & pull request` to enter the Pull Request page. For details, please refer to the [GitHub official document](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
+
+![img](https://camo.githubusercontent.com/e10bdcf31fb3f8ce863dc1dbf9269a23bce9263afcbe9a62d892e9b6e78df1c6/68747470733a2f2f6669727374636f6e747269627574696f6e732e6769746875622e696f2f6173736574732f526561646d652f636f6d706172652d616e642d70756c6c2e706e67)
+
+#### Noun Explanation
+
+Note that these contents are mainly for users who are not familiar with Git, and are mainly for easy understanding. They may be different from the actual functions. If you are interested in learning more, please refer to the [GitHub official document](https://docs.github.com/)
+
+##### Branches
+
+> Note that this refers to `Branches` rather than `Fork`.
+
+On GitHub, the code has various versions, and branches are these different versions of the code. In this project, we mainly work in the `newartwork` branch, so you need to pay attention to switching to the `newartwork` branch.
+
+![img](https://docs.github.com/assets/cb-2058/mw-1440/images/help/branches/pr-retargeting-diagram1.webp)
+
+
+![img](https://docs.github.com/assets/cb-36152/mw-1440/images/help/repository/file-tree-view-branch-dropdown-expanded.webp)
+
+##### Pull Request
+
+Since you are not a project member, you cannot submit translation content directly. So you need to `Fork` this project, which means copying it to your account, and then editing it in your account.
+
+How do you merge the project you copied into this project? This requires a `Pull Request`, which is a request to merge your changes into this project.
+
+
+##### Synchronize
+
+After you Fork the project, this project may be updated, and you need to synchronize the updates of this project to your Fork project to avoid conflicts caused by the project being updated and your Fork project not being updated.
+
+The synchronization function is by default for the current branch, so you need to switch to the corresponding branch before synchronizing.

.github/scripts/format-translation-script.py

@@ -0,0 +1,132 @@
+# This script is used to reorder and deduplicate the translation files according to the order of the source text files. Doing so has the following effects:
+# - For merging PRs in the future, the translation content supports insertion at any position, and the script will automatically reorder and retain the first non-repeated translation content.(You can rest assured to cover the content)
+# - If the source text in the source file is modified in the future, the script will not retain the old translation content in the translation file, reducing the generation of obsolete translation content.
+# - Use `### Original` instead of untranslated original text lines to facilitate translators to find and compare untranslated content, and translators do not need to open the source file for copying, improving work efficiency.
+# - Retain the empty lines and order of the original file, so that the translation work can be browsed according to the classification of the original file.
+# - Remove duplicate content in the translation file to avoid repeated translation.
+#
+# Git-Action automation configuration:
+# This script has been configured in Git-Action. When the translation file or source text file changes, the action is automatically triggered to execute the reorder overwrite operation.
+#
+# Operation process:
+# - Read the Text_KinkyDungeon.csv file and retain empty lines and order.
+# - Read the Text_KinkyDungeon_[lang].txt file and store the content in a list.
+# - Reorder the content of the translation file according to the order of the Text_KinkyDungeon.csv file
+#     - If there is no corresponding translation, use `### Original` instead
+#     - If there is duplicate translation, it will not be written
+
+import os
+import csv
+import sys
+
+# Ignore keys
+IGNORE_KEYS = [
+    "RestartNeededEN", "RestartNeededCN", "RestartNeededKR", "RestartNeededJP", "RestartNeededES", "RestartNeededFR", "RestartNeededRU",
+    "KDVersionStr"
+]
+
+class LineCountingWriter:
+    def __init__(self, file, init_count=1):
+        self.file = file
+        self.count_lines = init_count
+
+    def write(self, content):
+        lines = content.count('\n')
+        self.count_lines += lines
+        self.file.write(content)
+
+    def line_count(self):
+        return self.count_lines
+
+# Read the csv file
+def read_csv_with_empty_lines(file_path) -> list:
+    with open(file_path, newline='', encoding='utf-8') as csvfile:
+        reader = csv.reader(csvfile)
+        lines = []
+        for row in reader:
+            # Retain empty lines
+            if not row:
+                lines.append(None)
+                continue
+
+            if len(row) != 2:
+                print(f'<ABNORMAL> {row}')
+                continue
+
+            if row[0] in IGNORE_KEYS:
+                continue
+
+            lines.append(row)
+        return lines
+
+
+# Read the translation file
+def read_translation_file(file_path) -> list:
+    with open(file_path, 'r', encoding='utf-8') as file:
+        lines = [ line.strip() for line in file.readlines() if not line.lstrip().startswith('###') ]
+    return lines
+
+
+def write_translated_file(csv_lines : list, translations : list, output_path : str):
+    translated = set()
+    with open(output_path, 'w', encoding='utf-8') as file:
+        writer = LineCountingWriter(file)
+        for line in csv_lines:
+            if not line or not line[1]:
+                writer.write('\n')
+                continue
+
+            key, original, *_ = line
+            if original in translated:
+                continue
+            translated.add(original)
+
+            if writer.line_count() % 2 == 0:
+                writer.write('\n')
+
+            # The next line of the original text corresponding to the List is the translation. If the translation is not found,will use "### Original" instead.
+            # When the translation is the same as the original text, "### Original" is also used because it is meaningless.
+            try:
+                original_index = translations.index(original.strip())
+                translation = translations[original_index + 1].strip()
+                if not translation or (original == translation) :
+                    raise ValueError
+            except (ValueError, IndexError):
+                writer.write(f'### {original}\n')
+                continue
+
+            writer.write(f'{original}\n{translation}\n')
+
+original_csv_path = 'Screens/MiniGame/KinkyDungeon/Text_KinkyDungeon.csv'
+
+# Enable the translation files to be reordered
+translation_files = [
+    'Text_KinkyDungeon_CN.txt',
+    'Text_KinkyDungeon_DE.txt',
+    'Text_KinkyDungeon_KR.txt',
+    'Text_KinkyDungeon_RU.txt',
+    'Text_KinkyDungeon_JP.txt',
+    'Text_KinkyDungeon_ES.txt',
+    ]
+translation_files = [f'Screens/MiniGame/KinkyDungeon/{file}' for file in translation_files]
+
+
+modified_files = sys.argv[1:]
+print(f'Modified Files: {modified_files}')
+
+# if originnal file is modified, then all translation files need to be reformatted
+if any(file.endswith('Text_KinkyDungeon.csv') for file in modified_files):
+    modified_files = translation_files
+
+modified_files = [file for file in modified_files if file.endswith('.txt')]
+
+csv_lines = read_csv_with_empty_lines(original_csv_path)
+
+for file in modified_files:
+    if not os.path.exists(file):
+        print(f'File not found: {file}')
+        continue
+
+    print(f'Processing : {file}')
+    translations = read_translation_file(file)
+    write_translated_file(csv_lines, translations, file)

.github/workflows/deploy.yml

@@ -0,0 +1,32 @@
+name: Deploy to GH Pages
+
+on:
+  push:
+    branches: [ "master" ]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout KinkyDungeon
+      uses: actions/checkout@v3
+    - name: Use Node.js 14.x
+      uses: actions/setup-node@v3
+      with:
+        node-version: 14.x
+    - name: Build
+      run: |
+        npm install
+        npm run build
+        printf "\n!/out/**/*" >> .gitignore
+    - name: Deploy
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        folder: .
+        clean: true
+        single-commit: true

.github/workflows/format-translation.yml

@@ -0,0 +1,37 @@
+name: Format Translation
+
+permissions:
+  contents: write
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - newartwork
+    paths:
+      - "Screens/MiniGame/KinkyDungeon/*"
+
+jobs:
+  format-translation:
+    runs-on: ubuntu-latest
+    if: github.repository == 'Ada18980/KinkiestDungeon'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.x"
+
+      - name: 🚀 Run format-translation script
+        run: python .github/scripts/format-translation-script.py Screens/MiniGame/KinkyDungeon/Text_KinkyDungeon.csv
+
+      - name: 📝 Commit changes
+        id: check_changes
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "format-translation-action"
+          git add . 
+          git diff-index --quiet HEAD || git commit -m "Format translation files"
+          git push

.gitignore

@@ -2,7 +2,7 @@
 !*/
 
 !/Assets/**/*
-!/Backgrounds/**/*.jpg
+!/Backgrounds/**/*.png
 !/Icons/**/*
 !/Fonts/**/*
 !/Game/**/*
@@ -11,15 +11,24 @@
 !/Screens/**/*
 !/Mods/example_enemy.zip
 !/Mods/example_enemy/**/*
+!/Data/**/*
+!/Models/**/*
+!/ModelsBack/**/*
+!/TextureAtlas/**/*
+!/DisplacementMaps/**/*
+!/out/saveworker.js
 
+!/.github/workflows/*.yml
 !/.editorconfig
 !/.eslintrc.json
 !/.gitignore
 !/index.html
 !/package-lock.json
 !/package.json
 !/jsconfig.json
+!/tsconfig.json
 !/README.md
 !/style.css
 
-*.wav
+*.wav
+