Skip to content

Commit

Permalink
docs: add nakama and evm docker image version on world.toml explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
zulkhair committed Nov 19, 2024
1 parent c43e0ca commit 28c657b
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/cardinal/game/configuration/evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ DA_NAMESPACE_ID = "defaultnamespace"
FAUCET_ADDRESS = "faucet_address"
FAUCET_AMOUNT = "0x56BC75E2D6310000" # 100 ETH
FAUCET_ENABLED = false
EVM_IMAGE=ghcr.io/argus-labs/world-engine-evm:latest
EVM_IMAGE_PLATFORM=linux/amd64
```

### CHAIN_ID
Expand Down Expand Up @@ -87,4 +89,23 @@ Enables or disables the faucet feature, which automatically distributes tokens t
**Example**
```
FAUCET_ENABLED = false
```

### EVM_IMAGE

Set evm to a specific version. this value is used by world-cli

**Example**
```
EVM_IMAGE = ghcr.io/argus-labs/world-engine-evm:latest
```

### EVM_IMAGE_PLATFORM

Set evm docker image platform, default value will follow the os platform. this value is used by world-cli.
For more details, you can visit this <a href='https://docs.docker.com/build/building/multi-platform/' target='_blank'>link</a>

**Example**
```
EVM_IMAGE_PLATFORM = linux/arm64
```
21 changes: 21 additions & 0 deletions docs/cardinal/game/configuration/nakama.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ NAKAMA_TRACE_ENABLED = true
NAKAMA_METRICS_ENABLED = true
NAKAMA_TRACE_SAMPLE_RATE = 0.6
NAKAMA_METRICS_INTERVAL = 30
NAKAMA_IMAGE = ghcr.io/argus-labs/world-engine-nakama:latest
NAKAMA_IMAGE_PLATFORM = linux/amd64
```

### ENABLE_ALLOWLIST
Expand Down Expand Up @@ -65,4 +67,23 @@ Prometheus scraping interval in seconds.
**Example**
```
NAKAMA_METRICS_INTERVAL = 30
```

### NAKAMA_IMAGE

Set nakama to a specific version. this value is used by world-cli

**Example**
```
NAKAMA_IMAGE = ghcr.io/argus-labs/world-engine-nakama:1.29
```

### NAKAMA_IMAGE_PLATFORM

Set nakama docker image platform, default value will follow the os platform. this value is used by world-cli.
For more details, you can visit this <a href='https://docs.docker.com/build/building/multi-platform/' target='_blank'>link</a>

**Example**
```
NAKAMA_IMAGE_PLATFORM = linux/arm64
```

0 comments on commit 28c657b

Please sign in to comment.