Initial commit

docs/Covers.md

@@ -0,0 +1,16 @@
+# Covers
+Pico Launcher supports showing covers for any kind of file by placing `.bmp` files in the right folders.
+
+## Where to place covers
+Covers are placed in subfolders of the `/_pico/covers` folder.
+- The `/_pico/covers/nds` and `/_pico/covers/gba` folders contain DS and GBA covers, respectively, by game code. For example `ABCD.bmp`.
+- The `/_pico/covers/user` folder contains covers for specific file names. For example `myGame.nds.bmp` will be used for any file named `myGame.nds`. This takes precedence over a game code based cover. Since most consoles other than DS and GBA don't have game codes, this folder is suited to provide covers for games of other systems, for example NES or GB(C).
+
+## Cover format
+The covers should be 8 bpp (256 colors) `.bmp` files of 128x96 pixels.
+Only the top-left 106x96 pixels are used. The remaining part on the right is padding and is ignored.
+
+### Example
+Note how the black part on the right is not used.
+
+![Cover example](images/CoverExample.bmp)

docs/FileAssociations.md

@@ -0,0 +1,20 @@
+# File Associations
+Pico Launcher supports custom file associations for file extensions other than `.nds`.
+By setting up a file association, files with the specified extension will be opened using the specified DS application.
+The file path is passed via argv.
+
+## How to setup file associations
+1. Open `/_pico/settings.json`.
+2. If not present yet, add a `fileAssociations` key.
+3. For each file association add a key inside the `fileAssociations` key. For example:
+    ```json
+    "fileAssociations": {
+      "xyz": {
+        "appPath": "/path/to/xyz/app.nds"
+      },
+      "gba": {
+        "appPath": "/myGbaApp.nds"
+      }
+    }
+    ```
+    With this setup `.xyz` files will be opened by `/path/to/xyz/app.nds` and `.gba` files will be opened by `/myGbaApp.nds`.

docs/Themes.md

