deepstone

diff README @ 35:1870c4ef8b76

added visual studio project moved the dosemu directory
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 23 Sep 2013 07:41:05 +0300
parents f04884489bad
children 482f30e63462
line diff
     1.1 --- a/README	Mon Sep 23 05:58:24 2013 +0300
     1.2 +++ b/README	Mon Sep 23 07:41:05 2013 +0300
     1.3 @@ -1,17 +1,62 @@
     1.4 -A short trip back in time in the days of 16bit graphics programming for MS-DOS
     1.5 -in VGA mode 13h.
     1.6 +Deepstone (unfinished)
     1.7 +----------------------
     1.8 +This would/will be a dungeon crawler if I ever finish it.
     1.9  
    1.10 -Copyright (C) 2011 John Tsiombikas <nuclear@member.fsf.org>
    1.11 +Copyright (C) 2013 John Tsiombikas <nuclear@member.fsf.org>
    1.12  Feel free to use, modify and redistribute this code under the terms of the GNU
    1.13  General Public License version 3 (or at your option any later version published
    1.14  by the free software foundation). See COPYING for details.
    1.15  
    1.16 -interesting source code files:
    1.17 -- mingl.c: quick & dirty 256-color renderer with a vaguely GL-like interface.
    1.18 -- vga.c: denthoresque vga mode 13h driver.
    1.19 -- timer.c: DOS timer and 8254 code.
    1.20 +Usage
    1.21 +-----
    1.22 +Just start it, walk around with WASD and look around by moving the mouse.
    1.23 +Nothing else to do at the moment :)
    1.24  
    1.25 -To compile this you need Borland C, any version should do. Just type make.
    1.26 +Precompiled binaries included in the archive:
    1.27 + * deepston.exe          MS-DOS version (32bit, requires included dos4gw.exe)
    1.28 + * deepstone-win32.exe   32bit Windows version
    1.29 + * deepstone-linux32     32bit GNU/Linux version
    1.30 + * deepstone-linux64     64bit GNU/Linux version
    1.31  
    1.32 -Special thanks to the vim project for providing a DOS version of vim, without it
    1.33 -this would be much less enjoyable.
    1.34 +The GNU/Linux binaries require libSDL which depends on a shitload of libraries
    1.35 +on my system, so you probably won't be able to run it without first installing
    1.36 +all the dependencies. It might be easier to just compile it yourself, just type
    1.37 +make and run ./deepstone
    1.38 +
    1.39 +Running with DOSBOX
    1.40 +-------------------
    1.41 +I've included a dosbox.conf which automatically runs the "game", as well as a
    1.42 +copy of dosbox.exe for windows. So just change into the dosbox/ subdirectory and
    1.43 +run dosbox.
    1.44 +NOTE: you might need to click in the dosbox window first before you can use
    1.45 +mouse control.
    1.46 +
    1.47 +Running on actual MS-DOS
    1.48 +------------------------
    1.49 +Just copy deepston.exe, dos4gw.exe and the data directory to your DOS machine,
    1.50 +and run it. The mouse driver must be installed first! (mouse.com or whatever).
    1.51 +
    1.52 +Build on MS-DOS
    1.53 +---------------
    1.54 + * You need the Watcom 32bit compiler and assorted utilities.
    1.55 + * Type make
    1.56 + * Profit (run deepston.exe)
    1.57 +
    1.58 +Build on GNU/Linux
    1.59 +------------------
    1.60 + * Install SDL (libsdl-1.2-dev or whatever).
    1.61 + * Type make
    1.62 + * Profit (run ./deepstone)
    1.63 +
    1.64 +Build on MS-Windows
    1.65 +-------------------
    1.66 + * Install SDL
    1.67 + * Open deepstone.sln with visual studio >= 2008
    1.68 + * Make sure visual studio knows where to find your copy of SDL (so configure
    1.69 +   include and library paths... ugh, windows programming.. icky).
    1.70 + * Press build solution or whatever it's called this way.
    1.71 + * Profit (find the bloody thing and run it, or click the happy little play button).
    1.72 +
    1.73 +Contact
    1.74 +-------
    1.75 +Feel free to tell me how much I rule, by sending email to nuclear@member.fsf.org