RealmsDocs

Host on a panel

Pterodactyl, Discloud, Square Cloud: the host package runs on Node.js or Bun.

Hosting panels run JavaScript projects, not .exe files. The host package is for them: the same bot, running on Node.js 22+ or Bun.

1. Download the host package

In My library → Get the bot, use the For hosting panels card and download the zip. If you bought on BuiltByBit, it already comes in the download, as realms-bot-host-v<version>.zip.

2. Upload it

Upload the zip's contents to the server's folder on the host (panels usually have a file manager or SFTP) and unzip it there.

HostHow to start it
Pterodactyl (Node.js or Bun egg)main file index.js
Discloudships with discloud.config
Square Cloudships with squarecloud.app

The host installs the dependency listed in package.json by itself.

3. Configure

Set DISCORD_TOKEN and DISCORD_CLIENT_ID in the panel's environment variables — or create a .env from .env.example. Everything else is already set up for a host.

4. Updates

index.js is a supervisor: when a new version is out, use Update in /panel and it downloads, installs and restarts the bot by itself — no files to touch.