Comment on page
We are moving Blueprint's documentation to a brand new website within the following weeks. This documentation website will phase out in the future.
When installing extensions, Blueprint needs to know a lot of things about an extension before it can start doing file operations. For this reason, every single extension is required to have a "conf.yml" file to inform Blueprint about what it should do with your extension.
Options for information about your extension.
nameThe display name of your extension.
identifierUsed for folder trees, routers, view names and more. Identifier may only contain a-z lowercase characters and must be unique to other extensions.
descriptionDescribe your extension. This shows on the admin page of your extension.
versionThe version of your extension.
targetThe target version is compared to the currently installed version of Blueprint on installation. If this is not the same Blueprint will warn the user about your extension possibly not being able to function correctly.
authorThe spot to put you or your team's name. Planned to be required once fully implemented.
iconFile path to your extension's icon. Must be a PNG, JPG or JPEG.
websiteURL to your extension's website.
Options for your admin page.
viewPath to your admin view.
controllerPath to your custom admin view controller.
cssAdd custom css to the Pterodactyl admin panel, provide the path to your .css file here.
wrapperPath to html you want to add to the Pterodactyl admin dashboard layout.
Options for interacting with the Pterodactyl dashboard.
wrapperPath to html you want to add to the Pterodactyl client dashboard wrapper.
cssAdd custom css into the Pterodactyl client panel, provide the path to your .css file here.
Options for data folders.
directoryPath to your data directory.
publicPath to your public directory.
Options for database-related things.
migrationsPath to your migrations folder.
Last modified 27d ago