# Evie Modding Guide

## What you'll need:

* Some Godot/GDScript knowledge
* A PC
* Gamepad (if you want to test your mod with it, else just use keyboard)

## Creating Scenes

### Levels (With Pause Menu)

1. Create a scene (for example in 'levels' folder)
2. The root node of the scene needs to be named with special characters ([read this](#understanding-how-level-naming-works-in-evie)).
3. After that, add Player, a CanvasLayer, and inside of it, PauseController. Now you can start creating your level!

### Understanding how level naming works in Evie

The root node's name is split into 2 variables:\
`Chapter*1-Chapter*Name` *(levelN)* and `2-Act*Name` *(act)*.\
'\_' acts here as a separator.

The first variable *(levelN)* is split again into:\
`Chapter*1` *(levelNum)* and `Chapter*Name` *(levelName)*.\
'-' acts as a separator, '\*' acts as a space.

The second variable *(act)* is split into:\
`2` *(actNum)* and `Act*Name` *(actName)*.\
'-' acts as a separator, '\*' acts as a space.

Then it all connects again as a readable text:\
\&#xNAN;**`Chapter 1: Chapter Name`**\
 **`Act 2: Act Name`**

### Scenes (Without Pause Menu)

1. Create a scene
2. You're done. Start adding UI elements etc.

## Localizing your mod

To add support for other languages in your mod, go to Localization tab in the top bar.\
In locales tab you can add languages, in translations tab you have a clear view of all the keys and their translations.