Skip to main content

🌐 Create a Custom Locale

This guide explains how to add your own language translation (locale) for use in Dream scripts.

Please use official language codes as file names (e.g., de for German, fr for French).

info

💬 Feel free to share your translation with the community — help others benefit!

🛠️ Step-by-Step Guide​

1. 📁 Copy an Existing Locale​

Navigate to the /settings/locales folder.
Copy an existing file (e.g., en.lua) and rename it using your language code.
Example:

  • de.lua → German
  • fr.lua → French

2. 📝 Update the Locale Identifier​

Open your new file and update the DreamLocales identifier at the top to match your language code:

DreamLocales['en'] = {
    -- Your translated keys
}

3. 🌍 Translate the Values​

Translate all values into your target language.

⚠️ Do not change the keys — only edit the text on the right side of each line:

["open_menu"] = "Menü öffnen", -- ✅ OK
["öffne_menü"] = "Open Menu",   -- ❌ Don't translate keys!

4. ✅ Activate Your Locale​

To use your new locale, open the DreamCore config file and set:

DreamCore.Language = 'de'

Replace 'de' with your language code.

🧠 Tips​

  • Test your translations in-game after saving.
  • Ensure all keys are translated to avoid missing text.
  • Never ever change the key names — only the values.
  • Keep formatting and special characters intact (e.g., ~INPUT_CONTEXT~, ~r~, %s etc.)
  • Share your translation with others in the community!

Happy translating! 🌍