Skip to content

Commit f8f8b96

Browse files
add cart utility
1 parent 323544f commit f8f8b96

File tree

8 files changed

+2062
-6
lines changed

8 files changed

+2062
-6
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ PICO-8 powered games launcher for the [PeX Console](https://pex-labs.com/)
4141

4242
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.
4343

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.
4545
```sh
4646
set PICO8_BINARY=<path to pico8>
47-
./picolauncher.exe
47+
picolauncher.exe
4848
```
4949

5050
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>
5757

5858
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.
5959

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+
6068
## Contributing
6169

6270
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details! Don't hesitate to report bugs and post feature requests!
@@ -72,5 +80,6 @@ Pre-bundled games
7280
- [oblivion eve](https://www.lexaloffle.com/bbs/?pid=142641)
7381
- [pico night punkin'](https://www.lexaloffle.com/bbs/?tid=42715)
7482
- [poom](https://www.lexaloffle.com/bbs/?pid=101541)
83+
- [suika game demake](https://www.lexaloffle.com/bbs/?tid=54642)
7584
- [swordfish](https://www.lexaloffle.com/bbs/?tid=31141)
7685

0 commit comments

Comments
 (0)