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: apps/frontend/content/guides/dev/packaging.md
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,16 @@
1
1
---
2
-
title: Packaging extensions
3
-
description: Export extensions into ".blueprint" files for distribution
2
+
title: Exporting your extension
3
+
description: Export extensions into "myextension.blueprint" files for distribution
4
4
author: Emma
5
5
category: dev
6
6
thumbnail: files.jpeg
7
-
order:
8
7
---
9
8
10
-
## Export your extension with the CLI
9
+
## Introduction
10
+
11
+
Blueprint extensions are distributed with `{identifier}.blueprint` files. Users can upload these files to their Pterodactyl directory and install your extension through the Blueprint CLI.
12
+
13
+
## Export the extension
11
14
12
15
To turn your development files into a distributable `{identifier}.blueprint` file, we'll need to use Blueprint's CLI utility to package it.
13
16
@@ -28,12 +31,20 @@ Blueprint can generate a temporary download link for your extension for easier e
28
31
blueprint -export expose
29
32
```
30
33
31
-
###Test your exported extension
34
+
## Test the extension
32
35
33
36
Testing is important! You should always check if an extension still works as expected, especially when using export scripts. Install your extension, test it on your panel and finally, if all is right, distribute it.
34
37
35
-
## Manually export your extension
38
+
```bash
39
+
# Make sure to remove your extension beforehand, if it is
40
+
# installed.
41
+
blueprint -remove myextension
42
+
43
+
# Install the myextension.blueprint file once again, which
44
+
# should now exist in your Pterodactyl panel.
45
+
blueprint -install myextension
46
+
```
36
47
37
-
Don't do this! Even though extensions are practically ZIP files, exporting manually can break your extension, in current and future releases of Blueprint.
48
+
## That's it!
38
49
39
-
Our CLI does more than just archiving extensions, it excludes certain directories, runs export scripts and enforces the folder structure Blueprint expects.
50
+
You can now distribute your `{identifier}.blueprint` file. There are a few marketplaces that have specific categories/tags for Blueprint extensions. If your extension is open-source, add the [blueprint-extension](https://github.com/topics/blueprint-extension) tag to your repository!
Copy file name to clipboardExpand all lines: apps/frontend/src/pages/app/extensions/[id].vue
+14-10Lines changed: 14 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -257,7 +257,7 @@
257
257
<ElementsFormBinarytoggle
258
258
v-model="form.unlisted"
259
259
label="Visibility"
260
-
description="Public extensions are discoverable through the platform, unlisted extension only using their direct link. If your extension is pending review, this setting will immediately apply after approval."
260
+
description="Public extensions are discoverable through the platform, unlisted only available to users with access. If your extension is pending review, this setting will immediately apply after approval."
0 commit comments