From db153fc03a5a253934feaaa0c22875ddbf84ee57 Mon Sep 17 00:00:00 2001 From: Jennifer Taylor Date: Wed, 3 Jul 2019 12:19:46 -0700 Subject: [PATCH] Add a readme file explaining how to use JubeatMenu. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2c1a00 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# JubeatMenu + +A launcher menu for Jubeat that uses the 16-button panel to select games. + +Includes a Visual Studio 2008 solution that compiles to a static DLL which runs with launcher.exe on XPE, suitable for use on a Jubeat cabinet. + +The ini file format is simple. For each game, there should be a section which is the game name. For each section, there should be a "launch" key which points to the full path of the executable or batch file to execute when selecting this option. An example is below: + +``` +[Saucer] +launch=D:\L44-saucer\contents\gamestart.bat + +[Saucer Fulfill] +launch=D:\L44-saucer-fulfill\contents\gamestart.bat + +[Prop] +launch=D:\L44-prop\contents\gamestart.bat +``` + +To correctly execute the built code, run the DLL with the game launcher.exe. It will load games from `games.ini` in the same directory as the DLL. This DLL makes use of the original game's driver code to read inputs, so it should be run from a directory containing a working installation. An example invocation is as follows: + +``` +launcher.exe JubeatMenu.dll +``` \ No newline at end of file