Skip to content

Powerful, fast and developer-friendly extension framework for Pterodactyl. Utilize extension APIs, inject HTML, modify stylesheets, package extensions and so much more.

License

Notifications You must be signed in to change notification settings

BlueprintFramework/framework

Repository files navigation

Introduction

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 (usually even seconds!) without having to custom-code compatibility across multiple panel modifications.

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

Learn more about Blueprint or find your next extension.

Install Blueprint

Refer to the installation guide.


Donate and contribute

Blueprint is free and open-source software. We play a vital role in the Pterodactyl modding community and empower developers with tools to bring their ideas to life. To keep everything up and running, we rely heavily on donations. We're also nonprofit!

If you are an organization, consider becoming a corporate sponsor. Blueprint hosts guides and documentation that bring new developers to the hosting industry, giving a new chance for companies to aquire new talent and bring their operations further.

Donate to our nonprofit organization or view our open finances.

Contributors

Contributors help shape the future of the Blueprint modding framework. To start contributing you have to fork this repository and open a pull request.

Related repositories

The Blueprint modding platform is spread over multiple repositories, each with it's own purpose. If you'd like to contribute, check out the following repositories:


What's in here?

The framework repository hosts the "Blueprint patch" that you apply onto your Pterodactyl panel. This overwrites files like installing a "standalone addon" would, but instead of being just that, Blueprint allows your panel to be extended through "extensions".

  • Blueprint's CLI is written in Bash.
  • The backend adds onto Pterodactyl's, and is written in PHP/Laravel.
  • The user-side frontend adds onto Pterodactyl's, and is written in React/TypeScript.
  • The admin-side frontend adds onto Pterodactyl's, and is written in PHP/Laravel/Blade.

CLI

Our main CLI script is blueprint.sh. This script gets called by /usr/local/bin/blueprint whenever a user runs the blueprint command, or queries bash autocomplete.

blueprint.sh is in charge of the following duties;

  • Finishing initial installation steps and updates (flushing cache, artisan commands, etc)
  • Sourcing CLI dependencies (scripts/libraries)
  • Running the right sub-scripts for each command (scripts/commands)
  • Placing the Blueprint command shortcut to /usr/local/bin/blueprint

We used to do everything in the main CLI script, which overcomplicated everything a lot. Everything is now (mostly) designated to it's own area.


Showcase

We've got a growing ecosystem of extensions, from ones cover game features such as Minecraft and Hytale, to useful quality-of-life admin tools.



© 2023-2026 Emma (prpl.wtf)