HOW-TO: Use ID spaces for localization modding

If you want to collaborate with others on localization modding, learning how to use ID spaces in the strings database is a must.

Every piece of text in the game is recorded and given it’s own identification number called string_id. To make sure these string ids won’t collide once you import files exported by other modders working on the project, you need to use different id spaces. They will help you avoid significant compatibility issues with other mods.

Below you can find out how does the strings database handles storing additional strings, especially when more people are involved with your work.


Using ID spaces

You can use your own range (called id space) of string ids for your mod project.

Go to View > Settings > Mod Project Settings where you can specify the start of the id space (Project ID space) that the project will use throughout its lifetime. This id space will be reserved only for strings added by the mod project.

The possible range you can use is the following:

  • Ids can start from at least 10M to the maximum of 0x7FFFFFFF - 1000
    (where the “- 1000” is for choosing the highest possible starting id, so that you still have a decent amount of space left)

id spaces_settings.png

Here’s an example of how this could work for a mod where two people wish to collaborate:

  1. Choose the 15000000 as the start of the id space for your mod.

  2. Let's assume you will need space for 10000 keys. We will divide into two parts.

  3. You can agree to use the 15000000-15005000 ID space.

  4. The other modder can then use the ID space which starts at 15005001.

  5. This way you can avoid the colliding of strings and the import/export option will allow you both to sync your work.


12024-05-09_14-09.png

Import & Export strings

You can use the Localization Strings Editor’s file menu to import and export strings with the same format.

The Export option will export every modification from your local string DB to a .csv file. The file can then be imported by someone else to collaborate on the project and synchronize your database. You can Import someone else’s file in the same way.

If you want to work on translating strings in tools such as Microsoft Excel, it’s also possible after you export the .csv file - however as for adding new strings, it is recommended to use the Localized Strings Editor for that.

The exported CSV can be found next to the database file in your project folder. Its name is LocalEditorStringDataBaseW3_UTF8_mod_export.csv.

 

Table of contents:

Find out more about:

______________________________________
The Witcher 3: Wild Hunt Complete Edition © 2024 CD PROJEKT S.A. Published by CD PROJEKT S.A. Developed by CD PROJEKT RED. CD PROJEKT®, The Witcher®, REDengine® are registered trademarks of CD PROJEKT Capital Group. All rights reserved. The Witcher game is set in the universe created by Andrzej Sapkowski in his series of books. All rights reserved.