diff options
author | Franklin Wei <frankhwei536@gmail.com> | 2014-10-13 21:00:47 -0400 |
---|---|---|
committer | Michael Giacomelli <giac2000@hotmail.com> | 2014-12-23 23:48:12 +0100 |
commit | 33cb13dee5a527ac445ea1b13d42723e4eb3e3b0 (patch) | |
tree | 3ce36ea21b53377b900049143e77e74b77ca1b0d /apps/plugins/xworld/engine.h | |
parent | b681e932a9da797249ddc0e4ccab7ed7cf50fd41 (diff) | |
download | rockbox-33cb13dee5a527ac445ea1b13d42723e4eb3e3b0.tar.gz rockbox-33cb13dee5a527ac445ea1b13d42723e4eb3e3b0.zip |
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>
Diffstat (limited to 'apps/plugins/xworld/engine.h')
-rw-r--r-- | apps/plugins/xworld/engine.h | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/apps/plugins/xworld/engine.h b/apps/plugins/xworld/engine.h new file mode 100644 index 0000000000..a0ad2b469e --- /dev/null +++ b/apps/plugins/xworld/engine.h | |||
@@ -0,0 +1,70 @@ | |||
1 | /*************************************************************************** | ||
2 | * __________ __ ___. | ||
3 | * Open \______ \ ____ ____ | | _\_ |__ _______ ___ | ||
4 | * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / | ||
5 | * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < | ||
6 | * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ | ||
7 | * \/ \/ \/ \/ \/ | ||
8 | * $Id$ | ||
9 | * | ||
10 | * Copyright (C) 2014 Franklin Wei, Benjamin Brown | ||
11 | * Copyright (C) 2004 Gregory Montoir | ||
12 | * | ||
13 | * This program is free software; you can redistribute it and/or | ||
14 | * modify it under the terms of the GNU General Public License | ||
15 | * as published by the Free Software Foundation; either version 2 | ||
16 | * of the License, or (at your option) any later version. | ||
17 | * | ||
18 | * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
19 | * KIND, either express or implied. | ||
20 | * | ||
21 | ***************************************************************************/ | ||
22 | |||
23 | #ifndef __ENGINE_H__ | ||
24 | #define __ENGINE_H__ | ||
25 | |||
26 | #include "intern.h" | ||
27 | #include "vm.h" | ||
28 | #include "mixer.h" | ||
29 | #include "sfxplayer.h" | ||
30 | #include "resource.h" | ||
31 | #include "video.h" | ||
32 | #include "sys.h" | ||
33 | |||
34 | #define STRING_TABLE_FILE "xworld.strings" /* this is relative to dataDir */ | ||
35 | #define STRING_TABLE_VERSION 0x03 | ||
36 | |||
37 | #define XWORLD_FONT_FILE "xworld.font" /* relative to dataDir */ | ||
38 | #define XWORLD_FONT_VERSION 0x01 | ||
39 | |||
40 | struct System; | ||
41 | |||
42 | #define MAX_SAVE_SLOTS 1 | ||
43 | #define SAVE_MAGIC 0x42424657 | ||
44 | struct Engine { | ||
45 | struct System *sys; | ||
46 | struct VirtualMachine vm; | ||
47 | struct Mixer mixer; | ||
48 | struct Resource res; | ||
49 | struct SfxPlayer player; | ||
50 | struct Video video; | ||
51 | const char *_dataDir, *_saveDir; | ||
52 | uint8_t _stateSlot; | ||
53 | }; | ||
54 | |||
55 | void engine_create(struct Engine* e, struct System* stub, const char* dataDir, const char* saveDir); | ||
56 | |||
57 | void engine_run(struct Engine*); | ||
58 | void engine_init(struct Engine*); | ||
59 | void engine_finish(struct Engine*); | ||
60 | void engine_processInput(struct Engine*); | ||
61 | |||
62 | bool engine_loadFontFile(struct Engine*); | ||
63 | bool engine_loadStringTable(struct Engine*); | ||
64 | |||
65 | void engine_makeGameStateName(struct Engine*, uint8_t slot, char *buf, int sz); | ||
66 | void engine_saveGameState(struct Engine*, uint8_t slot, const char *desc); | ||
67 | bool engine_loadGameState(struct Engine*, uint8_t slot); | ||
68 | void engine_deleteGameState(struct Engine*, uint8_t slot); | ||
69 | const char* engine_getDataDir(struct Engine*); | ||
70 | #endif | ||