ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/doc/README
Revision: 1.2
Committed: Thu Sep 7 21:42:40 2006 UTC (17 years, 8 months ago) by pippijn
Branch: MAIN
CVS Tags: HEAD
Changes since 1.1: +0 -0 lines
State: FILE REMOVED
Log Message:
Moved documents to doc/historic

File Contents

# Content
1 Since many of the subdirectories in here have some things in common, I
2 figured it would be a good idea to merge them. Quick not on what some things
3 are:
4
5 playbook: This is a good guide on how to play crossfire. This is in latex/
6 postscript format.
7 playbook-html: This is an html version of the playbook.
8 spoiler: This is a generation of 'spoilers' for the game. It is in latex/
9 postscript format. Some stuff really shouldn't be considered
10 spoilers (character stat bonuses). Other stuff (monster stats,
11 what type of items spells appear in) is. It could be more thorough.
12 spoiler-html: An html version of the spoiler.
13
14 Postscript versions of the spoiler and playbook should be distributed
15 with the game. However, a lot of the information in this guides is machine
16 generated, and you may wish to rebuilt it. Here are some requirements for
17 all the the above:
18
19 - a real awk, like the free AT&T awk, mawk or gawk
20 - xpmtoppm from NETPBM, with _undefined_ PGM_BIGGRAYS in pbmplus.h
21 - pnmtops, pnmscale, pgmtoppm. If you install NetPbm, you should also
22 have these
23 - a crossfire binary compiled with DUMP_SWITCHES defined in
24 include/config.h.
25 - the arch.tar file extracted in the Crossfire lib dir.
26
27 If you are generating any of the latex guides, you also need the following:
28 - LaTeX with psfig (web-6.1)
29 - dvips (5.58)
30 - longtable.sty,babel.*,psfig.* files, available at any TeX ftp site
31
32 The latest version of latex/tex should generate the spoiler fine. The format
33 of latex changed in some version or another, so old version will not be
34 able to compile the spoiler. Prior to 0.92.5 or so, the spoiler was set
35 for the old version of latex, now it is set for the new version.
36
37 Note that the spoiler needs more memory that is on the default versions
38 of tetex. If you are using tetex, you should increase
39 the main_memory, extra_mem_top and extra_mem_bot in the
40 texmf.cnf (located at /usr/share/texmf/web2c on by redhat system). The
41 following values work for me:
42 main_memory = 5120000 % words of inimemory available; also applies to inimf&mp
43 extra_mem_top = 100000 % extra high memory for chars, tokens, etc.
44 extra_mem_bot = 100000 % extra low memory for boxes, glue, breakpoints, etc.
45
46
47 If you are generating any of the html guide, you may want to use giftrans.
48 This produces transparent gifs, which look a lot nicer in the guides. You
49 can change a flag near the top of makeps in these directories to use/not
50 to use giftrans (by default, it is used.)
51
52 By default, the postscript images generated from the latex source uses
53 greyscale images. This is largely due to space considerations (a color
54 version is much larger), and the fact that most printers aren't color. If
55 you are just going to view it with ghostscript, you are probably better
56 off looking at the html versions instead.
57
58 By default, a top level make will not descend into these directories and
59 recreate them when thing change. Instead, you need to cd into the directory
60 and manually run make. In some cases, you may need to rename/remove the
61 finished product for this to still work.
62
63 specific notes:
64
65 HANDBOOK:
66
67 If you don't want the icons, edit input image in the handbook.tex file.
68
69 HTML notes (both spoiler and playbook):
70
71 Most of these documents use server side includes (files that end in .shtml
72 mean this). Unfortunately, if you are just loading them up in a web browser,
73 it won't take these includes. I have written a simple perl script
74 (include_html.pl) that will take the .shtml file and write and a .html file
75 with the files included.
76
77 PLAYBOOK HTML note:
78
79 There are several referances in the playbook to the spoiler. I have these
80 set up as ../spoiler/spoiler.html. Depending on where you store the
81 spoiler, you may need to change these links for it to work properly.
82
83 GENERAL NOTE:
84
85 The playbook and spoiler could probably be stored in the same directory, and
86 this would increase recreation time (since they share the same version.)
87 This goes for the latex versions (store together) and the html version (store
88 together). However, I think keeping them seperate at least helps out on
89 maintaining them. But if you are putting them on a web page, storing them
90 together is probably a good thing.
91
92 Most of the original docs were done by:
93
94 Lars Olafsen <larso@ifi.uio.no>
95 Kjetil T. Homme <kjetilho@ifi.uio.no>
96
97 The html spoiler was done by:
98 Lars Olafsen <larso@ifi.uio.no>
99
100 The playbook was done by:
101 Brian Thomas (thomas@astro.psu.edu)
102
103 The playbook was converted to html by:
104 Mark Wedel (mwedel@scruz.net)