Wiki/wiki-rtd/docs/wiki_development/functions/add-splashes.md

66 lines
1.9 KiB
Markdown
Raw Normal View History

2024-02-14 07:43:31 +00:00
# RetroDECK Boot Splash / Logo
<img src="../../../wiki_images/logos/rd-esde-logo.svg" width="300">
## Main splash location
The main retrodeck splash is located in:
`/RetroDECK/res/splash.svg`
2024-02-14 07:46:57 +00:00
This is used at all times unless it is being overridden by the Easter Egg function.
2024-02-14 07:43:31 +00:00
## Easter Egg function
2024-02-14 07:46:57 +00:00
The Easter Egg function looks in the reference list and overrides the bootlogo with one of the .svg files from
2024-02-14 07:43:31 +00:00
2024-02-14 07:46:57 +00:00
`/RetroDECK/res/extra_splashes/`
2024-02-14 07:43:31 +00:00
## Easter Egg reference list
The reference list is located under:
`/RetroDECK/emu-configs/defaults/retrodeck/reference_lists/easter_egg_checklist.cfg`
The config is populated with references with dates and time on when the easter egg logo should show up in the following format with `^` as seperators.
Each new logo is added as a new line.
### Example
`MMDD^MMDD^HHMM^HHMM^<rd-logoname-splash.svg>`
The order is:
- Start Date: MMDD
- End Date: MMDD
- Start Time: HHMM
- End Time: HHMM
2024-02-14 07:59:22 +00:00
- The `rd-logoname-splash.svg` should match the exact filename under `/RetroDECK/res/extra_splashes/`
2024-02-14 07:43:31 +00:00
### Example rd-xmas-splash.svg
The `/RetroDECK//res/extra_splashes/rd-xmas-splash.svg` exists within the extra_splashes folder.
The xmas logo splash in the reference list
`1201^1231^0000^2359^rd-xmas-splash.svg`
It says that the logo: `rd-xmas-splash.svg`
Should be displayed between:
- The 1st December and 31 December
- Within the time of 0000 to 2359 aka 24 hours.
## How to add a new splash logo
1. Get a hold of the logo in .svg format and it should have a transparent background.
2. Rename the logo so it matches the rd-logoname-splash.svg name so if as an example you want to add Easter name it: rd-easter-splash.svg
2024-02-14 07:49:22 +00:00
3. Put the logo in `/RetroDECK/res/extra_splashes/`
2024-02-14 07:43:31 +00:00
4. Update the `reference_lists/easter_egg_checklist.cfg` above with a new line with the correct time and date format.
5. Change the date of your PC to when the logo is supposed to show up to make sure it is working.
6. Done