|
1 | | -# React-Frontend Plugin Template [](https://deckbrew.xyz/discord) |
| 1 | +# Junk Store plugin [](https://deckbrew.xyz/discord) |
| 2 | + |
| 3 | +This is a very simple plugin that builds it's content from a set of scripts. |
| 4 | + |
| 5 | +Place scripts.json in ~/homebrew/data/junk-store/ |
| 6 | + |
| 7 | +```js |
| 8 | +{ |
| 9 | + "init_script": "~/bin/plugin_init.sh", |
| 10 | + "content_dir": "~/Games/DOS-Games/", |
| 11 | + "scripts": [ |
| 12 | + { |
| 13 | + "TabName": "Dosbox", |
| 14 | + "get_game_details": "~/bin/get_game_details.sh", |
| 15 | + "save_config": "~/bin/save_config.sh", |
| 16 | + "get_config": "~/bin/get_config.sh", |
| 17 | + "install_game": "~/bin/install_game.sh", |
| 18 | + "get_game_data": "~/bin/get_game_data.sh", |
| 19 | + "plugin_init": "~/bin/plugin_init.sh" |
| 20 | + } |
| 21 | + ] |
| 22 | +} |
2 | 23 |
|
3 | | -Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) in a [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader) plugin. |
| 24 | +``` |
4 | 25 |
|
5 | | -### **Please also refer to the [wiki](https://wiki.deckbrew.xyz/en/user-guide/home#plugin-development) for important information on plugin development and submissions/updates. currently documentation is split between this README and the wiki which is something we are hoping to rectify in the future.** |
| 26 | +The reference scripts uses a python application to do all the heavy lifting, it uses [minicoda] |
| 27 | +(https://docs.conda.io/projects/miniconda/en/latest/) suffice to say that if you're going to follow |
| 28 | +a similar path you need to install it |
6 | 29 |
|
7 | | -## Developers |
| 30 | +The scripts are rather simple in the reference inplementation their content follows. |
8 | 31 |
|
9 | | -### Dependencies |
| 32 | +script_settings.sh |
10 | 33 |
|
11 | | -This template relies on the user having Node.js v16.14+ and `pnpm` (v8.5.1) installed on their system. |
12 | | -Please make sure to install pnpm v8.5.1 to prevent issues with CI during plugin submission. |
13 | | -`pnpm` can be downloaded from `npm` itself which is recommended. |
| 34 | +```bash |
| 35 | +#!/bin/bash |
| 36 | +$HOME/miniconda3/bin/conda init bash > /dev/null |
| 37 | +export SERVER=http://192.168.8.100:9000 |
| 38 | +export DOSCONF=$HOME/bin/dosbox-conf.py |
| 39 | +export DBFILE=$HOME/configs.db |
| 40 | +``` |
14 | 41 |
|
15 | | -#### Linux |
| 42 | +get_game_data.sh filter="search string" only-installed="true" showall="true" (used to limit results for efficiency) |
16 | 43 |
|
17 | 44 | ```bash |
18 | | - |
| 45 | +#/bin/bash |
| 46 | +source $HOME/bin/script_settings.sh |
| 47 | +TEMP=$($DOSCONF --getgameswithimages "${SERVER}/Images/MS-DOS/" "${1}" "${2}" "${3}" --dbfile $DBFILE) |
| 48 | + |
| 49 | +echo $TEMP |
19 | 50 | ``` |
20 | 51 |
|
21 | | -If you would like to build plugins that have their own custom backends, Docker is required as it is used by the Decky CLI tool. |
| 52 | +get_game_details.sh "shortname" |
22 | 53 |
|
| 54 | +```bash |
| 55 | +#/bin/bash |
| 56 | +source $HOME/bin/script_settings.sh |
| 57 | +TEMP=$($DOSCONF --getgamedata "${1}" "${SERVER}/Images/MS-DOS/" --dbfile $DBFILE) |
| 58 | + |
| 59 | +echo $TEMP |
| 60 | +``` |
23 | 61 |
|
| 62 | +install_game.sh shortname steamclientid |
24 | 63 |
|
25 | | -### Making your own plugin |
| 64 | +This installs the game, in this example the zipfile is downloaded from a local web server that contains all the content. You could easily change it to a local path and skip the wget if you have the content. |
| 65 | + |
| 66 | +```bash |
| 67 | +#!/bin/bash |
| 68 | +source $HOME/bin/script_settings.sh |
26 | 69 |
|
27 | | -If you use VSCode or it's derivatives (we suggest [VSCodium](https://vscodium.com/)!) just run the `setup` and `build` tasks. It's really that simple. |
| 70 | +$DOSCONF --addsteamclientid "${1}" "${2}" --dbfile $DBFILE |
28 | 71 |
|
29 | | -1. You can fork this repo or utilize the "Use this template" button on Github. |
30 | | -2. In your local fork/own plugin-repository run these commands: |
31 | | - 1. ``pnpm i`` |
32 | | - 2. ``pnpm run build`` |
33 | | - - These setup pnpm and build the frontend code for testing. |
34 | | -3. Consult the [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) repository for ways to accomplish your tasks. |
35 | | - - Documentation and examples are still rough, |
36 | | - - While decky-loader primarily targets Steam Deck hardware so keep this in mind when developing your plugin. |
37 | | -4. Run the `setup` and `build` and `deploy` vscode tasks, or you can derive your own makefile or just manually utilize the scripts for these commands as you see fit. |
| 72 | +ZIPFILE=$($DOSCONF --getzip "${1}" --dbfile $DBFILE) |
38 | 73 |
|
39 | | -If you use VSCode or it's derivatives (we suggest [VSCodium](https://vscodium.com/)!) just run the `setup` and `build` tasks. It's really that simple. |
| 74 | +mkdir -p $HOME/Games/sdos/ |
| 75 | +cd $HOME/Games/sdos/ |
| 76 | +URL="${SERVER}/eXo/eXoDOS/${ZIPFILE}" |
| 77 | +wget "${URL}" |
| 78 | +unzip -o "${ZIPFILE}" > /dev/null |
40 | 79 |
|
41 | | -#### Other important information |
| 80 | +TEMP=$($DOSCONF --launchoptions "/home/deck/bin/run_dosbox.sh" "${1}" "${HOME}/Games/sdos" --dbfile $DBFILE) |
| 81 | +echo $TEMP |
| 82 | +``` |
42 | 83 |
|
43 | | -Everytime you change the frontend code (`index.tsx` etc) you will need to rebuild using the commands from step 2 above or the build task if you're using vscode or a derivative. |
| 84 | +plugin_init.sh |
44 | 85 |
|
45 | | -Note: If you are receiving build errors due to an out of date library, you should run this command inside of your repository: |
| 86 | +Not used in the reference implemenation, but if the files are local you could serve them up using the built in web server by symlinking like this. |
46 | 87 |
|
47 | 88 | ```bash |
48 | | -pnpm update decky-frontend-lib --latest |
| 89 | +#!/bin/bash |
| 90 | +chmod 755 "${DECKY_PLUGIN_DIR}/dist/assets" |
| 91 | +ln -s "${HOME}/Games/DOS-games" "${DECKY_PLUGIN_DIR}/dist/assets/dos" |
49 | 92 | ``` |
50 | 93 |
|
51 | | -### Backend support |
| 94 | +run_dosbox.sh shortname |
52 | 95 |
|
53 | | -If you are developing with a backend for a plugin and would like to submit it to the [decky-plugin-database](https://github.com/SteamDeckHomebrew/decky-plugin-database) you will need to have all backend code located in ``backend/src``, with backend being located in the root of your git repository. |
54 | | -When building your plugin, the source code will be built and any finished binary or binaries will be output to ``backend/out`` (which is created during CI.) |
55 | | -If your buildscript, makefile or any other build method does not place the binary files in the ``backend/out`` directory they will not be properly picked up during CI and your plugin will not have the required binaries included for distribution. |
| 96 | +This generates the dosbox.conf file from a database and runs dosbox staging, in the future it will be able to run any installed and configured version of dosbox that is associated with shortname |
56 | 97 |
|
57 | | -Example: |
58 | | -In our makefile used to demonstrate the CI process of building and distributing a plugin backend, note that the makefile explicitly creates the `out` folder (``backend/out``) and then compiles the binary into that folder. Here's the relevant snippet. |
| 98 | +```bash |
| 99 | +#!/bin/bash |
| 100 | +source $HOME/bin/script_settings.sh |
59 | 101 |
|
60 | | -```make |
61 | | -hello: |
62 | | - mkdir -p ./out |
63 | | - gcc -o ./out/hello ./src/main.c |
| 102 | +$DOSCONF --conf $1 --dbfile $DBFILE |
| 103 | +/bin/flatpak run io.github.dosbox-staging |
64 | 104 | ``` |
65 | 105 |
|
66 | | -The CI does create the `out` folder itself but we recommend creating it yourself if possible during your build process to ensure the build process goes smoothly. |
| 106 | +save_config.sh shortname platform forkname version |
67 | 107 |
|
68 | | -Note: When locally building your plugin it will be placed into a folder called 'out' this is different from the concept described above. |
| 108 | +This saves the configuration from the config editor for a shortname, platform, fork and version |
69 | 109 |
|
70 | | -The out folder is not sent to the final plugin, but is then put into a ``bin`` folder which is found at the root of the plugin's directory. |
71 | | -More information on the bin folder can be found below in the distribution section below. |
| 110 | +```bash |
| 111 | +#!/bin/bash |
| 112 | +# Save the current configuration to a file |
| 113 | +source $HOME/bin/script_settings.sh |
72 | 114 |
|
73 | | -### Distribution |
| 115 | +cat | $DOSCONF --parsejson "${1}" --dbfile $DBFILE --platform "${2}" --forkname "${3}" --version "${4}" |
| 116 | +``` |
74 | 117 |
|
75 | | -We recommend following the instructions found in the [decky-plugin-database](https://github.com/SteamDeckHomebrew/decky-plugin-database) on how to get your plugin up on the plugin store. This is the best way to get your plugin in front of users. |
76 | | -You can also choose to do distribution via a zip file containing the needed files, if that zip file is uploaded to a URL it can then be downloaded and installed via decky-loader. |
| 118 | +get_config.sh shortname platform forkname version |
77 | 119 |
|
78 | | -**NOTE: We do not currently have a method to install from a downloaded zip file in "game-mode" due to lack of a usable file-picking dialog.** |
| 120 | +gets the json for a given fork/version of dosbox and poluates the games configs into it for the editor. |
79 | 121 |
|
80 | | -Layout of a plugin zip ready for distribution: |
81 | | -``` |
82 | | -pluginname-v1.0.0.zip (version number is optional but recommended for users sake) |
83 | | - | |
84 | | - pluginname/ <directory> |
85 | | - | | | |
86 | | - | | bin/ <directory> (optional) |
87 | | - | | | |
88 | | - | | binary (optional) |
89 | | - | | |
90 | | - | dist/ <directory> [required] |
91 | | - | | |
92 | | - | index.js [required] |
93 | | - | |
94 | | - package.json [required] |
95 | | - plugin.json [required] |
96 | | - main.py {required if you are using the python backend of decky-loader: serverAPI} |
97 | | - README.md (optional but recommended) |
98 | | - LICENSE(.md) [required, filename should be roughly similar, suffix not needed] |
99 | | -``` |
| 122 | +```bash |
| 123 | +#!/bin/bash |
| 124 | +# Save the current configuration to a file |
| 125 | +source $HOME/bin/script_settings.sh |
100 | 126 |
|
101 | | -Note regarding licenses: Including a license is required for the plugin store if your chosen license requires the license to be included alongside usage of source-code/binaries! |
| 127 | +cat | $DOSCONF --parsejson "${1}" --dbfile $DBFILE --platform "${2}" --forkname "${3}" --version "${4}" |
102 | 128 |
|
103 | | -Standard procedure for licenses is to have your chosen license at the top of the file, and to leave the original license for the plugin-template at the bottom. If this is not the case on submission to the plugin database, you will be asked to fix this discrepancy. |
| 129 | +``` |
| 130 | + |
| 131 | +## Developers |
104 | 132 |
|
105 | | -We cannot and will not distribute your plugin on the Plugin Store if it's license requires it's inclusion but you have not included a license to be re-distributed with your plugin in the root of your git repository. |
| 133 | +Eben Bruyns |
| 134 | +Beebls |
0 commit comments