From a4096b4124ae7477d8af78e497e28972274cf7bc Mon Sep 17 00:00:00 2001 From: David Griffith Date: Mon, 16 Dec 2013 02:32:49 -0800 Subject: [PATCH] Docs cleanup and updates --- AUTHORS | 31 ++++++++++------------- DUMB | 7 +----- INSTALL | 76 +++++++++++++++++++++++++++++---------------------------- 3 files changed, 53 insertions(+), 61 deletions(-) diff --git a/AUTHORS b/AUTHORS index 9e4139d..996c153 100644 --- a/AUTHORS +++ b/AUTHORS @@ -4,29 +4,24 @@ Original Frotz reference code: Original Unix port: Galen Hazelwood -New Frotz reference code: - Jim Dunleavy - David Griffith - -New Unix port: - David Griffith +Current Custodian: + David Griffith -V6 semi-support: +Other Authors: Alembic Petrofsky - -OSS sound support (from xfrotz 2.32.1): - Daniel Schepler + Jim Dunleavy -Thanks also to those who posted to rec.arts.int-fiction feedback on what I -was doing with Unix Frotz, people who checked the betas for bugs, and sent -in patches. These include, but are not limited to: +Thanks also to those who posted to rec.arts.int-fiction and +intfiction.org feedback on what I was doing with Unix Frotz, people who +checked the betas for bugs, and sent in patches. These include, but are +not limited to: -Torbjorn Anderson, Timo Korvola, Martin Frost, Mihail Milushev, David -Picton, Chris Sullivan, Leonard Richardson, Stephen Kitt, Paul E Coad, -Paul Janzen, Brad Town, Jason C Penney, Denis Hirschfeldt, Jacob Nevins, -Matteo De Luigi, Steven Frank, Thomas Troeger, David Kinder, and others -that I've forgotten. +Torbjorn Anderson, Timo Korvola, Martin Frost, Mihail Milushev, David +Picton, Archturiat Baumann, Leonard Richardson, Stephen Kitt, Paul E +Coad, Paul Janzen, Brad Town, Jason C Penney, Denis Hirschfeldt, Jacob +Nevins, Matteo De Luigi, Steven Frank, Thomas Troeger, David Kinder, and +others that I've forgotten. Michael Edmonson (author of Rezrov) and Evin Robertson (author of Nitfol) deserve recognition for the ideas that I've borrowed from their programs. diff --git a/DUMB b/DUMB index 8573e79..9f8e30f 100644 --- a/DUMB +++ b/DUMB @@ -12,9 +12,7 @@ experience what it's like to play Adventure on a teletype. A much cooler use for compiling Frotz with the dumb interface is that it can be wrapped in CGI scripting, PHP, and the like to allow people to -play games on webpages. I don't know how this is done, so don't ask me -how. If you do know how, send me your code and documentation and I'll -include it in the next release of Frotz. +play games on webpages. It can also be made into a chat bot. Games that move the write little windows of text over the main body of text are hard to read because with the dumb interface, Frotz doesn't @@ -24,8 +22,5 @@ manpage). Games that move the cursor around a lot are probably unplayable. These include games like Andrew Plotkin's "Freefall" and Torbjorn Andersson's "Robots". -Games that make move the cursor around or write inverse banners in the -middle of the text are likely to - The dumb interface code was created by Alembic Petrofsky in 1997 for Frotz 2.32. diff --git a/INSTALL b/INSTALL index fd5ebb4..370f0b1 100644 --- a/INSTALL +++ b/INSTALL @@ -12,14 +12,21 @@ many platforms as possible. The source is rather generic C code and runs well on pretty much all current Unixen. These are the only three things needed to compile and run Frotz: - * Some variant of Unix with an ANSI C compiler (gcc works fine) - * A POSIX-compliant version of make (GNU make will do) - * A reasonably good SYSV derived curses library (ncurses is best) - -Frotz can be compiled without curses, leaving you with a dumb-mode -interface. This option is provided for hysterical raisins and for those -who find it useful for web-based front-ends. Read the DUMB file for -more information. + * Some variant of Unix with an ANSI C compiler (gcc works fine) + * A POSIX-compliant version of make (GNU make will do) + * A reasonably good SYSV derived curses library (ncurses is best) + +For sound support, a few more things are necessary: + * libao (1.1.0 or higher) + * libsndfile (1.0.25 or higher) + * libmodplug (0.8.8.4 or higher) + * libvorbis (1.3.2 or higher) +Earlier versions of these libraries might work, but are untested. + +Frotz can be compiled without curses, leaving you with a dumb-mode +interface. This option is provided for hysterical raisins and for those +who find it useful for web-based front-ends, bots, and whatever else you +can think up. Read the DUMB file for more information. Linux uses ncurses, so you're safe there. The version of curses that comes with NetBSD 1.6.x and later is good too. Earlier versions lacked @@ -30,39 +37,33 @@ platform-specific info below. It's always a good idea to have the GNU version of make(1) around. -If you want sound support, you'll need the OSS drivers (found on Linux -machines and some *BSD machines). Support for other drivers is in the -works. - ======================= Editing the Makefile || ======================= -You should take a look at the Makefile, which is found in the src/ -subdirectory. Read the comments. It's pretty self-explanatory. This -is where you define your compiler, where Frotz will be installed, where -your curses (or ncurses) library is, if you want sound support, and so -on. +You should take a look at the Makefile, which is found in the src/ +subdirectory. Read the comments. It's pretty self-explanatory. This +is where you define your compiler, where Frotz will be installed, what +libraries you're using, if you want sound support, and so on. -If this is too much for you, try installing by NetBSD's pkgsrc, FreeBSD's -ports, RPM, DEB, or whatever packaging scheme suits you. +If this is too much for you, try using your operating systems's +packaging scheme to install Frotz for you. If the latest version of +Frotz isn't there, ask the package maintainer to update it. ================================= Compiling and installing Frotz || ================================= -Make sure you're in the directory that was created when you untarred the -Frotz tarball. Type "make" to compile Frotz. If you get any -showstopping complaints, it's most likely because you didn't tell make -where your curses library is, where the curses header is, if you're -using plain old curses or ncurses, or you're trying to use sound on an -unsupported platform. - -If you get any showstopping complaints, it's most likely because the -curses library on your computer doesn't supply some critical -functionality and you don't have ncurses to fall back on. +After checking over and editing the Makefile, type "make" and Frotz will +be compiled. If this doesn't work, chances are you have an older flavor +of Unix. Check the second section of the Makefile. That's where you'll +find options for older flavors of Unix. Are you using plain old curses +or ncurses. On modern systems, the regular curses library is actually +ncurses. For older systems, this isn't always true. Figure out where +the necessary header files and libraries live and edit the Makefile +accordingly. Once the compile is complete, make sure you have the correct permissions to write where you want Frotz installed, then type "make install". @@ -74,7 +75,9 @@ resulting executable somewhere like $HOME/bin and add that directory to your $PATH. For compiling, installing, and uninstalling dumb frotz, use "make dumb", -"make install_dumb", and "make uninstall_dumb". +"make install_dumb", and "make uninstall_dumb". The process is exactly +the same as above except you won't be depending on any external +libraries; not even curses. ======================================== @@ -150,15 +153,14 @@ notices you don't have a config file of your own in "$HOME/.frotzrc". Platform-specific issues || =========================== -Linux: No apparent problems. This is the only platform on which sound is -known to work properly. +Linux: No apparent problems. [Net|Open|Free]BSD: If you have NetBSD 1.6.x or later, you can use the supplied BSD curses. Otherwise you must have ncurses. -Digital UNIX: No apparent problems. +Digital UNIX: No apparent problems. Sound is probably not available. -Tru64 Unix: Rebadged Digital Unix. +Tru64 Unix: Rebadged Digital Unix. Sound is probably not available. Irix: The vendor-supplied curses library is broken as well as all versions of ncurses supplied on SGI's freeware CDs and in SGI's freeware @@ -184,9 +186,9 @@ of strange problems, gcc might be to blame. I don't have sufficient access to test this theory, so if you're able to enlighten me on this, please do so. -SunOS: Uncomment the "MEMMOVE_DEF..." line in the Makefile before -compiling. Since I don't have access to a SunOS machine or an install CD -(hint hint), Frotz on SunOS is untested. +SunOS: Uncomment the "MEMMOVE_DEF..." line in the Makefile before +compiling. Since I don't have access to a SunOS machine, Frotz on SunOS +is untested. Other flavors of Unix: Getting Unix Frotz to compile and run seems to focus mostly on making sure make(1) can find the proper curses library. -- 2.34.1