You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,10 +41,10 @@ PICO-8 powered games launcher for the [PeX Console](https://pex-labs.com/)
41
41
42
42
Download the pre-compiled release for your platform and unzip it. You will then find executables for all supported platforms. The `drive/` directory will be where the PICO-8 data files will be stored. For now, you can only run **PicoLauncher** from the same directory as the executables.
43
43
44
-
On windows, if your PICO-8 binary doesn't reside at the default location of `C:\\Program Files (x86)\\PICO-8\\pico8.exe`, you need to set the environment variable `PICO8_BINARY` before launching.
44
+
On windows, if your PICO-8 binary doesn't reside at the default location of `C:\Program Files (x86)\PICO-8\pico8.exe`, you need to set the environment variable `PICO8_BINARY` before launching.
45
45
```sh
46
46
set PICO8_BINARY=<path to pico8>
47
-
./picolauncher.exe
47
+
picolauncher.exe
48
48
```
49
49
50
50
On linux, if PICO-8 is not in your PATH, you need to set the environment variable as well.
@@ -57,6 +57,14 @@ PICO8_BINARY=<path to pico8>
57
57
58
58
To build from source, you need to have a [rust toolchain](https://www.rust-lang.org/tools/install) installed. To build **PicoLauncher** for all platforms, there is a provided build script at `dev/scripts/build_linux.sh` and `dev/scripts/build_windows.sh`. The built files are present in the `build_<platform>/` directory, as well as zipped up in `build_<platform>.zip`. This is the same build that is distributed in the pre-compiled release.
59
59
60
+
## Adding custom games
61
+
62
+
**p8tool** (name pending) is a utility cli that has a couple of useful functions to interact with cartridge files. The most useful of these is the ability for to add your own games to the launcher. It will generate metadata files and extract the music for the music app.
63
+
64
+
```sh
65
+
p8tool addcart <path to cart> --name <name of cart> --author <author of cart>
66
+
```
67
+
60
68
## Contributing
61
69
62
70
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details! Don't hesitate to report bugs and post feature requests!
0 commit comments