Update readme again

.gitattributes

@@ -1,3 +1,4 @@
 *.xa filter=lfs diff=lfs merge=lfs -text
 *.wav filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text

docs/Bugs/observed_bugs.md

@@ -0,0 +1,6 @@
+# Observed bugs
+- [Observed bugs](#observed-bugs)
+  - [Deadlock](#deadlock)
+
+## Deadlock
+It was observed in `PoolBox` when loading the `FontCycler` overlay that a deadlock occurred. This error has not been observed since. The current theory is that accidentally an old save state in the emulator was loaded.

docs/Features/auto_lba.md

@@ -1,68 +1,40 @@
 # Auto LBA
-
+- [Auto LBA](#auto-lba)
-## Table of Contents
   - [In Code](#in-code)
-  - [Overlay](#overlay)
-  - [Main file](#main-file)
   - [For CD generation](#for-cd-generation)
 
-To support the `Auto LBA` feature changes need to be applied to the source files and the CD configuration file. The changes for the source files depend on if they are an Overlay or part of the main executable.
+To support the `Auto LBA` feature changes need to be applied to the source files and the CD configuration file.
-
----
 
 ## In Code
-To use the `Auto LBA` feature the LBAs first need to be defined in either an `enum` or `enum struct`. These need to fit a special pattern.
+To use the `Auto LBA` feature the LBAs first need to be defined in either an `enum` or `enum struct`. These need to fit a special pattern. The usage of a `namespace` is recommended.
 
 `__jabyengine_start_lba_request` needs to be the first entry while `__jabyengine_end_lba_request` needs to be the last. Each LBA entry needs to be declared with `__jabyengine_request_lba_for` followed by the name for the enum entry and the file path on the disk. 
 
 ```c++
-#include <PSX/AutoLBA/auto_lba.hpp>
+namespace Assets {
-
     enum LBA {
         __jabyengine_start_lba_request
         __jabyengine_request_lba_for(SYSTEM_CNF, "SYSTEM.CNF"),
         __jabyengine_end_lba_request
     };
-```
-
-### __Overlay__
-For use with Overlays you need to include the related header file. You must place this include into the Namespace of your overlay to avoid name clash. Now the `lba` array is accessible.
-
-```c++
-namespace Overlay {
-    #include <PSX/Overlay/overlay_declaration.hpp>
-    
-    // ...
-    printf("LBA: %i, Words: %i\n", lba[LBA::SYSTEM_CNF].lba, lba[LBA::SYSTEM_CNF].size_words);
-    // ...
-
-    __declare_overlay_header(execute, LBA);
-}
-```
-
-### __Main file__
-For use with the main file you need to include the header file and use the `__declare_lba_header` macro with the name of your enum to create the LBA area in any file. The header allows to access the `lba` array with your enum as the index.
-
-```c++
-#include <PSX/AutoLBA/auto_lba_declaration.hpp>
-
-// ...
-printf("LBA: %i, Words: %i\n", lba[LBA::SYSTEM_CNF].lba, lba[LBA::SYSTEM_CNF].size_words);
-// ...
-
     __declare_lba_header(LBA);
+
+    namespace {
+        void load() {
+            printf("LBA: %i, Words: %i\n", lba[LBA::SYSTEM_CNF].lba, lba[LBA::SYSTEM_CNF].size_words);
+        }    
+    }
+}
 ```
 
 ## For CD generation
 To automatically fill the LBA values `psxcdgen_ex` needs to be used.
-
+The attribute `lba_source` automatically fills in the values. It can be used with the XML `Main` and `Overlay` tag.
-For the main file the special XML type `Main` needs to be used while specifing the LBA file being used.
-
-For Overlays the instruction will follow...
 
 ```xml
 <Track>
     <File    name = "SYSTEM.CNF">System.cnf</File>
-    <Main name="SCES_XXX.XX" lba_source="main.cpp">Application.psexe</Main>
+    <Main    name = "%PSX_BOOT_FILE%" lba_source = "main.cpp">Application.psexe</Main>
+    <Overlay name = "OVL.BIN"         lba_source = "state.cpp">Overlay.state</Overlay>
 </Track>
 ```

docs/docs.md

@@ -1,7 +1,14 @@
 # JabyEngine Documentation
-
+- [JabyEngine Documentation](#jabyengine-documentation)
-## Table of Contents
   - [Features](#features)
----
+  - [Known limitations](#known-limitations)
+  - [Observed bugs](#observed-bugs)
+
 ## Features
 - [Auto LBAs](./Features/auto_lba.md)
+
+## Known limitations
+- Insufficient documentation
+
+## Observed bugs
+- [Observed bugs](./Bugs/observed_bugs.md)

examples/PoolBox/.gitignore

@@ -5,4 +5,3 @@
 *.o
 *.lba
 **/bin
-**/audio/temp/*

examples/PoolBox/application/src/application.cpp

@@ -206,8 +206,8 @@ namespace NormalScene {
         FontWriter::new_font_writer.write(cursor.change_position(Make::PositionI16((GPU::Display::Width-VersionLength)/2, 16 + DefaultFont::Info.get_kern_size().height)), Version, GPU::Color24::Green(0xD0), &FontWriter::wiggle);
         menu.update(FontWriter::bios_font_writer, cursor, Make::PositionI16(8, 64));
 
-        cursor.change_position(Make::PositionI16(doener_fish.position.x + doener_fish.size.width, GPU::Display::Height - 32));
+        cursor.change_position(Make::PositionI16(doener_fish.position.x + doener_fish.size.width, GPU::Display::Height - 48));
-        FontWriter::bios_font_writer.write(cursor, "Audio:\n%s", cd_player.is_xa ? "CD-XA" : "CD-DA");
+        FontWriter::bios_font_writer.write(cursor, "Audio:\n%s\n(SEL/R1/R2)", cd_player.is_xa ? "CD-XA" : "CD-DA");
 
         if(Shared::load_test) {
             // Force state change if we are in the load_test state

examples/PoolBox/assets/Makefile

@@ -7,7 +7,7 @@ CLUT_4_COLOR_TRANS_FLAGS = simple-tim clut4 --color-trans
 # Ressources to convert
 ## Music tracks
 INPUT += $(OUTPUT_DIR)/Evacuation_cdda.xa 
-INPUT += $(OUTPUT_DIR)/fox.xa
+INPUT += $(OUTPUT_DIR)/OnMyOwn_BailBonds.xa
 INPUT += $(OUTPUT_DIR)/apple.vag
 INPUT += $(OUTPUT_DIR)/blubb-mono.vag
 INPUT += $(OUTPUT_DIR)/Friendship_samp.vag
@@ -40,14 +40,14 @@ IMG_6921_TIM_FLAGS = tim full16 --clut-pos {384,255} --tex-pos {384,256}
 INPUT               += $(OUTPUT_DIR)/AllTheJaby.tim
 AllTheJaby_TIM_FLAGS = tim full16 --tex-pos {0,0}
 
-$(OUTPUT_DIR)/fox.xa: audio/temp/fox.wav
+$(OUTPUT_DIR)/%.vag: audio/%.wav
-	@mkdir -p $(OUTPUT_DIR)
-	psxfileconv $< -o $@ xa
-
-$(OUTPUT_DIR)/%.vag: audio/temp/%.wav
 	@mkdir -p $(OUTPUT_DIR)
 	psxfileconv --lz4 $< -o $@ vag
 
+$(OUTPUT_DIR)/OnMyOwn_BailBonds.xa: audio/OnMyOwn_BailBonds.mp3
+	@mkdir -p $(OUTPUT_DIR)
+	psxfileconv $< -o $@ xa
+
 $(OUTPUT_DIR)/%.xa: audio/%.wav
 	@mkdir -p $(OUTPUT_DIR)
 	psxfileconv $< -o $@ xa

examples/PoolBox/iso/Config.xml

@@ -47,7 +47,7 @@
         <Directory name = "XAAUDIO" hidden = "true">
             <InterleavedFile name = "MIX.XA">
                 <Channel>../assets/bin/Evacuation_cdda.xa</Channel>
-                <Channel>../assets/bin/fox.xa</Channel>
+                <Channel>../assets/bin/OnMyOwn_BailBonds.xa</Channel>
             </InterleavedFile>
         </Directory>
         <Directory name = "SFX" hidden = "true">
@@ -56,5 +56,5 @@
             <File name = "FRIEND.VAG" lz4 = "already">../assets/bin/Friendship_samp.vag</File>
         </Directory>
     </Filesystem>
-    <AudioTrack align = "true">../assets/audio/temp/breaking.wav</AudioTrack>
+    <AudioTrack align = "true">../assets/audio/jlbrock44_Three_Kings_Funk_cdda_ready.wav</AudioTrack>
 </PSXCD>

include/PSX/Overlay/overlay_declaration.hpp

@@ -1,8 +0,0 @@
-#pragma once
-
-// No include here because this header should be included in a namespace and we don't want multiple namespace definitions of OverlayHeader and OverlayLBA
-
-#include "../AutoLBA/auto_lba_declaration.hpp"
-
-#define __declare_overlay_header(function, enum_struct) \
-__declare_lba_header(enum_struct)

readme.md

@@ -1,26 +1,71 @@
-# Compatibility
+- [JabyEngine](#jabyengine)
-* PS1 
+  - [About](#about)
-  * Emulator
+  - [How to build](#how-to-build)
-    - [X] Duckstation
+    - [Building `JabyEngine` (without VSCode)](#building-jabyengine-without-vscode)
-    - [X] No$PSX
+    - [Building support library (without VSCode)](#building-support-library-without-vscode)
-    - [X] Xebra
+      - [`FontWriter` (without VSCode)](#fontwriter-without-vscode)
-  - [ ] Real Hardware
+    - [Building `PoolBox` (without VSCode)](#building-poolbox-without-vscode)
-- PS3 
+- [Media creators](#media-creators)
-  - [ ] Emulator
+  - [JabyEngine](#jabyengine-1)
-  - [ ] Real Hardware
+  - [PoolBox](#poolbox)
+- [Special thanks](#special-thanks)
 
-# TODO
+# JabyEngine
-- [ ] Ko-fi supporter list
+## About
-- [ ] Support more GTE
+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! 
-- [X] Easy serial code swap
+
-  - [X] Support .subst files to be substituted with environment variables 
+## How to build
-  - [X] Support pop-fe
+JabyEngine relies on linux to be build. For Windows users it uses `wsl` instead but support for it might get dropped during further development.
-- [ ] PS3 PKG generation tool?
+
-- [ ] PS3 runtime detection?
+The following environment variables should be set:
-- [ ] Move DMA code to public include for custom loading of files?
+* `JABY_ENGINE_PATH`: The path to the root folder of this repo
-  - [ ] Maybe make it an interface with SPU/GPU as a specification...?
+* `PSX_LICENSE_PATH`: The path to a folder containing the PS1 licenses for generating a CD.
-  - [ ] 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)
+### Building `JabyEngine` (without VSCode)
-  - [ ] Redo the IO ports again...?
+`make` requires the following values to be passed:
-- [ ] Support better file loading with threads
+* `BUILD_PROFILE`: `debug`/`release` 
-  - [ ] Loading Screen with GPU IO? (Does DMA and IO work together?)
+* `PSX_TV_FORMAT`: `PAL`/`NTSC`
+* `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
+## JabyEngine
+| Art                                                             | Author |
+|-----------------------------------------------------------------|--------|
+| `ressources\Splash_ntsc.png` <br/> `ressources\Splash_ntsc.png` | Niuka  |
+
+## PoolBox
+| Art                                                             | Author      |
+|-----------------------------------------------------------------|-------------|
+| `examples\PoolBox\assets\AllTheJaby.png`                        | Niuka       |
+| `examples\PoolBox\assets\IconTexture.png`                       | Charlie Nax |
+| `examples\PoolBox\assets\Paco.png`                              | Paco        |
+
+| Music                                                                     | Author                                |
+|---------------------------------------------------------------------------|---------------------------------------|
+| `examples\PoolBox\assets\audio\apple.wav`                                 | ???                                   |
+| `examples\PoolBox\assets\audio\blubb-mono.wav`                            | ???                                   |
+| `examples\PoolBox\assets\audio\Evacuation_cdda.wav`                       | Cody the white tiger                  |
+| `examples\PoolBox\assets\audio\Friendship_samp.wav`                       | From Dragon Quest VII                 |
+| `examples\PoolBox\assets\audio\jlbrock44_Three_Kings_Funk_cdda_ready.wav` | `Three Kings Funk` by spinningmerkaba |
+| `examples\PoolBox\assets\audio\OnMyOwn_BailBonds.mp3`                     | `On My Own` by Bail Bonds             |
+
+# Special thanks
+* Cody the white tiger
+* Nicolas Noble
+* Pyravia
+* Sickle

src/Tools/Common.mk

@@ -14,13 +14,22 @@ define cp_artifact
 endef
 
 define cargo_windows_default
+	$(if $(findstring upgrade,$(CARGO_CMD)),	
+	cargo $(CARGO_CMD) --$(BUILD_PROFILE),
+
 	cargo $(CARGO_CMD) --$(BUILD_PROFILE) --target=$(WINDOWS_TARGET)
 	$(call cp_artifact,$(WINDOWS_ARTIFACT), ../../../bin/$(ARTIFACT).exe)
+	)
 endef
 
 define cargo_unix_default
+	$(if $(findstring upgrade,$(CARGO_CMD)),	
+	cargo $(CARGO_CMD) --$(BUILD_PROFILE),
+
 	cargo $(CARGO_CMD) --$(BUILD_PROFILE) --target=$(UNIX_TARGET)
 	$(call cp_artifact,$(UNIX_ARTIFACT), ../../../bin/$(ARTIFACT))
+	)
 endef
 
+# Run `cargo install cargo-edit --locked`to support upgrade
 # Windows build requires "rustup target add x86_64-pc-windows-gnu" and "sudo apt-get install mingw-w64"

src/Tools/Makefile

@@ -1,3 +1,4 @@
+SUPPORT_PROJECTS = cdtypes tool_helper
 PROJECTS         = cpp_out psxfileconv mkoverlay psxcdgen_ex psxreadmap wslpath
 .PHONY: $(PROJECTS)
 

src/Tools/Tools.code-workspace

@@ -66,14 +66,14 @@
             {
                 "id": "build cfg",
                 "type": "pickString",
-                "options": ["debug", "release"],
+                "options": ["debug", "release", "compatible", "incompatible"],
                 "default": "release",
                 "description": "build configuration"
             },
             {
                 "id": "cargo cmd",
                 "type":"pickString",
-                "options": ["build", "check", "update", "clean", "run", "tree"],
+                "options": ["build", "check", "update", "upgrade", "clean", "run", "tree"],
                 "default": "build",
                 "description": "cargo command to run"
             }

src/Tools/cdtypes/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cdtypes"
-version = "0.7.2"
+version = "1.0.0"
 edition = "2021"
 
 [profile.release]
@@ -8,5 +8,5 @@ panic = "abort"
 
 [dependencies]
 byteorder   = "1.5.0"
-chrono      = "0.4.31"
+chrono      = "0.4.39"
-paste       = "1.0.14"
+paste       = "1.0.15"

src/Tools/cdtypes/Makefile

@@ -0,0 +1,13 @@
+include ../Common.mk
+
+ARTIFACT = cdtypes
+
+.PHONY: $(WINDOWS_ARTIFACT) $(UNIX_ARTIFACT)
+$(WINDOWS_ARTIFACT):
+	$(call cargo_windows_default)
+
+$(UNIX_ARTIFACT):
+	$(call cargo_unix_default)
+
+all-windows: $(WINDOWS_ARTIFACT)
+all: $(UNIX_ARTIFACT)

src/Tools/cpp_out/Cargo.toml

@@ -7,5 +7,5 @@ edition = "2021"
 panic = "abort"
 
 [dependencies]
-clap        = {version = "4.4.11", features = ["derive"]}
+clap        = {version = "4.5.23", features = ["derive"]}
 tool_helper = {path = "../tool_helper"}

src/Tools/mkoverlay/Cargo.toml

@@ -7,6 +7,6 @@ edition = "2021"
 panic = "abort"
 
 [dependencies]
-clap        = {version = "4.4.11", features = ["derive"]}
+clap        = {version = "4.5.23", features = ["derive"]}
-serde_json  = "1.0.108"
+serde_json  = "1.0.134"
 tool_helper = {path = "../tool_helper"}

src/Tools/psxcdgen_ex/Cargo.toml

@@ -8,10 +8,10 @@ panic = "abort"
 
 [dependencies]
 cdtypes     = {path = "../cdtypes"}
-clap        = {version = "4.4.11", features = ["derive"]}
+clap        = {version = "4.5.23", features = ["derive"]}
-colored     = "2.1.0"
+colored     = "2.2.0"
 hound       = "3.5.1"
 no-comment  = "0.0.3"
-paste       = "1.0.14"
+paste       = "1.0.15"
 roxmltree   = "0.19.0"
 tool_helper = {path = "../tool_helper"}

src/Tools/psxfileconv/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "psxfileconv"
-version = "0.9.0"
+version = "1.0.0"
 edition = "2021"
 
 [profile.release]
@@ -28,11 +28,11 @@ symphonia-vorbis = ["symphonia", "symphonia/vorbis"]
 [dependencies]
 bitflags    = "2.6.0"
 cdtypes     = {path = "../cdtypes"}
-clap        = {version = "4.4.11", features = ["derive"]}
+clap        = {version = "4.5.23", features = ["derive"]}
-image       = "0.24.7"
+image       = "0.24.9"
 hound       = "3.5.1"
-paste       = "1.0.14"
+paste       = "1.0.15"
-png         = "0.17.10"
+png         = "0.17.16"
 rubato      = "0.16.1"
 symphonia   = {version = "0.5.4", optional = true, default-features = false}
 tool_helper = {path = "../tool_helper"}

src/Tools/psxreadmap/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 panic = "abort"
 
 [dependencies]
-clap        = {version = "4.4.11", features = ["derive"]}
+clap        = {version = "4.5.23", features = ["derive"]}
 crossterm   = "0.27.0"
 ratatui     = "0.25.0"
 readmap     = {version = "*", path = "readmap"}

src/Tools/tool_helper/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tool_helper"
-version = "0.9.8"
+version = "1.0.0"
 edition = "2021"
 
 [profile.release]
@@ -9,9 +9,9 @@ panic = "abort"
 [dependencies]
 byteorder  = "1.5.0"
 cdtypes    = {path = "../cdtypes"}
-colored    = "2.0.4"
+colored    = "2.2.0"
 envmnt     = "0.10.4"
 hound      = "3.5.1"
-lz4        = "1.24.0"
+lz4        = "1.28.0"
-paste      = "1.0.14"
+paste      = "1.0.15"
 wslpath    = {path = "../wslpath"}

src/Tools/tool_helper/Makefile

@@ -0,0 +1,13 @@
+include ../Common.mk
+
+ARTIFACT = tool_helper
+
+.PHONY: $(WINDOWS_ARTIFACT) $(UNIX_ARTIFACT)
+$(WINDOWS_ARTIFACT):
+	$(call cargo_windows_default)
+
+$(UNIX_ARTIFACT):
+	$(call cargo_unix_default)
+
+all-windows: $(WINDOWS_ARTIFACT)
+all: $(UNIX_ARTIFACT)

src/Tools/wslpath/Cargo.toml

@@ -7,4 +7,4 @@ edition = "2021"
 panic = "abort"
 
 [dependencies]
-clap = {version = "4.4.7", features = ["derive"]}
+clap = {version = "4.5.23", features = ["derive"]}