Xargon/Wiki
1
0
Fork 0
mirror of https://github.com/RetroDECK/Wiki.git synced 2024-12-04 19:45:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated guide for eastereggs splash

Browse source
This commit is contained in:
laz 2024-12-04 11:01:48 +01:00
parent 52bde1957e
commit b28f4cdb32
1 changed files with 30 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
wiki-rtd/docs/wiki_development/functions/easter-egg-splashes.md
View file

@ -12,67 +12,41 @@ This is used at all times unless it is being overridden by the Easter Egg functi
## Easter Egg function
The function is part of the [functions/functions.sh](https://github.com/XargonWan/RetroDECK/blob/main/functions/functions.sh) shell script.
The function is part of the [config/retrodeck/reference_lists/features.json](https://github.com/RetroDECK/RetroDECK/blob/cooker/config/retrodeck/reference_lists/features.json) json.
The `easter_eggs()` function looks in the reference list and overrides the bootlogo with one of the .svg files from the referense list.
Decription of the function:
The `splash_screens"` looks in the reference .svg files under: [res/extra_splashes/](https://github.com/XargonWan/RetroDECK/blob/main/res/extra_splashes/) and overrides the bootlogo with one of the .svg files from the referense list.
```
easter_eggs() {
# This function will replace the RetroDECK startup splash screen with a different image if the day and time match a listing in easter_egg_checklist.cfg
# The easter_egg_checklist.cfg file has the current format: $start_date^$end_date^$start_time^$end_time^$splash_file
# Ex. The line "1001^1031^0000^2359^spooky.svg" would show the file "spooky.svg" during any time of day in the month of October
# The easter_egg_checklist.cfg is read in order, so lines higher in the file will have higher priority in the event of an overlap
# USAGE: easter_eggs
name_of_holiday": {
"new_year": {
"start_date": "MMDD",
"end_date": "MMDD",
"start_time": "MMDD",
"end_time": "MMDD",
"filename": "placeholder.svg"
```
The `easter_eggs()` function is as a part of the `start_retrodeck()` bootup function.
## Easter Egg reference list
**Example:**
The reference list is located under:
```
"splash_screens": {
"new_year": {
"start_date": "1231",
"end_date": "0106",
"start_time": "0000",
"end_time": "2359",
"filename": "newyear.svg"
},
"chinese_new_year": {
"start_date": "0209",
"end_date": "0212",
"start_time": "0000",
"end_time": "2359",
"filename": "rd-lunar-snake-splash.svg"
},
```
[emu-configs/defaults/retrodeck/reference_lists/easter_egg_checklist.cfg](https://github.com/XargonWan/RetroDECK/blob/main/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 splash should show up in the following format with `^` as seperators.
Each new splash 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
- The `rd-logoname-splash.svg` should match the exact filename under [res/extra_splashes](https://github.com/XargonWan/RetroDECK/tree/main/res/extra_splashes)
### Example rd-xmas-splash.svg
The [res/extra_splashes/rd-xmas-splash.svg](https://github.com/XargonWan/RetroDECK/blob/main/res/extra_splashes/rd-xmas-splash.svg) is the xmas splash screen.
The xmas 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
3. Put the logo in [extra_splashes](https://github.com/XargonWan/RetroDECK/tree/main/res/extra_splashes)
4. Update the [easter_egg_checklist.cfg](https://github.com/XargonWan/RetroDECK/blob/main/emu-configs/defaults/retrodeck/reference_lists/easter_egg_checklist.cfg) with new information.
5. Change the date of your PC to when the logo is supposed to show up to make sure it is working.
6. Done
Here we show both the New Year and Lunar New Year