Update docs/contribute/themes.md

This commit is contained in:
marcia 2024-05-29 18:21:06 +00:00
parent c6b3ae5cc1
commit 991703f00e
1 changed files with 41 additions and 0 deletions

View File

@ -15,3 +15,44 @@ Cwtch now supports customized Cwtch themes. Themes can be loaded via the [Settin
The easiest way to get started with custom themes is to make a copy of an existing theme
directory (e.g. [Cwtch Theme](https://git.openprivacy.ca/cwtch.im/cwtch-ui/src/branch/trunk/assets/themes/cwtch) and
edit the yaml file.
### Good news, now you can create your own Cwtch light and dark themes with a simple template!
#### Follow these easy steps to create a brand new theme:
* Download [this test folder], which includes: theme.yml (editable file) and test.png (background image) and Instructions.pdf
* Load the test theme through the settings pane. Settings > Import theme , select the “test” folder and click on “select folder”
* Now you have the test theme installed and you can edit the .yml file
* Check the instructions.pdf file for more in depth instructions on how to edit the .yml file and what each part of the code changes!
#### Editing the .yml file:
* Pick your colours using any web tool, we recommend https://mycolor.space/
* Pick a colour to be your accent colour and select all the other colours based on that one
* Open theme.yml
* Replace the part under "colours" where 0x`FFFFFF` colours appear with the HEX value of colours you chose (follow the instructions after each colour for better results!)
* Don't include the # on the HEX value
* Replace test.png for a transparent png you want to use as a background, if you dont want a background image, disable theme images on settings>theme images
* Hit save!
#### Testing your new theme:
* Re-load the test theme through the settings pane. Settings> Import theme , select the “test” folder and click on “select folder”
* Repeat until youre satisfied with your new theme!
* If you're an advanced user, feel free to edit the .yml code beyond selecting colours!
As always, let us know if this is working for you, we'd love to hear your feedback