phedona / blueprint-guides

Guides for the Pterodactyl Framework "Blueprint"

Blueprint-Guides

Guides for the Pterodactyl Framework "Blueprint"

For Support: Discord ➚
Documentation ➚

Installation
Development
Upgrading
Extensions
Credits

Installation

What you need:

• The latest release of Blueprint.
• unzip
• nodejs (18.x or later)
• yarn
• Linux and Pterodactyl knowledge.
• Common sense

Installation:

1. Blueprint doesn't mix well with other modifications, so if you already have any, perform a panel update before moving on with this guide.
2. Navigate to your Pterodactyl folder. (most likely /var/www/pterodactyl)
3. Install NodeJS, NPM and Yarn using the following script. This assumes you are running Pterodactyl on Ubuntu or Debian-based systems.

curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
apt-get install -y nodejs
npm i -g yarn
yarn

4. Download the latest release of Blueprint and extract it (stable build) or pull the files via git (bleeding-edge build).
5. If you haven't already, place the Blueprint files inside of your Pterodactyl folder. (common location is /var/www/pterodactyl)
6. Run the Blueprint installation script. This runs the commands required for Blueprint to function correctly. If your Pterodactyl folder is not /var/www/pterodactyl you may need to put _FOLDER="/path/to/pterodactyl" in front of bash blueprint.sh.

chmod +x blueprint.sh
bash blueprint.sh

7. After waiting for the installation script to finish, open up your Pterodactyl admin panel and click on the puzzle icon in the top right of the website.

Upgrade

To upgrade Blueprint or its extensions after a Pterodactyl Update, follow these steps:

1. Create a backup of your current panel. In case anything goes wrong, you can use your backup.
2. Run the command blueprint -upgrade.

Success! You have successfully upgraded Blueprint. Now you can install your extensions as usual.

Development

There are some guides and documentation for extension development over on GitBook. You can also enable/disable the developer mode through Blueprint to access developer-oriented features. We are also adding more guides over time, so don't hesitate to suggest a topic for future guides.

Extensions

Open an issue on GitHub to get your extension listed here. To install an extension, upload your something.blueprint file to your Pterodactyl folder and run blueprint -install something.

Available Extensions:\

Announcements: PterodactylMarket, sourceXchange, BuiltByBit
Arc.io Integration: BuiltByBit
Cats: sourceXchange
Cookies: sourceXchange
dbEdit: GitHub
Loader: sourceXchange
Nebula: PterodactylMarket, sourceXchange, BuiltByBit
Recolor: GitHub, sourceXchange
Redirect: PterodactylMarket, GitHub

Credits

All Credits goes to Purple