doc/porting

   1 PORTING
   2
   3 Updated: March 2005
   4
   5 In order to successfully port Metal Blob Solid to another platform you will need,
   6
   7 * SDL2
   8 * SDL2 Image
   9 * SDL2 Mixer
  10 * SDL2 Net
  11 * SDL2 TTF
  12
  13 There are a few considerations when porting to other platforms,
  14
  15 - In the makefile you should remove the -DUNIX define if you are not running
  16   on a *nix system. If you don't it is likely you will only get compile time errors
  17   so you'll be reminded to remove it.
  18
  19 - Most non *nix systems do not have access to a function called strtok_r() which, to
  20   my knowledge, is a threaded version of the strtok() function. Since MBS makes some
  21   small use of this function I've had a try and replicate it. The replicated version
  22   is very half arsed and is only intended to work. Speed and efficiency aren't a
  23   concern here. If you get some grief about "flag tokens" to it is most likely to
  24   be related to this function. It can be found in CEngine.cpp
  25
  26 - On a similar note there is a define called IGNORE_FLAGTOKEN_ERRORS which can also
  27   be set to hopefully aid in the pharsing of the flag tokens whilst also ignoring
  28   any errors thrown. Consider adding to this the build script if you experience
  29   issues.
  30
  31 - To create the PAK file you can run "make buildpak" after running "make". This will
  32   be required if you are building the game from source on non *nix platforms (note that
  33   make install builds the pak file).
  34
  35 When you've successfully ported the game to another platform drop me an email and let me
  36 know. Please DO NOT email me the port without asking permission.
  37
  38 After having said all that, please report gameplay problems as well! Because of the
  39 nature of the game (a platform game with multiple objectives and the ability to
  40 return to previous missions), there are likely to be a few problems. Just let me know
  41 what the problem is, what level it is on and where abouts you encountered it.
  42
  43 Stephen Sweeney
  44 stephen.sweeney@parallelrealities.co.uk
  45 http://www.parallelrealities.co.uk
  46
  47 (NB: This email address does not accept HTML formatted messages. Plain text only)