CONTRIBUTING.md

Contributing Guide

EscapeWild.Flutter is a Flutter project and works on all platforms, including Android, Windows, Linux, macOS and iOS.

• Want to build EscapeWild.Flutter? Please see the building guide.
• Want to work on Localization? Please see localization.

How to build

There's a few resources to get you started if you are not familiar with Flutter.

• Lab: Write your first Flutter app
• Cookbook: Useful Flutter samples
• Online documentation

Localization

EscapeWild.Flutter uses easy_localization package, and it will retrieve localization files in assets.

The localization is formatted in yaml, which has a good-looking syntax.

The localizations of UI and game content are separate:

• The localization of UI folder: l10n.
• The localization of game content folder: l10n.
• The default UI localization file: en.yaml.
• The default game content localization file: en.yaml.

Your language is not here?

If your language is not listed in localization folder, please follow this step-by-step guide to create it.

1. Copy the en.yaml in the localization folder, and paste it in the same folder with a different name, for example, if the target language is French, you should rename it to fr.yaml.

2. Now do the localization! Just translate all English words to your language.

3. Please keep it in the same order with en.yaml.

4. Finally, add locale into R.supporrtedLocales in R class.

   static const supportedLocales = [
    defaultLocale,
    const Locale("fr"), // add this
   ];

Contribute to an existed localization

If your language is under l10n folder, but it lacks further localization, or you want to improve it, please follow this step-by-step guide.

1. Find it under localization folder, UI or game content.
2. Now do the localization! For missing words, you can just copy from en.yaml, the default localization.
3. Please keep it in the same order with en.yaml.