The Framework
The Framework is for all of you, that want to create their own translation.
By downloading the framework, you will have six folders (mod-mods), that will contain the translation files for the original modules. Each module will have the correct dependency to the original module and I made sure to keep the load order correctly.
EDIT: At first I decided to release the Framework in a state in which it already contains my parts of the German translation. My plan was to add your translations later.
To be honest, I think that it was too complicated to tell you something about modinfo-files and load-orders and how to add your language to the existing files.
Content of the Framework
The Framework is the foundation of being able to translate the game and more importantly, have a consistent file structure to share the work of the translator with the community.
This will avoid single file translations that are unclearly, difficult to handle for the update process, etc..
By looking at the modinfo file of "(1a) Community Patch INT" for instance, you can see that it only contains a few files. Moreover you will notice, that most files seems to be in a xx_XX folder. the xx_XX is a placeholder for the language-tag that is going to be added by you.
You might will know these here: en_US, fr_FR, ru_RU? In the final Language Pack, we will have all files that contain text in different folders, matching their language tag:
For each mod-mod I made sure that I replicated the file structure and the load order of the original module. Furthermore I deleted all unnecessary code in those xml and sql files, that are already processed by the original module. I don't want to merge all sql and xml files in one file per mod-mod, because for the updating progress it is a lot easier to keep track of the changes and to find the correct file.
How to add a new language?
This is the most exciting part. So if you want to add the file structure for e.g. Russia, you have to follow the procedure to add the language to the framework. After the process, you will be able to see the content of Vox Populi in the game if you play it in your native language. This means that if you play in Russia, you will have all parts of Vox Populi shown up currently in English until you decide to translate it to Russia.
- Prepare the file structure:
- Please make sure, that you installed Vox Populi matching the version of the Framework.
- After downloading and extracting the Framework, leave it in your Download folder as a working folder. This is how the Framework will look like: View attachment 463593
- Do you see the Hit and Go.bat? It will execute the Java file "renameFolders.jar".
Thanks to merill. Make sure that you installed Java, before you execute the Hit and Go.bat
- Please enter the new language tag (ex: de_DE, or ru_RU):
By executing the bat, you will be asked to enter a language string. So at first you have to know, what language string represents your native language. German e.g. de_DE or Russia ru_RU
- In this example I want to translate Vox Populi to Russia, so I enter ru_RU into the window and hit Enter. It will inform you of the quantity of folders and files that have been renamed. That was the first part, you prepared the Framework for your language.
- Prepare the actual files of the Framework:
The last, but most important step is the following one.
So you prepared all framework modules. If you would start the Game now, nothing would be different than before. There is one last step to do.
- Open Notepad++ and press Ctr+SHIFT+F or navigate to Search -> Find in Files
- Find what: language_xx_XX - yes those x'es are correct
- Replace with: language_your_STRING - e.g. language_ru_RU
- Filters: *.*
- Directory: PATH to the WORKING DIRECTORY - e.g. E:\Downloads\Vox Populi Translation Framework
- Hit Replace in Files afterwards.
- You have prepared all xml and sql files and in addition prepared the file structure.
- You can copy all six folders now to the Mods folder of Civilization V. You should know that you don't have to use More Luxuries and so you don't need to use the Framework module.
Double check if your Cache folder is deleted and run the Game afterwards
in your native language.
By activating Vox Populi and the Framework in the Mods menu, you should now see English texts for content of Vox Populi like Buildings, Policies, etc.
Please pay attention to the order of activating those mods: (1) Community Patch, then (1a) Community Patch INT, then (2) Community Balance Overhaul, (2a) Community Balance Overhaul INT, etc.
How to update the Framework?
I use the program "Beyond Compare 4", but I guess there is also a free program like this.It allows the display of differences of two folders. By copying the original Vox Populi folders to a working directory like the Desktop. Installing the new version of Vox Populi afterwards, you can find out what has been changed.
Now I can navigate to my translation files of the framework and alter my translation.
I recently switched to GitHub and this will make it easier for you to change your translation by looking at the changes (commits) of the Framework.
Changelog
Recent changes to 2.1.26.1
- Added latest changes of 2.1.26.1 to the Framework