wiki

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

@@ -0,0 +1,63 @@
+# 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`
+
+## Easter Egg function
+
+The Easter Egg function looks in the reference lists and overrides the bootlogo with one from
+
+`/RetroDECK//res/extra_splashes/`
+
+## 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
+- The `rd-logoname-splash.svg` should match the exact filename under `/RetroDECK//res/extra_splashes/`
+
+
+
+### 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
+3. Put the logo in `/RetroDECK//res/extra_splashes/`
+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

wiki-rtd/docs/wiki_general/beta-period.md

@@ -28,7 +28,7 @@ Since the beta is the actual mainline that is in fact the stable version, the co
 
 - A list of issues and missing features can be found over at: [Known Issues](../wiki_bugs/known-issues.md)
 
-- To see what we are developing on currently check out: [What are you working on?](../wiki_development/what-are-you-working.on.md)
+- To see what we are developing on currently check out: [What are you working on?](../wiki_development/general/what-are-you-working.on.md)
 
 
 

wiki-rtd/docs/wiki_general/faq.md

@@ -93,7 +93,7 @@ Yes, you can reset various parts of the software using the RetroDECK Configurato
 Read more on: [RetroDECK Configurator 🛠️](../wiki_general/configurator.md)
 
 Or if you want to reset from CLI you can read up on:<br>
-`Development 🖥️` - [CLI Guide](../wiki_development/cli-guide.md)
+`Development 🖥️` - [CLI Guide](../wiki_development/general/cli-guide.md)
 
 
  <br>

wiki-rtd/docs/wiki_rd_versions/version_0.8b/0.8.0b.md

@@ -7,7 +7,3 @@ The upcomming major update to RetroDECK
 ## New Features
 
 We are working on it, check back here at a later date!
-
-[What are you working on?](../../wiki_development/what-are-you-working.on.md)
-
-(Note not all of the stuff we are working on is in the 0.8b update)

wiki-rtd/mkdocs.yml

@@ -55,7 +55,7 @@ nav:
     - The RetroDECK Beta: wiki_general/beta-period.md
     - The FAQ ❔:  wiki_general/faq.md
     - Version History (Patchnotes): wiki_rd_versions/version-history.md
-    - What are you working on?: wiki_development/what-are-you-working.on.md
+    - What are you working on?: wiki_development/general/what-are-you-working.on.md
 
   - About RetroDECK 📖:
     - The Team & Credits: wiki_about/team-credits.md
@@ -268,6 +268,9 @@ nav:
   - Development 🧪:
     - Flatpak 📦:
       - About Flatpak: wiki_development/flatpak/retrodeck-flatpak.md
-    - Folders and Filepaths: wiki_development/folders-filepaths.md
+    - General:
-    - CLI Guide: wiki_development/cli-guide.md
+      - Folders and Filepaths: wiki_development/general/folders-filepaths.md
-    - Development Notes: wiki_development/general-development.md
+      - CLI Guide: wiki_development/general/cli-guide.md
+      - Development Notes: wiki_development/general/general-development.md
+    - Functions:
+      - Add Boot Splashes: wiki_development/functions/add-splashes.md