File: IntroUserManual.tex

package info (click to toggle)
roleplaying 2.0-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 16,620 kB
  • ctags: 1,039
  • sloc: tcl: 7,155; cpp: 2,709; ansic: 2,227; makefile: 559; sh: 330; csh: 3
file content (115 lines) | stat: -rw-r--r-- 4,582 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
%* 
%* ------------------------------------------------------------------
%* Role PlayingDB V2.0 by Deepwoods Software
%* ------------------------------------------------------------------
%* IntroUserManual.tex - User Manual Introduction
%* Created by Robert Heller on Wed Dec 30 11:22:15 1998
%* ------------------------------------------------------------------
%* Modification History: 
%* $Log: IntroUserManual.tex,v $
%* Revision 1.3  1999/07/14 23:23:46  heller
%* Small last minute update.
%*
%* Revision 1.2  1999/07/14 22:17:34  heller
%* Eddy's Edits.
%*
%* Revision 1.1  1999/01/02 02:11:05  heller
%* Initial revision
%*
%* ------------------------------------------------------------------
%* Contents:
%* ------------------------------------------------------------------
%*  
%*     Role Playing DB -- A database package that creates and maintains
%* 		       a database of RPG characters, monsters, treasures,
%* 		       spells, and playing environments.
%* 
%*     Copyright (C) 1995,1998  Robert Heller D/B/A Deepwoods Software
%* 			51 Locke Hill Road
%* 			Wendell, MA 01379-9728
%* 
%*     This program is free software; you can redistribute it and/or modify
%*     it under the terms of the GNU General Public License as published by
%*     the Free Software Foundation; either version 2 of the License, or
%*     (at your option) any later version.
%* 
%*     This program is distributed in the hope that it will be useful,
%*     but WITHOUT ANY WARRANTY; without even the implied warranty of
%*     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%*     GNU General Public License for more details.
%* 
%*     You should have received a copy of the GNU General Public License
%*     along with this program; if not, write to the Free Software
%*     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
%* 
%*  
%* 

\chapter{Introduction}
\label{Intro}
\typeout{$Id: IntroUserManual.tex,v 1.3 1999/07/14 23:23:46 heller Rel1 $}
\section{What Is the \thesystem?}

The \thesystem\ is a specialized database system with a GUI front end
designed to aid people who play RPGs.  Both the players and the masters
can find uses for this package, to manage the information that
describes the players' characters and the game environment and its
contents.

The system stores the data describing the various game components
(characters, monsters, spells, etc.) in a collection of data files.  The
data file formats are described in detail in Appendix~\ref{DataFormats}.
Except for the Map data file, the data files contain the serialized
contents of the various C++ class structures.  See \cite{HellerRPGCPP99} for
a detailed description of the C++ class library used to manage these
data files.

The rest of the system consists of a collection of Tcl/Tk
(\cite{Ousterhout94}) script files that implement a GUI.  See
\cite{HellerRPGTcl99} for a detailed description of these script files.
The Tcl/Tk scripts interface to the C++ class library via a {\it SWIG}
(\cite{Beazley98}) interface file, which is described in detail in
\cite{HellerRPGSWIG99}.

\section{How this Manual Is Organized}

Most of this manual describes how to use the GUI.

The GUI has eight main toplevel GUI windows:

\begin{enumerate}

\item The {\em Main} window.  This is the main window and it is
described in detail in Chapter~\ref{Main}.

\item The {\em Character Editing} window.  This window is used to create
and edit Character Object data files and it is described in detail in
Chapter~\ref{Character}. 

\item The {\em Monster Editing} window.  This window is used to create
and edit Monster Object data files and it is described in detail in
Chapter~\ref{Monster}. 

\item The {\em Spell Editing} window.  This window is used to create
and edit Spell Object data files and it is described in detail in
Chapter~\ref{Spell}. 

\item The {\em Map Editing} window.  This window is used to create
and edit Map Object data files and it is described in detail in
Chapter~\ref{Map}. 

\item The {\em Treasure Editing} window.  This window is used to create
and edit Treasure Object data files and it is described in detail in
Chapter~\ref{Treasure}. 

\item The {\em Trick / Trap Editing} window.  This window is used to create
and edit Trick or Trap Object data files and it is described in detail in
Chapter~\ref{TrickTrap}. 

\item The {\em Dressing Editing} window.  This window is used to create
and edit Dressing Object data files and it is described in detail in
Chapter~\ref{Dressing}. 

\end{enumerate}

Common GUI elements are described in Chapter~\ref{Common}.