commit a4df7a198d35d16c977bc5ab5e23a11c3fc2a04c
parent fa893b55429c5dd123bbfae3872dd8d4234baf2d
Author: Quentin Rameau <quinq@fifth.space>
Date: Mon, 9 Nov 2015 15:10:56 +0100
Add REAMDE.md: file format and addrom installation
Diffstat:
| README.md | | | 45 | +++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 45 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,45 @@
+addrom
+======
+
+Simple tool to add a rom entry to a PB3 list.dat.
+
+addrom lets you add a rom entry into a Pandora's Box v3 list.dat rom file.
+It reads an input file, writes rom fields according the file format, calculates
+the total number of entries and modifies that reference in the file, and writes
+the new file to another output file.
+
+Installation
+------------
+Edit config.mk for customizing compilation options and installation paths.
+
+ make (building)
+ make install (install, may need privileges, default in /usr/local)
+ make clean (cleaning)
+
+Usage
+-----
+Read the manual page.
+
+File format
+-----------
+The file is composed of a header and a concatenation of rom entries
+with the following fields:
+
+ HEADER 16B
+ Header size 4B
+ Number of games 4B
+ ENTRY 120B
+ Chinese name 64B
+ English name 32B
+ ROM name 16B
+ Magic number (?) 8B
+ ENTRY...
+
+The number of games field is calculated in the following manner:
+
+ Field = (decimal number of games << 32 << 6) / 0x88888888
+
+You can reverse the calculation with this:
+
+ Decimal number of games = (field * 0x88888889) >> 32 >> 6
+
