forked from felipesanches/AnotherWorld_VMTools
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a36072f
commit 443e0a0
Showing
1 changed file
with
8 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,25 @@ | ||
# AnotherWorld_VMTools | ||
Toolchain for software development targeting the virtual machine originally designed for Eric Chahi's Another World game. | ||
|
||
The scripts in this repo are Licensed under the GPL version 2 or later | ||
|
||
- Toolchain for software development targeting the virtual machine originally designed for Eric Chahi's Another World game. | ||
- The scripts in this repo are Licensed under the GPL version 2 or later | ||
- All scripts require Python 3. | ||
|
||
### banks2resources | ||
|
||
- Reads compressed game data files such as "msdos_release/bank*" | ||
- Outputs raw binary files called "resource-0x*.bin" | ||
- These are the files used by the MAME driver at https://github.com/felipesanches/mame/commit/1b943d2264b8d536b1815d8d21ef6234bb586b13 | ||
|
||
### resources2romset | ||
|
||
Generates the ROM files needed by https://github.com/felipesanches/AnotherWorld_FPGA | ||
(maybe I should rename it to "resources2fpga_romset"? :-) | ||
- Packs together resource files into ROM files. | ||
- This is also useful for https://github.com/felipesanches/AnotherWorld_FPGA | ||
|
||
### AWVM_trace.py | ||
|
||
Disassembles resource files and generates an assembly source code tree (including data files extracted from the resource files) | ||
- Disassembles ROM files and generates an assembly source code tree. | ||
- Includes data files extracted from the resource files. | ||
|
||
### AWVM_assembler.py | ||
|
||
- Assembles a source tree into bytecode binaries (with embedded data). | ||
- It must generate binary output absolutely identical to the inputs of AWVM_trace.py | ||
|
||
### build_and_run.sh | ||
|
||
- Helper shell script that builds an assembly source tree, copies the generated ROM files to the MAME rompath and executes the emulator. | ||
- This script needs to be tweaked to use the directory paths of your project files, MAME executable, etc... |