Getting started with Bots & Automation

This guide helps you set up your Bots & Automation server on ServerPrism. You will learn how to deploy your server, configure your chosen bot, and get it running on your platform.

Before you start

Before ordering, identify the bot you want to run. Each bot requires specific tokens or API keys from the platform it interacts with (e.g., Twitch, Discord, game servers). Obtain these keys in advance.

Ordering on ServerPrism

1. Select a plan: Choose the Bots & Automation game from the ServerPrism order page. We recommend a minimum of 2 GB RAM for basic bots, up to 8 GB RAM for more complex setups or multiple instances.
2. Pick a region: Select the data center location closest to your target audience or yourself for optimal performance.
3. Choose your bot: On the order configuration page, select your desired bot runtime (e.g., PhantomBot, SogeBot, JTS3ServerMod) from the available options. This installs the core files for you.
4. Deploy: Complete your order. Your server will begin deploying automatically.

First boot

After deployment, your server will start for the first time. The initial startup downloads any remaining dependencies for your chosen bot. You can monitor the progress in the ServerPrism panel's Console tab. The server is ready when the console output indicates the bot has started successfully, often by displaying a message like "Bot started" or "Listening for commands."

Connecting / inviting players

Bots typically don't have a direct "connection" like a game server. Instead, they connect to a platform (like Twitch or Discord) using credentials you provide. Once configured, the bot operates within that platform. For bots that manage game servers (like Big Brother Bot B3 or JTS3ServerMod), the bot connects to the game server's RCON or query port.

Configuration basics

Configuration for your bot is done via files or environment variables, depending on the bot.

PhantomBot

1. Access files: Use the ServerPrism panel's File Manager or SFTP to navigate to your server's phantombot directory.
2. Edit botlogin.txt: This file contains your Twitch channel, bot username, and OAuth token. Follow the instructions within the file to enter your credentials.
3. Edit config.ini: Adjust general bot settings like command prefix, language, and module configurations here.
4. Restart: After saving changes, restart your server from the ServerPrism panel's Console or Power tab for them to take effect.

SogeBot

SogeBot primarily uses environment variables for initial setup.

1. Startup Variables: Go to the Startup tab in your ServerPrism panel.
2. Set TWITCH_USERNAME and TWITCH_OAUTH: Enter your Twitch bot username and OAuth token here. You may also need to set CHANNEL for the target Twitch channel.
3. Other settings: Consult the SogeBot documentation for other available environment variables for advanced configuration.
4. Restart: Restart your server from the ServerPrism panel for changes to apply.

JTS3ServerMod

1. Access files: Use the ServerPrism panel's File Manager or SFTP.
2. Navigate: Go to config/server1/.
3. Edit JTS3ServerMod_server.cfg: This is the main configuration file. Edit settings like your TeamSpeak 3 server query address, port, username, password, and specific module configurations.
4. Save and Restart: Save the file and restart your server from the ServerPrism panel.

Big Brother Bot (B3)

1. Access files: Use the ServerPrism panel's File Manager or SFTP.
2. Navigate: Go to b3/conf/.
3. Edit b3.xml: This is the primary configuration file. You will need to configure your database connection (SQLite is often default and sufficient), game server details (IP, port, RCON password), and administrative settings.
4. Edit plugins.xml: Enable or disable specific B3 plugins here.
5. Save and Restart: Save all changes and restart your server from the ServerPrism panel.

Common issues

• Bot not connecting to platform: Double-check your API keys, OAuth tokens, and usernames for typos. Ensure they have the correct permissions on the platform (e.g., moderator status for Twitch bots).
• Bot not starting: Check the Console tab for error messages. Missing dependencies, incorrect file paths, or invalid configuration syntax are common culprits. If you made changes to config files, revert them one by one to isolate the issue.
• Commands not working: Verify the bot is successfully connected and that the command prefix is correct. For game server bots, ensure the game server's RCON password and IP are correctly configured in the bot's settings.
• High resource usage: If your bot is consuming too much RAM or CPU, review its configuration. Some modules or features can be resource-intensive. Consider upgrading your ServerPrism plan via the customer dashboard if necessary.

Next steps

Once your bot is running, explore its full capabilities:

• Module/Plugin management: Most bots allow you to enable, disable, or configure additional modules or plugins for extended functionality.
• Custom commands: Learn how to add custom commands specific to your community or game server.
• Runtime switching: If you want to try a different bot, you can switch your server's runtime directly from the Startup tab in your ServerPrism panel without needing to reorder your server.
• Community support: Many bots have active communities or documentation you can refer to for advanced setups. If you encounter persistent issues, open a support ticket at https://serverprism.com/tickets, providing your server ID and any relevant console logs.