Update readme

This commit is contained in:
jaby 2024-12-31 19:22:26 +01:00
parent 2f0197ad08
commit a0091585f9
1 changed files with 29 additions and 30 deletions

View File

@ -1,5 +1,28 @@
# Rust bla - [JabyEngine](#jabyengine)
* `cargo install cargo-edit` - [About](#about)
- [How to build](#how-to-build)
- [Building JabyEngine (without VSCode)](#building-jabyengine-without-vscode)
- [Media creators](#media-creators)
- [JabyEngine](#jabyengine-1)
- [PoolBox](#poolbox)
- [Special thanks](#special-thanks)
# JabyEngine
## About
JabyEngine is my personal attempt to eventually make my own PS1 game from "ground up". Originally I didn't indented to release this code publicly but recently I decided to give it a try. If you read this, thank you!
## How to build
JabyEngine relies on linux to be build. For Windows users it uses `wsl` instead but support for it might get dropped during further development.
The following environment variables should be set:
* `JABY_ENGINE_PATH`: The path to the root folder of this repo
* `PSX_LICENSE_PATH`: The path to a folder containing the PS1 licenses for generating a CD.
### Building JabyEngine (without VSCode)
`make` requires the following values to be passed:
* `BUILD_PROFILE`: `debug`/`release`
* `PSX_TV_FORMAT`: `PAL`/`NTSC`
* `CUSTOM_CONFIG`: Empty or folder name under `./config`
# Media creators # Media creators
## JabyEngine ## JabyEngine
@ -24,31 +47,7 @@
| `examples\PoolBox\assets\audio\OnMyOwn_BailBonds.mp3` | `On My Own` by Bail Bonds | | `examples\PoolBox\assets\audio\OnMyOwn_BailBonds.mp3` | `On My Own` by Bail Bonds |
# Special thanks # Special thanks
* Cody the white tiger
* Nicolas Noble
# Compatibility * Pyravia
* PS1 * Sickle
* Emulator
- [X] Duckstation
- [X] No$PSX
- [X] Xebra
- [ ] Real Hardware
- PS3
- [ ] Emulator
- [ ] Real Hardware
# TODO
- [ ] Ko-fi supporter list
- [ ] Support more GTE
- [X] Easy serial code swap
- [X] Support .subst files to be substituted with environment variables
- [X] Support pop-fe
- [ ] PS3 PKG generation tool?
- [ ] PS3 runtime detection?
- [ ] Move DMA code to public include for custom loading of files?
- [ ] Maybe make it an interface with SPU/GPU as a specification...?
- [ ] Could be empty classes that the linker maps to 0 or somewhere
- [ ] Could be a all static struct (I like that better; We are not Nicolas Noble)
- [ ] Redo the IO ports again...?
- [ ] Support better file loading with threads
- [ ] Loading Screen with GPU IO? (Does DMA and IO work together?)