Merge pull request #38 from chrizzo-hb/main

Introduced customization section

Author: chrizzo-hb

docs/configure/customization/background-music.md

@@ -0,0 +1,11 @@
+# :material-folder-music-outline: Background Music
+
+Your [userdata folder](../../../play/add-games/game-storage) contains a folder called `music`. If you store any compatible music files in this folder, the music will **replace** the original background music that comes with KNULLI. Instead of the built-in background music, KNULLI will now play the songs from your `music` folder while you are browsing your games in EmulationStation.
+
+!!! info "Make sure your music files are compatible"
+
+    Background music for KNULLI/EmulationStation should be in `MP3` or `OGG` format and have a sample rate of 44100Hz and a bitrate of 256kb/s max.
+
+When adding your background music, you can either dump all your songs randomly into the `music` folder or create subfolders for each **system** if you want to add **system-specific music** for all the systems you like to play. If you want to add your music per system, you should **not** leave any music files in the top level of the `music` folder but sort all your music **by system**. The system names in the `music` folder correspond to the system names in the `roms` folder (e.g., `snes` for SNES, `megadrive` for Mega Drive/Genesis).
+
+Once you added your music, press ++"Start"++ to bring up the main menu and head to *Sound Settings*. Here you can toggle *Frontend music* on and off. Additionally, you can set up volume, title display duration, and you can also set up whether you want your music selection to be played per system or not.

docs/configure/bezel-decorations.md docs/configure/customization/bezel-decorations.md

@@ -25,7 +25,7 @@ Some bezels which were originally created by [drkhrse](https://github.com/drkhrs
     * or just clicking [here](https://github.com/nvitaterna/batocera_4_3_handheld_bezels/archive/refs/heads/main.zip).
 * unzip the file (e.g. with [7-Zip](https://7-zip.org/)).
 * find the `batocera_4_3_handheld_bezels` folder **inside** the `decorations` folder you just unzipped.
-* copy the **entire** `batocera_4_3_handheld_bezels` folder into the `decorations` folder of your  [userdata folder](../../play/add-games/game-storage).
+* copy the **entire** `batocera_4_3_handheld_bezels` folder into the `decorations` folder of your  [userdata folder](../../../play/add-games/game-storage).
 
 The bezel pack should now be installed and ready to use. However, to apply it, you have to set it up as explained in the [Apply bezel decorations](#apply-bezel-decorations) section.
 

docs/configure/customization/bootlogo.md

@@ -0,0 +1,16 @@
+# :material-image-sync-outline: Boot Logo
+   
+For a wholesome KNULLI experience, you may want to replace your boot logo to match the style of your theme. The KNULLI boot logo is stored on your primary SD card, on the `batocera` partition. If you want to replace your boot logo, simply follow the steps below.
+
+* Create a new **bitmap** file (`bootlogo.bmp`) that has the exact **same resolution** as your built-in display (e.g. 640x480 for the Anbernic RG35XX Plus/H/SP/2024 series)
+* Shut down your KNULLI device
+* Eject the primary SD card from your KNULLI device and insert it into your computer
+* Find the `batocera` partition on your SD card (and, if you are using Windows, **ignore** any warnings about broken/unformatted drives!)
+* Locate `bootlogo.bmp` on your `batocera` partition and replace it with your new boot logo
+    * (You might want to back up the original file before you replace it)
+* Eject the SD card from your computer and put it back into your KNULLI device
+* Turn on your KNULLI device and enjoy your custom boot logo
+
+!!! info "Boot logo and splash screen"
+
+    The **boot logo** is an image which is displayed while KNULLI is booting, from the moment the device is turned on until the moment EmulationStation is launched. The EmulationStation **splash screen** is displayed while EmulationStation is loading, scanning for games, or shutting down. The **splash screen** is controlled by the **theme** of your KNULLI installation - learn how to customize it in the [Themes](../themes) section. the **boot logo** on the other hand is part of the boot partition KNULLI is installed on.

docs/configure/customization/index.md

@@ -0,0 +1,8 @@
+# :material-palette-outline: Customization
+
+KNULLI comes with a lot of options to customize your gaming experience and make your KNULLI-driven device truly your own.
+
+* You can **customize** the default KNULLI theme (including its **Splash screen**) or install different themes as explained in the [Themes](themes) section
+* You can add your own **background music** as explained in the [Background Music](background-music) section
+* You can install your preferred **bezel decorations** as explained in the [Bezel Decorations](bezel-decorations) section
+* You can replace the **boot logo** with a different image as explained in the [Boot Logo](bootlogo) section

docs/configure/themes.md docs/configure/customization/themes.md

@@ -29,6 +29,7 @@ The following options can be changed directly from the main menu under `User Int
 | Game Metadata | Sets if metadata (e.g. description, release date, etc...) should be displayed for a game | `On`, `Off` |
 | Font Size | Set the size for text elements throughout the theme. | `Default`, `Small`, `Large` |
 | Color Scheme | Sets the color scheme that is used for the theme.  There is a set of prebuilt color schemes that you can select and an option to supply your custom color scheme (selected by choosing `custom`). You can see details on customizations below under [Customization](#customization). | `Default`, `Light`, `Steam OS`, `SNES`, `Famicom`, `DMG`, `OLED`, `Custom` |
+| Splash Screen | Toggles an optional custom splash screen which will be displayed when EmulationStation is loading and/or scanning for ROMs. | `Default`, `Custom` |
 
 ### Additional UI Settings 
 
@@ -79,6 +80,14 @@ The artwork used on the system view can be customized with your own images.
     * `${system.theme}.png/jpg` should be named for the system you are looking to override. For example if you wanted to override the artwork for `snes` you would create an image called `snes.png` or `snes.jpg` in the artwork folder.
 * Once your images are in place you turn on custom images by changing the `System Artwork` setting to `Custom (Fullscreen)`
 
+#### Splash Screen
+
+* Upload your image to the folder you created above
+* It can be named:
+    * `splash.png`
+    * `splash.jpg`
+* One your image is in place you turn on your splash screen by changing `Splash Screen` to `Custom`
+
 ### Color Schemes
 
 You can create your own custom color scheme to use for the theme

mkdocs.yml

@@ -144,7 +144,11 @@ plugins:
             Configure: Konfiguration
             Networking: Netzwerkverbindungen
             Unbranded: Ohne Marke
+            Customization: Personalisieren
+            Themes: Themes
+            Background Music: Hintergrundmusik
             Bezel Decorations: Bezel-Dekorationen
+            Boot Logo: Bootlogo
         - locale: pl
           name: Polski
           build: true
@@ -261,8 +265,12 @@ nav:
       - Networking: configure/networking.md
       - Controls: configure/controls.md
       - Collections: configure/collections.md
-      - Bezel Decorations: configure/bezel-decorations.md
-      - Themes: configure/themes.md
+      - Customization:
+        - Customization: configure/customization/index.md
+        - Themes: configure/customization/themes.md
+        - Background Music: configure/customization/background-music.md
+        - Bezel Decorations: configure/customization/bezel-decorations.md
+        - Boot Logo: configure/customization/bootlogo.md
       - SSH: configure/ssh.md
       - Retroarch:
         - Controls: configure/retroarch/controls.md