Config

The first thing to know about Dojo configuration is that, it's a profile based system. Any command you may use to build, migrate or inspect your project, you need to specify the profile you want to use.

By default, the profile is always dev if not specified.

When you work with Dojo, you have two main configuration files:

First, the Scarb.toml manifest. This file is used to reference all Cairo dependencies.
Second, the dojo_<PROFILE>.toml, where <PROFILE> can be dev or any other string (no spaces or special characters).

Adding a custom profile

To add a new profile, you must:

Add a [profile.<PROFILE>] section in your Scarb.toml file.

# Scarb.toml
# ... other configs ...
[profile.my_profile]

Add the dojo_<PROFILE>.toml file in the root of your project (alonside the Scarb.toml file).

`Scarb.toml`

To work with Dojo, the minimum you need to add to your Scarb.toml is:

[package]
cairo-version = "=2.8.4"
name = "<PROJECT_NAME>"
version = "0.1.0"
edition = "2024_07"
 
[[target.starknet-contract]]
sierra = true
# It's important to keep this, since it's used by Sozo to check the world version.
build-external-contracts = ["dojo::world::world_contract::world"]
 
[dependencies]
# Adding the dojo core crate with the world and dojo traits.
dojo = { git = "https://github.com/dojoengine/dojo.git", tag = "v1.0.0-rc.0" }
starknet = "2.8.4"
 
[dev-dependencies]
# This package is required to run tests and add dojo utilities to your project in test only.
dojo_cairo_test = { git = "https://github.com/dojoengine/dojo.git", tag = "v1.0.0-rc.0" }
 
[features]
default = []

You can refer to the profile in Scarb documentation for more information.

`dojo_<PROFILE>.toml`

The dojo profile configuration file is where you can add your development parameters and world's metadata.

[world]
name = "Dojo starter"
description = "The official Dojo Starter guide, the quickest and most streamlined way to get your Dojo Autonomous World up and running. This guide will assist you with the initial setup, from cloning the repository to deploying your world."
cover_uri = "file://assets/cover.png"
icon_uri = "file://assets/icon.png"
website = "https://github.com/dojoengine/dojo-starter"
seed = "dojo_starter"
 
[world.socials]
x = "https://x.com/ohayo_dojo"
discord = "https://discord.gg/FB2wR6uF"
github = "https://github.com/dojoengine/dojo-starter"
telegram = "https://t.me/dojoengine"
 
[world]
description = "Simple world."
name = "simple"
seed = "simple"
 
[env]
rpc_url = "http://localhost:5050/"
# Default account for katana with seed = 0
account_address = "0x127fd5f1fe78a71f8bcd1fec63e3fe2f0486b6ecd5c86a0466c3a21fa5cfcec"
private_key = "0xc5b2fcab997346f3ea1c00b002ecf6f382c5f9c9659a3894eb783c5320f912"
#world_address = "0x077c0dc7c1aba7f8842aff393ce6aa71fa675b4ced1bc927f7fc971b6acd92fc"
 
[namespace]
default = "ns"
mappings = { "ns" = ["c1", "M"], "ns2" = ["c1", "M"] }
 
[init_call_args]
"ns-c1" = ["0xfffe"]
"ns2-c1" = ["0xfffe"]
 
[writers]
"ns" = ["ns-c1", "ns-c2"]
"ns-M" = ["ns-c2",  "ns-c1", "ns2-c1"]
 
[owners]
"ns" = ["ns-c1"]
 
[migration]
order_inits = ["ns-c2", "ns-c1"]
skip_contracts = ["ns-c3"]

`[env]`

The environment variables for your development, the supported keys are:

rpc_url: The RPC url of the network you want to connect to.
account_address: The address of the account used to migrate the world.
private_key: The private key of the account used to migrate the world.
keystore_path: The path to the keystore file containing encrypted account's private key.

`[namespace]`

The namespace configuration, the supported keys are:

default: The default namespace. It's always required. The default namespace is the one used to map every contract/model/event that is not explicitly mapped to another namespace using mappings.
mappings: Explicit mappings of namespaces for contracts/models/events. Let's take an example:
```
[namespace]
default = "ns"
mappings = { "ns" = ["c1", "M"], "ns2" = ["c1", "M"] }
```
In this example, the ns namespace will be used for contracts/models/events that are not explicitly mapped to another namespace. The ns2 namespace will be used for contract c1 and model M. Namespace ns2 will be used for contract c1 and model M.

In this example, since c1 and M are mapped to ns2, they are not automatically mapped to ns. This is the reason why they are also mapped to ns explicitly. The contracts c2 and c3 for instance, if not mentioned in the mappings section, will be mapped to the ns namespace by default.

`[init_call_args]`

The initialization call arguments for the contracts. By default, a dojo::contract doesn't have any initialization arguments. But using dojo_init function, you can decide otherwise and make some initialization during this dojo_init call.

#[dojo::contract]
mod my_contract {
    // The only requirement is that the function is named `dojo_init`.
    fn dojo_init(ref self: ContractState, arg1: felt252, arg2: u32) {
        // ...
    }
}

To initialize this contract, you need to add the following to your dojo_<PROFILE>.toml file:

[init_call_args]
"ns-my_contract" = ["0xfffe", "0x1"]

Remember that a resource is always namespaced. So you need to specify the tag (which is <NAMESPACE>-<CONTRACT_NAME>) in the init_call_args section to identify it.

`[writers]`/`[owners]`

The writers/owners configuration allows you to specify permissions directly from the configuration file for the given profile. The syntax for the writers/owners is the following:

[writers]
"<TARGET_TAG>" = ["<GRANTEE_TAG>"]

If we get back to my_contract mentioned just above, we can give to it the writer permission for the ns namespace like this:

[writers]
"ns" = ["ns-my_contract"]

As a note, we may change this in the future, and instead having the contract tag first, and then the target resources.

`[migration]`

The migration configuration allows you to alter the behavior of the sozo migration command.

The supported keys are:

order_inits: The order used to initialize the contracts. Identifies the contract by their tag.
skip_contracts: The resources to skip during the migration. You can still build those resources, but they will be skipped during the migration (not deployed onchain).
disable_multicall: By default sozo multicalls everything that could be multicalled. You can disable this behavior using this flag, to debug resources registration, contracts initialization, etc.

`[world]`

The metadata related to your world. They are purely informative.

Adding a custom profile

Scarb.toml

dojo_<PROFILE>.toml

[env]

[namespace]

[init_call_args]

[writers]/[owners]

[migration]

[world]