peliprint/README.md

41 lines
1.9 KiB
Markdown
Raw Normal View History

## ![](https://i.imgur.com/SsOU6r8.png) teamblueprint/main
[Discord ➚](https://ptero.shop/community)\
[Documentation ➚](https://ptero.shop/docs)
[Installation](#installation)\
[Development](#development)\
2023-07-04 05:36:20 -04:00
[Extensions](#extensions)\
[Contributions](#contributions)
### Installation
**What you need:**
* The latest release of Blueprint. [Download ➚](https://github.com/teamblueprint/main/releases/latest)
* `unzip` [Download ➚](https://pkgs.org/download/unzip)
* Linux and Pterodactyl knowledge.
* Fingers and a brain.
2023-05-07 06:55:12 -04:00
**Installation:**
2023-06-23 12:15:30 -04:00
1. Navigate to `/var/www/pterodactyl`. (your Pterodactyl installation should be installed there or in `/var/www/html`, else it might not be compatible with Blueprint)
```sh
cd /var/www/pterodactyl
```
2. Run the Blueprint installation script. This runs the commands required for Blueprint to function correctly.
```sh
chmod +x blueprint.sh
bash blueprint.sh
```
3. 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-06-23 12:15:30 -04:00
We've made some guides 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-06-23 12:15:30 -04:00
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`.
2023-05-24 04:15:23 -04:00
**Redirect**: [PterodactylMarket](https://pterodactylmarket.com/resource/664), [GitHub](https://github.com/prplwtf/blueprint-redirect)\
2023-06-23 14:55:19 -04:00
**dbEdit**: [GitHub](https://github.com/prplwtf/blueprint-dbedit)
2023-07-04 05:36:20 -04:00
### Contributions
[prplwtf](https://github.com/prplwtf) - creator and maintainer\
[alipoyrazaydin](https://github.com/alipoyrazaydin) - contributor\
2023-07-06 10:29:47 -04:00
[sp11rum](https://github.com/sp11rum) - contributor