Modtale Mods

Automatically download and sync mods from Modtale on every container startup.

Setup

Get a Modtale API Key

Log in to Modtale at https://modtale.net/dashboard/developer
Create or copy your API key
Keep it private

Configure Environment

Add to your docker-compose.yml:

environment:
  MT_API_KEY: "${MT_API_KEY}"  # From .env file
  MT_MODS: "mod-uuid,mod-uuid:1.2.3"

Create a .env file:

MT_API_KEY=your-api-key-here

Find Mod IDs

Use the Modtale mod page to get the mod UUID and optionally a version.

Restart

docker compose restart

Configuration

MT_MODS Format

MT_MODS: "modUuid,modUuid:version,modUuid"

Format	Description
`uuid`	Latest version
`uuid:version`	Specific version

Example

environment:
  MT_API_KEY: "${MT_API_KEY}"
  MT_MODS: "2f0e9b2b-7b7d-4f0b-9c12-6c9a3f7f2c1a,2c8a1e5b-4cc6-4f49-8a35-3a2f8d9c1f5a:1.2.3"

How It Works

On every startup:

Parse MT_MODS configuration
Check each mod version
Download new or updated mods
Remove mods no longer in MT_MODS
Update manifest at /server/mods/.modtale-manifest.json

CLI Commands

# List installed mods
docker exec -it hytale-server hytale mods list

Complete Example

services:
  hytale:
    image: rxmarin/hytale-docker:latest
    container_name: hytale-server
    restart: unless-stopped
    stdin_open: true
    tty: true
    ports:
      - "5520:5520/udp"
    environment:
      JAVA_OPTS: "-Xms4G -Xmx8G"
      AUTO_UPDATE: "true"
      MT_API_KEY: "${MT_API_KEY}"
      MT_MODS: "2f0e9b2b-7b7d-4f0b-9c12-6c9a3f7f2c1a"
    volumes:
      - hytale-data:/server

volumes:
  hytale-data:

Always use a .env file for your API key instead of committing it to version control.

Troubleshooting

Issue	Solution
"MT_API_KEY not set"	Add `MT_API_KEY` to environment or `.env` file
"Mod not found"	Verify the mod UUID and version are correct
"Download failed"	Check API key permissions and mod availability

Next Steps

Configuration — All environment variables
CurseForge Mods — CurseForge setup

Modtale Mods

On this page