Skip to content

Commit f5ec78e

Browse files
committed
feat: somewhat improve the readme
1 parent 090af6e commit f5ec78e

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,16 @@ We aim to introduce new developers to Blueprint with easy to understand guides,
77

88
[Learn more about **Blueprint**](https://blueprint.zip) or [find your **next extension**](https://blueprint.zip/browse).
99

10+
### Install Blueprint
11+
Refer to the [installation guide](https://blueprint.zip/guides/admin/install).
12+
1013
<br>
1114

1215
## Donate and contribute
1316
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](https://hcb.hackclub.com/blueprint/donations). We're also nonprofit!
1417

18+
If you are an organization, [consider becoming a corporate sponsor](https://hcb.hackclub.com/donations/start/blueprint/tiers/392). 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.
19+
1520
[**Donate to our nonprofit organization**](https://hcb.hackclub.com/donations/start/blueprint) or [view our open finances](https://hcb.hackclub.com/blueprint).
1621

1722
### Contributors
@@ -30,13 +35,34 @@ The Blueprint modding platform is spread over multiple repositories, each with i
3035

3136
<br>
3237

38+
## What's in here?
39+
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".
40+
41+
- Blueprint's CLI is written in Bash.
42+
- The backend adds onto Pterodactyl's, and is written in PHP/Laravel.
43+
- The user-side frontend adds onto Pterodactyl's, and is written in React/TypeScript.
44+
- The admin-side frontend adds onto Pterodactyl's, and is written in PHP/Laravel/Blade.
45+
46+
### CLI
47+
Our main CLI script is [`blueprint.sh`](./blueprint.sh). This script gets called by `/usr/local/bin/blueprint` whenever a user runs the `blueprint` command, or queries bash autocomplete.
48+
49+
[`blueprint.sh`](./blueprint.sh) is in charge of the following duties;
50+
- Finishing initial installation steps and updates (flushing cache, artisan commands, etc)
51+
- Sourcing CLI dependencies ([`scripts/libraries`](./scripts/libraries))
52+
- Running the right sub-scripts for each command ([`scripts/commands`](./scripts/commands))
53+
- Placing the Blueprint command shortcut to `/usr/local/bin/blueprint`
54+
55+
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.
56+
57+
<br>
58+
3359
## Showcase
60+
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.
61+
3462
![](https://github.com/user-attachments/assets/1cea099b-9af8-4ccc-ac1a-0a896a30f817)
3563

3664
<br/><br/>
3765
<p align="center">
3866
© 2023-2026 Emma (prpl.wtf)
3967
<br/><br/><img src="https://github.com/user-attachments/assets/e6ff62c3-6d99-4e43-850d-62150706e5dd"/>
4068
</p>
41-
42-

0 commit comments

Comments
 (0)