Unofficial Vortex Translation Tool

Unofficial Vortex Translation Tool

===================================

Version: 1. 0. 12 (Compatible with Vortex v1. 2. 15 to v1. 2. 20)

Author: BowmoreLover

Distribution page: https://www.nexusmods.com/site/mods/33

Last updated: Jun 09, 2020 (UTC)

Updater for Vortex 1. 3. 5 (Sep 10, 2020 (UTC)):

Now available an updater for Vortex 1. 3. 5 to 1. 3. 8 on update files section. Just overwrite the updater after installing VortexTrnsTool 1. 0. 12.

===================================================================================================================

1. Introduction

2. Motivation and purpose

3. Requirements

5. Uninstall

6. Step-by-step tutorial

Step 1. Extact translation text from Vortex sorce code

Step 2. Merge Json files

Step 3. Convert Json to Mcm

Step 4. Translate Mcm

Step 5. Convert Mcm to Json

Step 6. Deployment / Distribute the translated Json files

7. Notes / Limitation / Known issues

8. Credits & Special thanks

===================================================================================================================

===============================

1. Introduction

===============================

This is a tool to help Vortex translators.

- You can extract translation text from Vortex source code as a translation source.

- You can convert Json to/from Mcm() file, so translate it easily using such as xTranslator instead of directly editing Json.

- You can use almost complete English Json files as a translation source.

() The file format used in the Mods menu of Skyrim/Skyrim SE (also used in Skyrim/FO vanilla game UI).

About Vortex translation, see Tannin's forum post: Translating Vortex

===============================

2. Motivation and purpose

===============================

The current Vortex translation work has the following problem:

- Vortex can translate UI using Json file, but only a small amount of English text to translate is provided. So need to collect English text while manipulating the screen with translation helper extension. Not only is it difficult to cover all of the translated text, it is also need to collect every version update.

- It is troublesome to directly edit the Json file, and it is necessary to write it so as not to break Json's syntax, so everyone can not easily translate it.

I am willing to translate Vortex into my native language and contribute to the project, but I don't want to do troublesome and unnecessary work. So I decided to make this.

===============================

3. Requirements

===============================

- Windows 7 or later (Tested on Windows 10)

- Microsoft . NET Framework 4. 6. 1 or later

- Vortex 0. 16. 10 or later

(Recommended) TES/FO Translation Tool

- xTranslater by McGuffin

Other tools may be able to translate, but I only tested this.

(Optional) For extracting English Json file from Vortex source code:

- Vortex source code (GitHub)

- Any git client. I'm using as below:

git for windows

TortoiseGit

(Optional) For collecting missing translated text of this tool:

- Translation Helper 0. 0. 5 or later

===============================

===============================

Download archive file and extract to any folder.

Must be sure not install to Windows/Program Files/Games/Vortex installation folder.

Notes on updating:

When overwriting the Workspace folder, be careful not to lose your modified files. If you do not do extraction from source code or merge jsons but just translate using merged json or Mcm text, you can overwrite it. However, if not, simply overwriting may cause your modifications to be lost.

===============================

5. UnInstall

===============================

- Delete the installed files and folders.

- Delete "%LOCALAPPDATA%\VortexTrnsTool" folder (Configurati