From 443e0a0586f4e03d47dbef1939809159e8a29998 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felipe=20Corr=C3=AAa=20da=20Silva=20Sanches?= Date: Sun, 4 Oct 2020 16:18:20 -0300 Subject: [PATCH] update README.md --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ada3faf..288a7b6 100644 --- a/README.md +++ b/README.md @@ -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...