jaby
/
jabyengine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Update readme again

This commit is contained in:
Jaby 2024-12-31 19:54:44 +01:00
parent 6dfb9106e3
commit 8b2ab62640
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
readme.md
View File

@ -1,7 +1,10 @@
- [JabyEngine](#jabyengine) - [JabyEngine](#jabyengine)
- [About](#about) - [About](#about)
- [How to build](#how-to-build) - [How to build](#how-to-build)
- [Building JabyEngine (without VSCode)](#building-jabyengine-without-vscode) - [Building `JabyEngine` (without VSCode)](#building-jabyengine-without-vscode)
- [Building support library (without VSCode)](#building-support-library-without-vscode)
- [`FontWriter` (without VSCode)](#fontwriter-without-vscode)
- [Building `PoolBox` (without VSCode)](#building-poolbox-without-vscode)
- [Media creators](#media-creators) - [Media creators](#media-creators)
- [JabyEngine](#jabyengine-1) - [JabyEngine](#jabyengine-1)
- [PoolBox](#poolbox) - [PoolBox](#poolbox)
@ -18,12 +21,27 @@ The following environment variables should be set:
* `JABY_ENGINE_PATH`: The path to the root folder of this repo * `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. * `PSX_LICENSE_PATH`: The path to a folder containing the PS1 licenses for generating a CD.
### Building JabyEngine (without VSCode) ### Building `JabyEngine` (without VSCode)
`make` requires the following values to be passed: `make` requires the following values to be passed:
* `BUILD_PROFILE`: `debug`/`release` * `BUILD_PROFILE`: `debug`/`release`
* `PSX_TV_FORMAT`: `PAL`/`NTSC` * `PSX_TV_FORMAT`: `PAL`/`NTSC`
* `CUSTOM_CONFIG`: Empty or folder name under `./config` * `CUSTOM_CONFIG`: Empty or folder name under `./config`
### Building support library (without VSCode)
These projects shall eventually turn into useful extensions for the engine. So far they are more tests then proper code. However `PoolBox` is depended on `FontWriter`.
#### `FontWriter` (without VSCode)
`make` requires the following values to be passed:
* `BUILD_PROFILE`: `debug`/`release`
### Building `PoolBox` (without VSCode)
`PoolBox` is the one and only example project so far.
`make` requires the following values to be passed:
* `BUILD_PROFILE`: `debug`/`release`
* `REGION`: `SCEE`/`SCEA`/`SCEI`
* `CUSTOM_CONFIG`: Empty or folder name under `$(JABY_ENGINE_PATH)/config`
# Media creators # Media creators
## JabyEngine ## JabyEngine
| Art | Author | | Art | Author |