@@ -0,0 +1,57 @@
+# Themes
+Using themes, the look and feel of Pico Launcher can be customized. Themes are placed in subfolders of the `/_pico/themes` folder. For example `/_pico/themes/my_theme`.
+
+## JSON file
+Each theme has a `theme.json` file with information about the theme.
+
+- **type** - Type of theme. Currently `material` and `custom` are supported. See below for information about each type.
+- **name** - The name of the theme.
+- **description** - Description of the theme.
+- **author** - Author of the theme.
+- **primaryColor** - Material Design 3 primary color to use. `r`, `g` and `b` are provided in range 0-255.
+- **darkTheme** - When `true`, a dark Material Design 3 palette will be used.
+
+### Example
+```json
+{
+    "type": "material",
+    "name": "Theme name",
+    "description": "Theme description here.",
+    "author": "Author Name",
+    "primaryColor": {
+        "r": 149,
+        "g": 143,
+        "b": 237
+    },
+    "darkTheme": true
+}
+```
+
+## Material type
+![Horizontal display mode with custom theme](images/Horizontal.png)
+
+The `material` type theme is a pure Material Design 3 theme. It will be fully themed based on the `primaryColor` and `darkTheme` settings from the `theme.json`. In coverflow mode, this theme type uses a Material Design 3 style carousel.
+
+## Custom type
+![Horizontal display mode with custom theme](images/HorizontalCustom.png)
+
+The `custom` type theme is much more customizable, compared to the `material` type theme.
+Note that the `primaryColor` and `darkTheme` settings from the `theme.json` are still used to color some parts of the UI.
+
+The following additional files are needed:
+| Files                                                        | Size                 | Format                   | Description                                                    |
+|--------------------------------------------------------------|----------------------|--------------------------|----------------------------------------------------------------|
+| bannerListCell.bin<br>bannerListCellPltt.bin                 | 256x49 (209x49 used) | A3I5<br>32 color palette | Unselected item background for banner list mode.               |
+| bannerListCellSelected.bin<br>bannerListCellSelectedPltt.bin | 256x49 (209x49 used) | A3I5<br>32 color palette | Selected item background for banner list mode.                 |
+| bottombg.bin                                                 | 256x192              | 15 bpp bitmap            | Bottom screen background.                                      |
+| gridcell.bin<br>gridcellPltt.bin                             | 64x48 (48x48 used)   | A3I5<br>32 color palette | Unselected item background for grid modes.                     |
+| gridcellSelected.bin<br>gridcellPlttSelected.bin             | 64x48 (48x48 used)   | A3I5<br>32 color palette | Selected item background for grid modes.                       |
+| scrim.bin<br>scrimPltt.bin                                   | 8x42                 | A5I3<br>8 color palette  | Background for the toolbar. Intended to be a translucent fade. |
+| topbg.bin                                                    | 256x192              | 15 bpp bitmap            | Top screen background.                                         |
+
+These files can be created, for example, using [NitroPaint](https://github.com/Garhoogin/NitroPaint).
+
+The top screen background should include a box in which the banner text and icon of the selected item will be shown.
+
+## Background music
+All themes support background music by placing DSP-ADPCM encoded `.bcstm` files in a `bgm` folder inside the theme folder. Looping is supported. When multiple `.bcstm` files are provided, the background music will be selected at random each time Pico Launcher is started.

docs/Usage.md

@@ -0,0 +1,49 @@
+# Using Pico Launcher
+This document will outline the different settings and functionalities of Pico Launcher.
+
+## Pico Launcher interface
+When Pico Launcher is started, this is how your screen will look like.
+
+![Example screen](./images/Horizontal.png)
+
+From here you can browse your SD card to launch homebrew and games.
+
+- DPAD: Move the selector.
+- A: Open a folder, or to launch a homebrew or game.
+- B: Go to the parent folder or close a menu.
+- L and R: Scroll quickly when there are many items in a folder.
+
+The back arrow on the top left of the bottom screen can also be used to go up to the parent folder.
+
+Please note that touch functionality is not supported yet.
+
+## Settings menu
+The settings menu can be accessed by using the DPAD to move the selector to the cogwheel icon and pressing A. When in the settings menu, press the B button will to return to the file browser.
+
+![Settings menu](./images/SettingsPage.png)
+
+Currently, the only settings available are the display mode, and the sorting mode (More settings are available [in the settings file](#settings)). Here is how each layout looks like.
+
+<table>
+    <tr>
+        <th>Horizontal Grid</th>
+        <th>Vertical Grid</th>
+        <th>Banner List</th>
+        <th>Coverflow</th>
+    </tr>
+    <tr>
+        <td><img src="./images/Horizontal.png"/></td>
+        <td><img src="./images/Vertical.png"/></td>
+        <td><img src="./images/List.png"/></td>
+        <td><img src="./images/Coverflow.png"/></td>
+    </tr>
+</table>
+
+## Settings
+Settings are stored on your SD card in `/_pico/settings.json`. They can be edited with any text editor. The following settings are available:
+- `language` - Display language for Pico Launcher. Currently, only `english` is supported. Other languages may be supported later.
+- `romBrowserLayout` - Specified how folder contents are displayed. This setting can be changed in Pico Launcher directly.
+- `romBrowserSortMode` - Specified if folder contents should be sorted from A to Z (`NameAscending`), or from Z to A (`NameDescending`). This setting can be changed from within Pico Launcher.
+- `theme`: Specifies the folder name of the theme to use. If the theme cannot be found, a default fallback theme will be used.
+- `lastUsedFilePath` - Specifies the path of the most recently launched homebrew or game, such that it can be selected the next time Pico Launcher is started. It is automatically updated by Pico Launcher.
+- `fileAssociations` - See [FileAssociations.md](/LAUNCHER/docs/FileAssociations.md) for information about how to use this setting.