From 45def213246ef6095b7a8572fa0ead20a2d5186f Mon Sep 17 00:00:00 2001 From: Bobby Dilley Date: Tue, 19 Jul 2022 13:55:52 +0100 Subject: [PATCH] Update docs --- README.md | 10 ++++++++++ docs/configs/config.jvs-passthrough | 5 +++++ docs/configs/config.outrun | 2 ++ docs/configs/config.the-house-of-the-dead-4-special | 2 ++ 4 files changed, 19 insertions(+) create mode 100644 docs/configs/config.jvs-passthrough create mode 100644 docs/configs/config.outrun create mode 100644 docs/configs/config.the-house-of-the-dead-4-special diff --git a/README.md b/README.md index 7df68e9..1155ba6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ This project aims to hook and emulate the various different parts of the SEGA Lindbergh allowing the games to run on modern versions of Linux. +## What this project does + +This project provides an emulation layer so for various software & hardware components of hte SEGA Lindbergh system allowing you to run the games on a modern version of linux. The project also aims to provide documentation of the various APIs used in the Lindbergh system which may be useful for further emulation projects, or homebrew. + +## What this project does not do + +This project does not defeat any security mechanisms of the games, nor does it provide links to roms. You should only use this project to play games if you own the original and removing the security checks form the games is left entierly up to the user. Please do not create issues asking about security bypassing, or have discussions on this github about the subject. + ## Building & Running To build simply run the makefile, and then copy the contents of the build directory into your game directory and run. @@ -13,6 +21,8 @@ cd ~/the-house-of-the-dead-4/disk0/elf LD_PRELOAD=$(pwd)/lindbergh.so LD_LIBRARY_PATH=$LD_LIBRARY_PATH:. ./hod4M.elf ``` +Although not yet used, you will then want to copy a `game.conf` file form the `docs` directory and place it next to the game you with to use. + ## Components This section lists the components of the emulator and what they do diff --git a/docs/configs/config.jvs-passthrough b/docs/configs/config.jvs-passthrough new file mode 100644 index 0000000..17e63ff --- /dev/null +++ b/docs/configs/config.jvs-passthrough @@ -0,0 +1,5 @@ +# Turn off JVS emulation and default to JVS Passthrough +EMULATE_JVS 0 + +# The path to the real JVS IO you'd like to use +JVS_PATH /dev/ttyUSB0 diff --git a/docs/configs/config.outrun b/docs/configs/config.outrun new file mode 100644 index 0000000..a1c9eda --- /dev/null +++ b/docs/configs/config.outrun @@ -0,0 +1,2 @@ +EMULATE_DRIVEBOARD 1 +EMULATE_RIDEBOARD 1 diff --git a/docs/configs/config.the-house-of-the-dead-4-special b/docs/configs/config.the-house-of-the-dead-4-special new file mode 100644 index 0000000..340c2d5 --- /dev/null +++ b/docs/configs/config.the-house-of-the-dead-4-special @@ -0,0 +1,2 @@ +# Emulate the special rideboard +EMULATE_RIDEBOARD 1