diff --git a/storeInfo.md b/storeInfo.md new file mode 100644 index 0000000..bc9607b --- /dev/null +++ b/storeInfo.md @@ -0,0 +1,46 @@ +All UniStores must have one `storeInfo`, this tells Universal-Updater information about how to display the UniStore. Here's an example and explanation of a version 2 UniStore: + +```json +"storeInfo": { + "title": "Universal-DB", + "author": "Universal-Team", + "description": "Universal DB - An online database of 3DS and DS homebrew", + "file": "sdmc:/3ds/Universal-Updater/stores/Universal-DB.unistore", + "url": "https://db.universal-team.net/unistore/universal-db.unistore", + "sheet": "sdmc:/3ds/Universal-Updater/stores/Universal-DB.t3x", + "sheetURL": "https://db.universal-team.net/unistore/universal-db.t3x", + "authors": [ + "Universal-Team" + ], + "categories": [ + "utility" + ], + "consoles": [ + "3DS" + ], + "barDark": "#395472", + "barLight": "#395472", + "bgDark": "#262c4d", + "bgLight": "#60a8c0", + "boxDark": "#313131", + "boxLight": "#f7f7f7", + "outlineDark": "#f00000", + "outlineLight": "#f00000", + "textDark": "#ffffff", + "textLight": "#000000", + "version": 2 + "revision": 60, +} +``` + +- `title` is the name Universal-Updater will use for the UniStore +- `author` is the name of the creator of the UniStore +- `description` is the description of the UniStore Universal-Updater will show +- `file` is where the UniStore will be saved on the SD card, it's recommended to use the `sdmc:/3ds/Universal-Updater/stores` directory +- `url` is where the UniStore can be downloaded from for updating +- `sheet` is where the t3x sprite sheet for the UniStore's icons should be saved, it's recommended to use the `sdmc:/3ds/Universal-Updater/stores` directory +- `sheetURL` is where the t3x sprite sheet can be downloaded for updating +- `authors`, `categories`, and `consoles` are all arrays of all possible authors, categories, and consoles for use when searching +- The colors (with values of `#XXXXXX`) control the look of Universal-Updater while in the UniStore, there can be both dark and light themes, and anything left undefined will use the same user defined colors as the rest of Universal-Updater +- `version` is the version of the UniStore, this should always be `2` for the current version of Universal-Updater +- `revision` is the revision of the UniStore, this should be incremented each time its updated so Universal-Updater knows there's been an update \ No newline at end of file