Xworld - Another World interpreter for Rockbox

Co-conspirators: Franklin Wei, Benjamin Brown

--------------------------------------------------------------------
This work is based on:
- Fabien Sanglard's "Fabother World" based on
- Piotr Padkowski's newRaw interpreter which was based on
- Gregory Montoir's reverse engineering of
- Eric Chahi's assembly code

--------------------------------------------------------------------
Progress:

* The plugin runs pretty nicely (with sound!) on most color targets
* Keymaps for color LCD targets are complete
* The manual entry is finished
* Grayscale/monochrome support is NOT PLANNED
  - the game looks horrible in grayscale! :p

--------------------------------------------------------------------
Notes:

* The original game strings were built-in to the executable, and
  were copyrighted and could not be used.
* This port ships with an alternate set of strings by default, but
  can load the "official" strings from a file at runtime.

--------------------------------------------------------------------
To be done (in descending order of importance):

* vertical stride compatibility                          <30% done>
* optimization                                           <10% done>

Change-Id: I3155b0d97c2ac470cb8a2040f40d4139ddcebfa5
Reviewed-on: http://gerrit.rockbox.org/1077
Reviewed-by: Michael Giacomelli <giac2000@hotmail.com>

1 files changed, 86 insertions, 0 deletions

diff --git a/apps/plugins/xworld/README b/apps/plugins/xworld/README
new file mode 100644
index 0000000000..3a07b1ba94
--- /dev/null
+++ b/apps/plugins/xworld/README
@@ -0,0 +1,86 @@
+This is the original readme from the "Fabother World" sources; the Rockbox port's
+readme is in README.rockbox.
+
+Franklin Wei
+
+=================================================================================
+
+This is "Fabother World": an Another World (Out Of This World in North America) interpreter codebase. This work is based on:
+
+- Piotr Padkowski's newRaw interpreter which was based on
+- Gregory Montoir's reverse engineering of
+- Eric Chahi's assembly code.
+
+I cleaned up a lot of the code, removing cryptic hexadecimal notation
+with meaningful macros name. I also cleanup a lot of the code so it has a 
+C/C++ philosophy instead of an assembly structure.
+
+I also created a Visual Studio 2010 project.
+
+TODO:
+
+Create a MacOS X project.
+Add a different rendering path OpenGL support.
+
+Fabien Sanglard
+
+
+raw README
+Release version: 0.1.1 (May 15 2004)
+-------------------------------------------------------------------------------
+
+About:
+------
+
+raw is a re-implementation of the engine used in the game Another World. This 
+game, released under the name Out Of This World in non-European countries, was 
+written by Eric Chahi at the beginning of the '90s. More information can be 
+found here : http://www.mobygames.com/game/sheet/p,2/gameId,564/.
+
+Please be aware that, currently, this implementation may contains bugs and 
+non-implemented features that make it impossible to finish the game.
+
+Supported Versions:
+-------------------
+
+Currently, only the english PC DOS version is supported ("Out of this World").
+
+Compiling:
+----------
+
+Tweak the Makefile if needed and type make (only gcc3 has been tested so far).
+The SDL and zlib libraries are required.
+
+Running:
+--------
+
+You will need the original files, here is the required list :
+    BANK*
+    MEMLIST.BIN
+        
+To start the game, you can either :
+- put the game's datafiles in the same directory as the executable
+- use the --datapath command line option to specify the datafiles directory
+
+Here are the various in game hotkeys :
+    Arrow Keys      allow you to move Lester
+    Enter/Space     allow you run/shoot with your gun
+    C               allow to enter a code to jump at a specific level
+    P               pause the game
+    Alt X           exit the game
+    Ctrl S          save game state
+    Ctrl L          load game state
+    Ctrl + and -    change game state slot
+    Ctrl F          toggle fast mode
+    Alt Enter       toggle windowed/fullscreen mode
+    Alt + and -     change scaler factor
+
+Credits:
+--------
+
+Eric Chahi, obviously, for making this great game.
+
+Contact:
+--------
+
+Gregory Montoir, cyx@users.sourceforge.net