Difference between revisions of "Extensions:Theme Manager"

From Lorekeeper Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
Tag: 2017 source edit
Line 1: Line 1:
{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Theme Manager|desc=Custom CSS themes for LK websites|auth=Preimpression|status=Testing|github={{Github|user=preimpression|branch=extension/theme-manager}}|migration=yes|package=no}}
<!-- Put a short summary of your extension here! -->
+
 
Install custom themes on your  
+
Install custom themes on your Lorekeeper site. These are primarily CSS edits plus a custom header per theme - any hard code edits should be made in the actual blades. There is no "templating" such as in most forum softwares and you will have to upload full css files in order to edit them. The extension "cheats" the cache by creating false variables with the hash every time a theme is updated, so you won't have to fight with Cloudflare to update your cache for images or css if you have that set up for your site.
  
 
== Installation ==
 
== Installation ==
Line 11: Line 11:
  
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
 
== Usage ==
+
'''The following file types can be header images:''' gif, png, jpeg, jpg, svg. It's advised that you either hard-code in your game's logo into the header box in '''app.blade.php''' or otherwise include it in each custom header image.
<!-- Is there anything users should know about using your extension? -->
+
 
 +
Your site may have one Default Theme at a time. Default themes will be the default for guests and users who have not selected themes in their user settings panel. If no theme is set as default, it will appear as if the Theme Manager is not installed - aka it will be classic Lorekeeper or whatever custom css you have placed.
 +
 
 +
The code does not adjust any blades in a meaningful way, though it does make a tiny adjustment to comment code because I noticed that it looked super weird. Eventually I will PR that change into v.2.0.0 :)
 +
 
 +
== Creating Themes ==
 +
 
 +
There will soon be a theme creation tutorial, though honestly it's mostly just sitting down with what you have and fiddling. I've created a [https://gist.github.com/preimpression/6973c4b311c962d5a7df51ef0a2ea8ff nifty dark mode theme] (no header image) that you can see, using a large number of CSS variables. CSS variables are ideal because you can edit them at the top of the file and they will propagate over wherever they're used.
 +
 
 +
To access theme creation, there is a page in your admin panel called Theme Manager underneath File Manager.
 +
 
 +
== Free Use Themes ==
 +
 
 +
* [https://gist.github.com/preimpression/6973c4b311c962d5a7df51ef0a2ea8ff Generic Dark Mode] by [https://preimpression.art/ Preimpression]
 +
 
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
No known issues however if you wish for custom.css code to be maintained regardless of theme, open '''app.blade.php''' and move the custom css code to below the theme css code.
== Images ==
+
 
<!-- Do you have any images to show what it looks like in action? -->
 
 
== See Also ==
 
== See Also ==
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
+
For any questions and '''custom theme commissions''', contact Uri on Discord: Uri#2154.

Revision as of 14:25, 8 April 2021

Theme Manager
Description Custom CSS themes for LK websites
Author(s) Preimpression
Status Testing
Github extension/theme-manager
LK Version Unspecified
Contains a Migration






Install custom themes on your Lorekeeper site. These are primarily CSS edits plus a custom header per theme - any hard code edits should be made in the actual blades. There is no "templating" such as in most forum softwares and you will have to upload full css files in order to edit them. The extension "cheats" the cache by creating false variables with the hash every time a theme is updated, so you won't have to fight with Cloudflare to update your cache for images or css if you have that set up for your site.

Installation

Created on the Develop branch.

- Pull/Merge in the branch

- Run php artisan migrate

Configuration

The following file types can be header images: gif, png, jpeg, jpg, svg. It's advised that you either hard-code in your game's logo into the header box in app.blade.php or otherwise include it in each custom header image.

Your site may have one Default Theme at a time. Default themes will be the default for guests and users who have not selected themes in their user settings panel. If no theme is set as default, it will appear as if the Theme Manager is not installed - aka it will be classic Lorekeeper or whatever custom css you have placed.

The code does not adjust any blades in a meaningful way, though it does make a tiny adjustment to comment code because I noticed that it looked super weird. Eventually I will PR that change into v.2.0.0 :)

Creating Themes

There will soon be a theme creation tutorial, though honestly it's mostly just sitting down with what you have and fiddling. I've created a nifty dark mode theme (no header image) that you can see, using a large number of CSS variables. CSS variables are ideal because you can edit them at the top of the file and they will propagate over wherever they're used.

To access theme creation, there is a page in your admin panel called Theme Manager underneath File Manager.

Free Use Themes

Troubleshooting

No known issues however if you wish for custom.css code to be maintained regardless of theme, open app.blade.php and move the custom css code to below the theme css code.

See Also

For any questions and custom theme commissions, contact Uri on Discord: Uri#2154.