codixer / main Goto Github PK

Discord ➚
Documentation ➚

Introduction
Installation
Development
Extensions
Contributors
Related Links

Blueprint is an open-source extension framework/manager for Pterodactyl. Developers can create versatile, easy-to-install extensions that system administrators can install within minutes (and sometimes even seconds!).

We aim to introduce new developers to Blueprint with easy to understand guides, documentation, developer commands, community support and more.

What you need:

• The latest release of Blueprint.
• unzip
• zip
• curl
• git
• nodejs (20.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_20.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.

We've made some guides and documentation for extension development over on GitBook. We are adding more guides over time, don't hesitate to suggest a topic for future guides.

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.

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

prplwtf - creator and maintainer
ahwxorg - contributor
alipoyrazaydin - contributor
sp11rum - contributor
phedona - contributor

Pterodactyl is a free, open-source game server management panel built with PHP, React, and Go.

teamblueprint/templates is a repository with initialization templates for extension development.