Skip to main content

Configuration (easel.toml)

The easel.toml file contains the settings and metadata for your Easel game project. It is written in the TOML format, which is a simple and easy-to-read format for configuration files.

[project]
name = "Acolyte Fight!"
domain = "acolyte.easel.games"

[authors]
"u1z.DHAVSGw" = "raysplaceinspace"

[engine]
edition = 15

[graphics]
resolution = "max"
minResolution = "low"
minAutoResolution = "high"

[players]
defaultPrefix = "Acolyte"
selfColor = "#00ccff"
colors = ["#f58c81", "#b69cf6", "#54c794", "#e09f47", "#e08747", "#e58cc5", "#a9b852", "#6eb2fd"]

Sections

The easel.toml file is divided into several sections. Each section is documented in it respective section of the documentation:

If a section is not present in your easel.toml file, it means that the default settings are being used for that section. Simply add the section to the file to customize the settings.

File location

The easel.toml file must be located in the root directory of your Easel project. It cannot be renamed, or placed in a subfolder, or it will not work. When you create a new project using the Easel editor, this file is automatically generated for you, so you should not need to create it manually.

Legacy file locations

Previously, some configuration could be stored in the following locations: graphics.toml, experimental.toml, legacy.toml, network.toml, players.toml, physics.toml. The old files will continue to be read for backwards compatibility, but ideally you should move all the settings into easel.toml and delete the old files, as easel.toml is now the new standard.