Before you start
Node 1.0.0 installs into an existing Pterodactyl panel. It is not a standalone game-hosting service. The BuiltByBit listing is in preparation; this guide explains the package’s requirements.
- Back up your panel files and database.
- Keep your panel’s
APP_KEYand Node backup directory safe. - Extract the downloaded package outside the panel directory.
- Read the English or French installation guide included in the archive.
Compatibility
Your normal PHP, database, web-server, cron and queue services must already work. Other themes, modified protected files and unsupported panel releases are not automatically merged.
The common client-area controls follow your configured eggs and permissions. Dedicated Minecraft Java and FiveM tools require the corresponding server files. Hytale and Palworld catalog access depends on an authorized CurseForge key.
Install Node
From the extracted package directory, run the compatibility check first. Replace the panel path if yours is different.
python3 install.py check --panel /var/www/pterodactylOnce the check passes and your backups are ready:
sudo python3 install.py install --panel /var/www/pterodactylThe installer backs up original files, enables maintenance, installs the theme and Node database tables, reloads caches and reopens the panel. It refuses incompatible protected files. No Yarn build is required on the production server.
For a Docker panel, run the installer inside the panel’s Linux container with Python available there. See the package guide for alternate PHP binaries and recovery instructions.
Optional integrations
Modrinth & SpigotMC
Catalogs are available without a Node-specific key. Downloads use Wings and respect native file permissions. Check game version and loader compatibility before installing.
CurseForge, Hytale & Palworld
Your panel administrator supplies an authorized CurseForge API key. Availability depends on the games the key can access. Modpacks and their dependencies are not deployed automatically.
BlueMap
Use your own publicly reachable HTTPS map URL. Its host must allow embedding. An external-open option is available if embedding is restricted.
Assistant
The built-in guide works without an AI provider. AI responses require the administrator’s own provider key and model. Provider fees are separate; the assistant cannot execute server actions.
Keys belong in your server-side configuration, never in a public website or demo. Follow the environment-variable instructions included with Node.
Update or uninstall
Use the installer from a compatible Node package to update. Uninstall restores original panel files and retains Node conversations, preferences and encrypted secrets in the database.
sudo python3 install.py update --panel /var/www/pterodactyl
sudo python3 install.py uninstall --panel /var/www/pterodactylChanges to installed theme files are detected and need review before updating or removing. For a failed installation, use the explicit restore procedure and backup identifier described in the archive.
About the public demo
The public demo site is a read-only design preview using illustrative data and the earlier standalone presentation layer. Some screens differ from the native package. It cannot connect to, modify or run a game server.
Color and language changes are temporary previews. The native PHP application needs a working Pterodactyl server; it cannot be hosted on static Netlify hosting.
Open the demo