documentation/community/tutorials/custom_theme_setup.md
Patrick Beart f1f50208eb
Fix suggested assets path in theme setup docs
With the leading /, the path is interpreted as absolute so will attempt to load theme resources from `http://themes/<themename>/resource`. After removing this leading / themes can be created successfully.
2020-04-21 09:40:30 +01:00

53 lines
2.2 KiB
Markdown

# Creating a theme for Pterodactyl
This tutorial briefly covers how to create a theme for Pterodactyl without overwriting the main theme files.
## Using CLI
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 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:
> (Enter Theme Name Here) (Example: MyThemeNameHere)
Where will views be located? []:
> (Press Enter)
Where will assets be located? []:
> themes/(MyThemeNameHere) (Example: themes/MyThemeNameHere)
Extends an other theme? (yes/no) [no]:
> (Press Enter)
```
If you have done it correctly, the summary should be like this:
Summary:
- Theme name: `MyThemeHere`
- Views Path: `/var/www/pterodactyl/resources/themes/MyThemeHere`
- Asset Path: `/var/www/pterodactyl/public/themes/MyThemeHere`
- Extends Theme: No
```bash
Create Theme? (yes/no) [yes]:
> (Press Enter)
```
If the above shows as that then your initial theme has been created correctly!
### 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 `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 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.
When done correctly, your panel will now load your custom/new theme correctly without any issues.