> For the complete documentation index, see [llms.txt](https://novastudio-1.gitbook.io/novastudio-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://novastudio-1.gitbook.io/novastudio-docs/documentation/ncode/how-to-get-started.md).

# How to get started

Information for the NCode plugin to work correctly on your server.

### Requirements

* **Server Software**\
  Spigot, Paper, or Folia (Paper or Folia are highly recommended for maximum performance).\
  The minimum supported Minecraft version is 1.21.
* **Database (Optional)** \
  The plugin offers two storage methods that you can configure in the `config.yml` file:
  * YAML: This is the default system and is perfect for a single server. It requires no additional configuration.
  * MySQL: If you want to use NCode on a server network (connected with BungeeCord/Velocity) or if you prefer a more centralized and robust data system, you can configure a connection to a MySQL database.

#### Additional Dependencies

* PlaceholderAPI (Optional) If you wish to use NCode placeholders (like `%ncode_my_code%` or `%ncode_invite_players%`) in other plugins such as scoreboards or tab lists, you will need to have PlaceholderAPI installed.

### Installation

To install the plugin, simply place the `NCode.jar` file that you have compiled inside the `plugins` folder and restart or start your server.

Upon the first startup, the plugin will automatically generate its folder (`/plugins/NCode/`) and the following configuration files:

* `config.yml`: The main file where you can configure the storage type (YAML/MYSQL), playtime rewards, and the structure of the menus.
* `messages_en.yml` and `messages_es.yml`: Language files containing all the plugin's texts and messages. You can translate them into other languages or customize them to your liking.