48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
|
# Server Logos
|
||
|
|
|
||
|
|
This folder contains images used for the Discord server icon.
|
||
|
|
It also contains [``_festivals.toml``](./_festivals.toml) which is used to choose what icon to show.
|
||
|
|
|
||
|
|
## Festivals
|
||
|
|
The config format for festivals is as follows
|
||
|
|
```toml
|
||
|
|
[[festivals]]
|
||
|
|
name = "pride"
|
||
|
|
all_year = true
|
||
|
|
start = { day = 1, month = 6, year = 0}
|
||
|
|
end = { day = 30, month = 6, year = 0}
|
||
|
|
|
||
|
|
[[festivals]]
|
||
|
|
name = "easter"
|
||
|
|
all_year = false
|
||
|
|
start = { day = 13, month = 4, year = 2025}
|
||
|
|
end = { day = 27, month = 4, year = 2025}
|
||
|
|
```
|
||
|
|
|
||
|
|
### ``[[festivals]]``
|
||
|
|
This "header" creates an array in the toml format, with everything below it (until the next ``[[festivals]]``) is part of that item.
|
||
|
|
|
||
|
|
### ``name``
|
||
|
|
Name of the festival, searches for icons which contain this name.
|
||
|
|
|
||
|
|
### ``all_year``
|
||
|
|
Can these icons be used year round?
|
||
|
|
In the sample above the ``pride`` icons can be used all year while the ``easter`` ones cannot.
|
||
|
|
|
||
|
|
### ``start/end``
|
||
|
|
What is the start/end dates of the festival.
|
||
|
|
If the year is set to 0 then its for every year like the Pride one above.
|
||
|
|
Conversely if the year is filled in then it is only for that year, useful for moving festivals such as Easter
|
||
|
|
|
||
|
|
If there is no active festival then any icon can be chosen, taking``all_year`` into account.
|
||
|
|
|
||
|
|
## Adding new icons/Festivals
|
||
|
|
1. Fork this repo
|
||
|
|
2. Ensure that you have git and git-lfs installed.
|
||
|
|
3. Add the new logos/festivals
|
||
|
|
Image format:
|
||
|
|
* svg
|
||
|
|
* jpg
|
||
|
|
* png
|
||
|
|
* gif
|
||
|
|
4. Open a pull request
|