Skip to content
Matcha! Mods

Installation

Installation

Section titled “Installation”

This guide covers installing Courier on your Cobblemon server.

Requirements

Section titled “Requirements”

Required

  • Minecraft 1.21.1
  • Fabric Loader 0.17+
  • Fabric API
  • Fabric Language Kotlin
  • Cobblemon 1.7+
  • Ceremony 3.3+

Optional (Multi-Server)

  • MongoDB (recommended for storage)
  • Redis OR NATS (for cross-server)

Installation Steps

Section titled “Installation Steps”

  1. Download Dependencies

    Ensure you have all required mods installed:

  2. Download Courier

    Download the latest Courier jar from the releases page and place it in your mods folder.

  3. Start the Server

    Start your server once to generate configuration files:

    config/courier/config.conf
    config/courier/messages.json
    config/courier/presets/

  4. Configure Database (Optional)

    For multi-server setups, configure MongoDB in config/ceremony/config.conf:

    storageType = "MONGO_DB"
    storageUrl = "mongodb://localhost:27017"

  5. Configure Message Bus (Optional)

    For cross-server mail delivery, configure Redis or NATS:

    messageBus {
        type = "REDIS"
        redisAddress = "redis://localhost:6379"
    }

  6. Restart Server

    Restart your server to apply configuration changes.

Single Server Setup

Section titled “Single Server Setup”

For single-server deployments, Courier works out of the box with default settings:

  • Storage: MongoDB (local) or JSON files
  • No message bus required
  • All features available

Multi-Server Setup

Section titled “Multi-Server Setup”

For server networks (BungeeCord/Velocity), you need:

Shared Database

Section titled “Shared Database”

All servers must connect to the same MongoDB instance:

config/ceremony/config.conf
storageType = "MONGO_DB"
storageUrl = "mongodb://your-mongodb-host:27017"
storageUser = ""
storagePassword = ""

Message Bus

Section titled “Message Bus”

Enable real-time mail notifications across servers:

Redis 

messageBus {
    type = "REDIS"
    serverId = "survival-1"
    redisAddress = "redis://localhost:6379"
    redisPassword = ""
}

NATS 

messageBus {
    type = "NATS"
    serverId = "survival-1"
    natsAddress = "nats://localhost:4222"
}

Verifying Installation

Section titled “Verifying Installation”

After starting your server, check for these log messages:

[courier] Loading main config from: config/courier/config.conf
[courier] Main configuration loaded successfully
[courier] Loaded 6 package presets
[courier] Registered NATS packet handlers for cross-server mail

Test the installation:

  1. Join your server
  2. Run /mail to open your mailbox
  3. Run /mailadmin listpresets to see default presets

Troubleshooting

Section titled “Troubleshooting”

Config not loading

Section titled “Config not loading”

If you see config errors:

  1. Delete config/courier/config.conf
  2. Restart the server to regenerate
  3. Check for HOCON syntax errors

Database connection failed

Section titled “Database connection failed”
Failed to connect to MongoDB
  • Verify MongoDB is running
  • Check connection URL
  • Ensure network access is allowed

Cross-server mail not working

Section titled “Cross-server mail not working”
  • Verify both servers have same database
  • Check message bus configuration
  • Ensure unique server IDs
  • Check Redis/NATS is accessible

Next Steps

Section titled “Next Steps”