Skip to main content

easel.toml

The easel.toml file contains the configuration for your Easel project. It is used to specify the name of your project, who made it, which edition of Easel it uses, and other metadata.

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

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

[engine]
edition = 11

Project​

The [project] section contains metadata about your project.

  • name is the name of your project.
  • domain is the domain where your project is hosted. You should not normally need to change this manually.

Authors​

The [authors] section contains a list of authors who contributed to the project. Each entry is the author's user ID, followed by their username. Your user ID will automatically be added to the list whenever you create a new project or remix another one. If you remix another project so substantially that the original project is no longer recognizable, consider removing the original author's user ID from the list.

Remix​

The [remixOf] section contains a list of Game IDs that your project is a remix of. When you remix an existing project, the Game ID of the original project will be added to this list automatically. If you remix another project so substantially that the original project is no longer recognizable, consider removing the original Game ID from the list.

Note that you are only allowed to reuse assets for free from games that are listed in your [remixOf] section. See the Published Assets section to learn more.

Engine​

The [engine] section defines which edition of Easel your project uses. Newer editions of Easel may contain breaking changes that require you to update your code. When you create a new project, the edition is automatically initialized with the latest edition at the time the project was created. You can change the edition number to upgrade to a newer edition of Easel, but you might need to update your code according to the upgrade instructions for the new edition. See the Upgrading page to learn more.