cfad47cfa3/doc/README

4b825dc642cb6eb9a060e54bf8d69288fbee4904cfad47cfa334b206c65f22086bcc5d63e6f70944
1
FrobTADS - A portable TADS toolkit.
2
Maintained by Nikos Chantziaras <realnc@gmail.com>.
3
4
For the newest version, visit:
5
6
    http://www.tads.org/frobtads.htm
7
8
By default, the FrobTADS source-package only contains the interpreter.
9
See the file COMPILERS on where to obtain and how to install the TADS 2
10
and TADS 3 development tools, and on where to look for documentation in
11
order to get started with developing your own games.
12
13
For more information about TADS, visit its home page:
14
15
    http://www.tads.org
16
17
18
Platforms
19
=========
20
21
FrobTADS is known to compile and run on various platforms, including:
22
23
Linux (all flavors), Mac OS X, various BSDs, old and modern Solaris,
24
BeOS and Microsoft Windows.
25
26
If you manage to run FrobTADS on a system not mentioned above, please
27
let the maintainer know about it.
28
29
30
About TADS and FrobTADS
31
=======================
32
33
TADS stands for "Text Adventure Development System".  It's a set of
34
tools that allow easy implementation of text adventures, or "Interactive
35
Fiction".  The tools include a compiler along with supporting libraries,
36
a debugger and an interpreter.  An interpreter is needed to run the
37
compiler's output, as it generates "byte code" programs (much like
38
Java).
39
40
The primary target of TADS nowadays is Microsoft Windows (although
41
MS-DOS is still supported).  FrobTADS is a "portable port" of the TADS
42
toolkit.  The term "portable port" sure sounds funny, but it's a quite
43
accurate description; although the main target of FrobTADS is Unix, it
44
compiles and runs even in MS Windows.  Therefore, it's a portable
45
port :-)  The main development takes place on a Linux PC.
46
47
Not everything is included in FrobTADS yet; for now, there are no
48
debuggers available.  On the other hand, the compilers and interpreters
49
are (I hope) feature-complete.
50
51
FrobTADS is not written from scratch; it uses Mike Roberts' portable
52
reference implementations of the two TADS virtual machines; the T2 VM
53
(written in C) and T3 VM (written in C++).  FrobTADS hooks-in into that
54
code by providing a portable implementation of the TADS I/O API.
55
56
57
Goals
58
=====
59
60
FrobTADS has been written as a replacement for the "traditional"
61
Unix-port of TADS, which has many problems and limitations, and is
62
difficult to maintain and change.  The FrobTADS interpreter also
63
provides some features that the traditional Unix-port lacks, the most
64
important of them being:
65
66
  - Automatic configuration prior to building; no need to edit
67
    makefiles.
68
69
  - TADS 3 color support and configurable default colors.
70
71
  - Correct timing with timed operations (millisecond-precision).
72
73
  - Input like in Frotz; cursor keys, insert, delete, etc., instead
74
    of Emacs-like input.
75
76
  - TADS 3 banners look as they should.
77
78
  - You are not required to install the package prior to running the
79
    TADS 3 test suite.
80
81
  - File I/O initiated by the game will happen in the game's directory.
82
    This means that you don't have to change to the game's directory
83
    prior to starting the interpreter.
84
85
  - Less source code (and also less complex), more comments.
86
87
  - More portable.
88
89
The ultimate goal is to make FrobTADS compile and run out-of-the-box on
90
every system that has a curses library and a Unix-like shell available.
91
92
93
What is Multimedia TADS?
94
========================
95
96
Multimedia TADS (also known as "HTML TADS") is an extension of TADS that
97
uses HTML to provide multimedia capabilities.  Multimedia TADS is not an
98
extension of the two TADS languages (TADS 2 and 3), but rather of their
99
output system.  Although FrobTADS, being a character-mode interpreter,
100
doesn't support most of the HTML extensions, it *can* run games that use
101
HTML; on the binary level, Multimedia TADS and "plain" TADS executables
102
are actually the same thing.  You won't see any graphics nor hear sounds
103
and music, but the game will play just fine.  In TADS 2 games, you also
104
won't see any banners that the game would otherwise display (TADS 3
105
games don't use HTML for banners; FrobTADS provides full support for
106
TADS 3 banners).  The vast majority of games don't use the multimedia
107
extensions though, or use only the subset supported by FrobTADS.
108
109
110
What's Interactive Fiction?
111
===========================
112
113
Well, this is just a poor README file and therefore not the appropriate
114
place for an introduction to Interactive Fiction.  For more information
115
about Interactive Fiction (or "IF" for short), just go to the TADS page
116
(http://www.tads.org) and follow some links.  Or go to the Google search
117
engine (http://www.google.com) and search for "interactive fiction";
118
you'll be amazed about how many results you'll get.  And you'll be even
119
more amazed about how active the IF community is.
120
121
There are two Usenet newsgroups for IF related things.  The first is
122
RGIF, which is short for:
123
124
    rec.games.int-fiction
125
126
where people are talking about IF games in general; things they like in
127
games, things they don't like, things they hope to see in future games,
128
requests for hints and solutions, reviews of games, announcements of new
129
games/software or happenings...  Stuff like that.
130
131
The other newsgroup is RAIF, which stands for:
132
133
    rec.arts.int-fiction
134
135
This newsgroup is for everyone who is interested in creating games.
136
Most IF authors use to hang around there, so this newsgroup is an
137
excellent place to post questions about IF theory, authorship and
138
programming.
139
140
Your ISP should usually provide a newsserver which you can use to
141
access Usenet.  If not, you can use Google's web-based Usenet
142
interface:
143
144
    http://groups.google.com/group/rec.games.int-fiction
145
    http://groups.google.com/group/rec.arts.int-fiction
146
147
148
Where do I find games for FrobTADS?
149
===================================
150
151
There's a large repository for IF-related stuff (with *lots* of games!)
152
called "The Interactive Fiction Archive"; people usually just refer to
153
it as "the Archive".  You can access it by HTTP:
154
155
    http://www.ifarchive.org (very slow)
156
157
or by FTP:
158
159
    ftp://ftp.ifarchive.org (also very slow)
160
161
The archive has mirrors that are usually much faster.  You should always
162
access it through:
163
164
    http://mirror.ifarchive.org
165
166
Please use this mirror instead of the main archive!  You'll save
167
yourself (and others) quite a few headaches.  (The full list of mirrors
168
is displayed in the main archive's title-page.)
169
170
Since the archive is actually just a (huge) bunch of data thrown
171
together (more or less), a nice fellow has created a site that will
172
guide you through the archive.  The site is called "Baf's Guide to the
173
IF Archive" and is located at:
174
175
    http://wurb.com/if
176
177
It contains many cool things, like a "Genre Map" for the games located
178
in the archive along with descriptions, reviews and ratings, as well as
179
many useful links.