Skip to content

Commit

Permalink
feat(docs): do a bunch of stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
prplwtf committed Nov 14, 2023
1 parent af81caa commit 38d7282
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/pages/developing-extensions/Admin-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Admin configuration
<h4 class="fw-light">placeholder</h4><br/>
<h4 class="fw-light">Add configuration options to your extension's admin page</h4><br/>

<div class="btn-group" role="group" aria-label="Basic example">
<div class="btn-group" role="group" aria-label="Navigation" style="float: right">
<a href="?page=developing-extensions/Importing-$blueprint" class="btn btn-dark bg-light-subtle border-light-subtle">Previous</a>
<a href="?page=developing-extensions/Packaging-extensions" class="btn btn-dark bg-light-subtle border-light-subtle">Next</a>
</div>
4 changes: 2 additions & 2 deletions docs/pages/developing-extensions/Custom-controllers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Custom controllers
<h4 class="fw-light">placeholder</h4><br/>
<h4 class="fw-light">Write custom controllers instead of using the premade one</h4><br/>

<div class="btn-group" role="group" aria-label="Basic example">
<div class="btn-group" role="group" aria-label="Navigation" style="float: right">
<a href="?page=developing-extensions/Writing-extensions" class="btn btn-dark bg-light-subtle border-light-subtle">Previous</a>
<a href="?page=developing-extensions/Importing-$blueprint" class="btn btn-dark bg-light-subtle border-light-subtle">Next</a>
</div>
4 changes: 2 additions & 2 deletions docs/pages/developing-extensions/Importing-$blueprint.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Importing $blueprint
<h4 class="fw-light">placeholder</h4><br/>
<h4 class="fw-light">Import the BlueprintExtensionLibrary into your admin controller</h4><br/>

<div class="btn-group" role="group" aria-label="Basic example">
<div class="btn-group" role="group" aria-label="Navigation" style="float: right">
<a href="?page=developing-extensions/Custom-controllers" class="btn btn-dark bg-light-subtle border-light-subtle">Previous</a>
<a href="?page=developing-extensions/Admin-configuration" class="btn btn-dark bg-light-subtle border-light-subtle">Next</a>
</div>
4 changes: 2 additions & 2 deletions docs/pages/developing-extensions/Packaging-extensions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Packaging extensions
<h4 class="fw-light">placeholder</h4><br/>
<h4 class="fw-light">Package extensions into ".blueprint" files for distribution</h4><br/>

<div class="btn-group" role="group" aria-label="Basic example">
<div class="btn-group" role="group" aria-label="Navigation" style="float: right">
<a href="?page=developing-extensions/Admin-configuration" class="btn btn-dark bg-light-subtle border-light-subtle">Previous</a>
<button type="button" class="btn btn-dark bg-light-subtle border-light-subtle text-secondary disabled">Next</button>
</div>
2 changes: 1 addition & 1 deletion docs/pages/developing-extensions/Writing-extensions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Writing extensions
<h4 class="fw-light">Learn the basics of extension development</h4><br/>

<div class="btn-group" role="group" aria-label="Basic example">
<div class="btn-group" role="group" aria-label="Navigation" style="float: right">
<a href="?page=getting-started/Extension-development" class="btn btn-dark bg-light-subtle border-light-subtle">Previous</a>
<a href="?page=developing-extensions/Custom-controllers" class="btn btn-dark bg-light-subtle border-light-subtle">Next</a>
</div>
4 changes: 2 additions & 2 deletions docs/pages/documentation/$blueprint.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# $blueprint
<h4 class="fw-light">Library for extensions to simplify admin notifications, databasing and more</h4><br/>

<div class="alert alert-info" role="alert">
<i class="bi bi-info-lg me-2 mt-1 mb-1" style="font-size:23px; float: left;"></i>
<div class="alert alert-dark" role="alert">
<i class="bi bi-currency-dollar me-2 mt-1 mb-1" style="font-size:23px; float: left;"></i>
<div class="ps-3 ms-3"><b>BlueprintExtensionLibrary</b> (or $blueprint) is added automatically when using the default controller by leaving your controller path option blank. For custom controllers, you may refer to <a href="?page=developing-extensions/Importing-$blueprint" class="alert-link">this guide</a>.</div>
</div>
<br/>
Expand Down
23 changes: 22 additions & 1 deletion docs/pages/getting-started/Extension-development.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
# Extension development
<h4 class="fw-light">Set up your extension development environment</h4><br/>
<div class="alert alert-dark" role="alert">
<i class="bi bi-toggle-on me-2 mt-1 mb-1" style="font-size:23px; float: left;"></i>
<div class="ps-3 ms-3"><b>Developer mode</b> needs to be turned on in your <b>admin panel</b> <p- class="opacity-50">(Admin > Extensions > Blueprint)</p-> before you can run developer commands. You only have to do this once.</div>
</div><br/>

<div class="btn-group" role="group" aria-label="Basic example">
### **Quick start**

Get started by beginning from a template, naming and describing your extension through the initialize command.
```sh
blueprint -init
```
When choosing a template, select `Barebones` to be able to follow along with this guide. Most options can be changed later, so don't procrastinate too much thinking of an extension name.

After running this command, you can now find your extension files in the `.blueprint/dev` directory (which is located inside of your Pterodactyl folder). You can use cd to change to this directory.
```sh
cd .blueprint/dev
```
<div class="alert alert-light" role="alert">
<i class="bi bi-terminal-fill me-2 mt-1 mb-1" style="font-size:23px; float: left;"></i>
<div class="ps-3 ms-3">While you can develop extensions without ever leaving your terminal emulator, you can also transfer files from your local machine to your server using SFTP or use specific applications to automate this process (such as <a href="https://open-vsx.org/extension/Natizyskunk/sftp" class="alert-link">this VSCode extension</a>).</div>
</div><br/>

<div class="btn-group" role="group" aria-label="Navigation" style="float: right">
<button type="button" class="btn btn-dark bg-light-subtle border-light-subtle text-secondary disabled">Previous</button>
<a href="?page=developing-extensions/Writing-extensions" class="btn btn-dark bg-light-subtle border-light-subtle">Next</a>
</div>

0 comments on commit 38d7282

Please sign in to comment.