2023-08-17 05:56:03 -04:00
< h2 > < img src = "https://i.imgur.com/nBYQ4Bl.png" style = "height:30px;padding-right:1px" > < / img > < / h2 >
2023-08-16 10:09:26 -04:00
2023-06-15 05:44:33 -04:00
[Discord ➚ ](https://ptero.shop/community )\
2023-05-04 12:48:44 -04:00
[Documentation ➚ ](https://ptero.shop/docs )
2023-05-04 08:38:35 -04:00
2023-06-11 13:58:55 -04:00
[Installation ](#installation )\
[Development ](#development )\
2023-07-04 05:36:20 -04:00
[Extensions ](#extensions )\
[Contributions ](#contributions )
2023-06-11 13:58:55 -04:00
2023-05-04 08:38:35 -04:00
### Installation
**What you need:**
2023-07-29 15:56:05 -04:00
* [The latest release of Blueprint. ](https://github.com/teamblueprint/main/releases/latest )
* [`unzip` ](https://pkgs.org/download/unzip )
* [`nodejs` ](https://nodejs.org ) (18.x or later)
2023-09-24 10:00:59 -04:00
* [`yarn` ](https://yarnpkg.com/ )
2023-05-04 08:38:35 -04:00
* Linux and Pterodactyl knowledge.
2023-07-29 15:56:05 -04:00
* Common sense.
2023-05-04 08:38:35 -04:00
2023-05-07 06:55:12 -04:00
**Installation:**
2023-07-29 15:56:05 -04:00
1. Navigate to your Pterodactyl folder. (most likely `/var/www/pterodactyl` )
2. Install NodeJS, NPM and Yarn using the following script. This assumes you are running Pterodactyl on Ubuntu or Debian-based systems.
```sh
curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
apt-get install -y nodejs
npm i -g yarn
yarn
```
2023-09-03 16:48:08 -04:00
3. 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` .
2023-05-04 08:38:35 -04:00
```sh
chmod +x blueprint.sh
bash blueprint.sh
```
2023-07-29 15:56:05 -04:00
4. 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.
2023-05-21 07:51:08 -04:00
### Development
2023-07-29 15:56:05 -04:00
We've made some guides and documentation for extension development over on [GitBook ](https://ptero.shop/docs ). We are adding more guides over time, don't hesitate to suggest a topic for future guides.
2023-05-24 04:15:23 -04:00
### Extensions
2023-08-24 16:09:35 -04:00
[Open an issue ](https://github.com/teamblueprint/main/issues ) 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` .
2023-05-24 04:15:23 -04:00
2023-07-24 11:06:49 -04:00
**Announcements**: [PterodactylMarket ](https://pterodactylmarket.com/resource/679 ), [sourceXchange ](https://www.sourcexchange.net/products/announcements )\
2023-08-16 08:52:37 -04:00
**Cats**: [sourceXchange ](https://www.sourcexchange.net/products/cats )\
2023-09-03 16:34:06 -04:00
**Cookies**: [sourceXchange ](https://www.sourcexchange.net/products/cookies )\
2023-08-03 16:03:26 -04:00
**dbEdit**: [GitHub ](https://github.com/prplwtf/blueprint-dbedit )\
2023-08-23 16:11:19 -04:00
**Loader**: [sourceXchange ](https://www.sourcexchange.net/products/loader )\
2023-09-25 12:21:30 -04:00
**Nebula**: [sourceXchange ](https://www.sourcexchange.net/products/nebula )\
2023-08-04 06:45:16 -04:00
**Recolor**: [GitHub ](https://github.com/sp11rum/recolor ), [sourceXchange ](https://www.sourcexchange.net/products/announcements )\
2023-08-03 16:03:26 -04:00
**Redirect**: [PterodactylMarket ](https://pterodactylmarket.com/resource/664 ), [GitHub ](https://github.com/prplwtf/blueprint-redirect )
2023-07-04 05:36:20 -04:00
### Contributions
[prplwtf ](https://github.com/prplwtf ) - creator and maintainer\
2023-07-30 06:13:53 -04:00
[ahwxorg ](https://github.com/ahwxorg ) - contributor\
2023-07-04 05:36:20 -04:00
[alipoyrazaydin ](https://github.com/alipoyrazaydin ) - contributor\
2023-08-16 10:09:26 -04:00
[sp11rum ](https://github.com/sp11rum ) - contributor