Update custom_theme_setup.md

This commit is contained in:
Lance Pioch 2019-08-28 11:56:09 -04:00 committed by GitHub
parent 0a559c2aa3
commit 27b7f42702
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,13 +2,13 @@
This tutorial briefly covers how to create a theme for Pterodactyl without overwriting the main theme files.
## Using CLI
To begin, we will be using php artisan as it's the easiest and quickest method to do so than igaster's method. Let's begin by creating by going to your panel's main directory typically installed at `/var/www/pterodactyl`. The command below is a straight-forward setup. This setup will cover
the majority of the functions all for you such as Theme Name, Views Location, Assets Location etc. So let's create a theme!
Begin by going to your panel's main directory typically installed at `/var/www/pterodactyl`. The command below is a straightforward setup that will cover
the majority of the functions all for you (such as Theme Name, Views Location, Assets Location etc).
``` bash
php artisan theme:create
```
This command will enter you into a step by step procedure. Here are the ones you would want to fill in.
This command will activate the theme wizard. Besides the name, the defaults will suffice, see the below example.
::: warning Do not create the theme named as `pterodactyl` as that is Pterodactyl's main design and should NOT be overwritten. :::
``` bash
Give theme name:
@ -26,7 +26,7 @@ Give theme name:
If you have done it correctly, the summary should be like this:
Summary:
- Theme name: `(MyThemeHere)`
- Theme name: `MyThemeHere`
- Views Path: `/var/www/pterodactyl/resources/themes/MyThemeHere`
- Asset Path: `/var/www/pterodactyl/public/MyThemeHere`
- Extends Theme: No
@ -36,15 +36,17 @@ Summary:
> (Press Enter)
```
If the above shows as that then Congratulations! You have created your theme correctly! Now let's set your newly created theme as default.
Go ahead and place your downloaded theme in the correct directory **without overwriting** the default Pterodactyl theme such as the following:
If the above shows as that then your initial theme has been created correctly!
Your `public` folder into /var/www/pterodactyl/public/themes/MyThemeHere/
### Set your newly created theme as default
Place your downloaded theme in the correct directory **without overwriting** the default Pterodactyl theme. See the following examples:
Your `resources` folder into /var/wwww/pterodactyl/resources/themes/MyThemehere/
Your `public` folder into `/var/www/pterodactyl/public/themes/MyThemeHere/`
Your `resources` folder into `/var/wwww/pterodactyl/resources/themes/MyThemehere/`
### Setting your theme name in .env
After creating your theme correctly and uploading the theme files correctly, you should edit your `.env` file next.
Open up your .env file and locate `APP_THEME=pterodactyl` line and change it to `APP_THEME=MyThemeHere` (case-sensitive) and save it.
After creating your theme and uploading those theme files correctly, you need to edit your `.env` (environment) file next.
Open up your `.env` file and locate `APP_THEME=pterodactyl` line and change it to `APP_THEME=MyThemeHere` (case-sensitive) and save it.
If done correctly, your panel will now load your theme correctly without any issues.
When done correctly, your panel will now load your custom/new theme correctly without any issues.