Skip to content

Home

Jump to bottom
Kozejin edited this page Mar 9, 2024 · 27 revisions

Welcome to the palworld-bot wiki!

Environment Variables

  • BOT_TOKEN: The token for your discord application.
  • BOT_PREFIX: The prefix that will be used for commands. Default: !
  • BOT_ACTIVITY: The text that displays in your bots activity on discord.
  • STEAM_API_KEY: Your Steam API key. Can be obtained from Steam's dev page.

Configuring your config.json

This bot supports multiple servers. You do not need to utilize all the features the bot has to offer. I will provide a basic and full feature configuration.

Basic Configuration

  • Server Name: Just the name in the configuration and embeds.
  • RCON_HOST: The IP that connects to your game server.
  • RCON_PORT: The port assigned to your server for RCON user.
  • RCON_PASS: The server admin password used to access the in-game admin.
{
    "PALWORLD_SERVERS": {
        "Server Name": {
            "RCON_HOST": "127.0.0.1",
            "RCON_PORT": 25575,
            "RCON_PASS": "rcon_password"
        }
    }
}

Advanced Configuration

Server Configuration:

  • QUERY_CHANNEL: Channel ID that will post server query information.
  • CONNECTION_CHANNEL: Channel ID that will post the server connection logs.
  • SERVER_PORT: The connection port that will display in the query embed.
  • SERVER_SLOTS: The total amount of players allowed on your server.
  • WHITELIST_ENABLED: True/False statement for enabling the whitelist.

Shutdown Configuration:

This does require a watchdog script for your server!

  • enabled: True/False statement for server shutdown schedule.
  • times: Set restart times based on the 24 hour clock.
  • timezone: Set your timezone for the 24 hour clock.

Additional Configuration:

  • STATUS_TRACKING: Toggles tracking total players online through the bots status.
  • PALGUARD_ACTIVE: Enables PalGuard commands to be ran through the discord bot.
{
    "PALWORLD_SERVERS": {
        "Server Name": {
            "RCON_HOST": "127.0.0.1",
            "RCON_PORT": 25575,
            "RCON_PASS": "rcon_password",
            "SERVER_PORT": 8211,
            "SERVER_SLOTS": 32,
            "QUERY_CHANNEL": 123456789,
            "CONNECTION_CHANNEL": 123456789,
            "WHITELIST_ENABLED": true
        }
    },
    "SHUTDOWN_SCHEDULE": {
        "enabled": false,
        "times": ["06:30", "18:30"],
        "timezone": "America/New_York"
    },
    "STATUS_TRACKING": false,
    "PALGUARD_ACTIVE": false
}

What is a watchdog application?

A watchdog application is a specialized software tool that monitors the status of your server application to ensure it is running correctly. If the script detects that the server has stopped, crashed, or is not responding, it will automatically restart the application to minimize downtime. This is crucial for maintaining server availability, especially for scheduled restarts, as it ensures the server is promptly brought back online without manual intervention. The use of a watchdog script is essential for automated server management processes, providing a fail-safe to keep the server operational.

Examples of Watchdog Applications:

  • TCAdmin
  • Pterodactyl
  • CubeCoders AMP
  • Systemd
  • Windows Task Scheduler
  • Docker
Clone this wiki locally