47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# pxl8
|
|
|
|
### Quick Start
|
|
|
|
```bash
|
|
./pxl8.sh build # Build pxl8 system
|
|
./pxl8.sh install # Install pxl8 binary to ~/.local/bin
|
|
./pxl8.sh run [game.cart | project_dir] # Run pxl8 demo (or a specific game)
|
|
./pxl8.sh run [game.cart | project_dir] --repl # Run pxl8 demo (or a specific game) with a REPL
|
|
```
|
|
**Note** The demo has keys 1-8 bound for different examples.
|
|
|
|
### Requirements
|
|
|
|
- **Clang 19+** (or GCC 15+) - Required for C23 `#embed` support
|
|
- **SDL3** - System package or auto-vendored
|
|
|
|
> [!WARNING]
|
|
> <strong>Heavy development. So... <em>here be dragons :3</em></strong>
|
|
|
|
<pre>
|
|
@@@@@@@@@@@@@@@@@@@@@**^^""~~~"^@@^*@*@@**@@@@@@@@@
|
|
@@@@@@@@@@@@@*^^'"~ , - ' '; ,@@b. ' -e@@@@@@@@@
|
|
@@@@@@@@*^"~ . ' . ' ,@@@@( e@*@@@@@@@@@@
|
|
@@@@@^~ . . ' @@@@@@, ~^@@@@@@@@@@@
|
|
@@@~ ,e**@@*e, ,e**e, . ' '@@@@@@e, "*@@@@@'^@
|
|
@',e@@@@@@@@@@ e@@@@@@ ' '*@@@@@@ @@@' 0
|
|
@@@@@@@@@@@@@@@@@@@@@',e, ; ~^*^' ;^~ ' 0
|
|
@@@@@@@@@@@@@@@^""^@@e@@@ .' ,' .' @
|
|
@@@@@@@@@@@@@@' '@@@@@ ' , ,e' . ;@
|
|
@@@@@@@@@@@@@' ,&&, ^@*' , . i^"@e, ,e@e @@
|
|
@@@@@@@@@@@@' ,@@@@, ; ,& !,,@@@e@@@@ e@@
|
|
@@@@@,~*@@*' ,@@@@@@e, ', e^~^@, ~'@@@@@@,@@@
|
|
@@@@@@, ~" ,e@@@@@@@@@*e*@* ,@e @@""@e,,@@@@@@@@@
|
|
@@@@@@@@ee@@@@@@@@@@@@@@@" ,e@' ,e@' e@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@@" ,@" ,e@@e,,@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@~ ,@@@,,0@@@@@@@@@@@@@@@@@@@
|
|
@@@@@@@@@@@@@@@@@@@@@@@@,,@@@@@@@@@@@@@@@@@@@@@@@@@
|
|
</pre>
|
|
|
|
## License
|
|
|
|
pxl8 is free and open source! All code in this repository is licensed under:
|
|
|
|
- Mozilla Public License, Version 2.0 ([LICENSE](LICENSE) or https://mozilla.org/MPL/2.0/)
|
|
|
|
Third-party dependencies (Fennel, linenoise, log.c, LuaJIT, miniz, SDL3) retain their original licenses.
|