You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,16 @@ We aim to introduce new developers to Blueprint with easy to understand guides,
7
7
8
8
[Learn more about **Blueprint**](https://blueprint.zip) or [find your **next extension**](https://blueprint.zip/browse).
9
9
10
+
### Install Blueprint
11
+
Refer to the [installation guide](https://blueprint.zip/guides/admin/install).
12
+
10
13
<br>
11
14
12
15
## Donate and contribute
13
16
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!
14
17
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
+
15
20
[**Donate to our nonprofit organization**](https://hcb.hackclub.com/donations/start/blueprint) or [view our open finances](https://hcb.hackclub.com/blueprint).
16
21
17
22
### Contributors
@@ -30,13 +35,34 @@ The Blueprint modding platform is spread over multiple repositories, each with i
30
35
31
36
<br>
32
37
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;
0 commit comments