Add the APW Borg as of 1st March 2008.
[angband/borg.git] / borgread.txt
blob9ac47cf136a6be1604f1e8164aae04610ae4d34f
2 Greetings my friends and welcome to the world of mindless dribble.
3 This source code will enable you to spend countless hours staring
4 at your computer when you should be doing something more productive,
5 anything more productive.
7 You have a couple of options on how to get the borg running.  Be sure
8 to copy the file borg.txt into the angband\lib\user  directory.  On
9 my system, borg.txt is in c:\games\ang309\lib\user.
11 For those using Unix, you need to put it in a different directory.
12 Sorry, I don't remember the exact syntax for it.
14 Option one:  
15 Use the precompiled executable files and replace your
16 angband.exe or angband.scr files with the ones with this package.
17 1. copy the angband.exe and replace the existing one in your angband
18    directory.  If using the screensaver, copy and replace the
19    angband.scr in your windows directory.
20 2. If using screensaver, copy the angband.ini included with the screensaver
21    zip file and put that in your windows directory as well.  Be sure to 
22    edit it so it points to the correct location of your angband files.
23    (See the notes below)
24    
26 Option two:  Compile your own executable file using the borg source
27      code provided in this package.  Follow the instructions below.
29 To install and compile this borg, you will need to do the following:
30 1.  Modify the config.h to uncomment:
31         a. the allow_borg line
32         b. the score_borg line
33         c. the allow_borg_graphics line
34 2.  Modify the makefile to include the borg1.o (or borg1.obj if windows)
35     though borg9.o
36 3.  Make sure the file borg.txt is located in the \lib\user\ directory.
37 4.  Modify your borg.txt file if you want to run the borg in a particular
38     fashion, including continuous play borgs.
39 5.  Compile
40 6.  Start the game, load up a character or make new one.
41 7.  Hit control z, read and ignore the messages, hit z again.
42 8.  Grab some popcorn and a soda, and watch your mind go numb.
44 The borg may get stuck in certain situations.  He may have a Clock Overflow.
45 He may loop buying and selling the same stuff over and over.  Believe me
46 when I say that these have been addressed.  His loops are greatly reduced.
48 Continuous Play Mode: (option)
49 Upon the death of a borg, he will automatically reroll a random character,
50 with a random name and start fresh from clevel 1.  To enable the Continuous
51 Play Mode, turn the game option cheat_live on.  To do that enter the
52 options by pressing the equal sign (=) then Cheat Options (6).
54 If you want, you can tell the borg to select a certain race and or class for
55 the next one rolled up.  You can make these selections from the borg.txt file.
57 The Continual Play Mode is NOT turned on by default, you will need to
58 select it.
60 This borg is updated frequently.  You can get the lastest source
61 as well as executables at http://itctel.com/~apwhite/andrew.html
63 Have Fun,
64 Dr. Andrew White
68 ===========================
69  Angband Borg Screen Saver
70 ===========================
72 by Robert Ruehlmann < rr9@angband.org >
73    Andrew White     < apwhite@itctel.com >
74    
75 Uses Andrew P. White's APWBorg.
76 (see http://itctel.com/~apwhite/andrew.html).
79 Description:
80 ------------
82 A screensaver that runs the vanilla Angband Windows version with the
83 APW Borg and automatically restarts the Borg when the character dies
84 (continuous play mode).
86 The borg engine is updated frequently, so visit Dr. White's page and
87 obtain the most recent version of the borg.  You may also down-load
88 an up to date executable of the screensaver from that page.
90 Note that the Angband display is not always dynamic and may not
91 protect your monitor from burning-in of images.  While this is highly
92 unlikely with modern monitors you might want to configure the energy
93 saving settings for your monitor so that it turns itself off after
94 some time of inactivity.  The screensaver will also keep the
95 processor and hard-disk busy.  Power-saving features that depend on
96 inactivity of these parts won't be effective while the screensaver
97 is running.  You have been warned.
100 Installation:
101 -------------
103 Copy angband.scr and the included angband.ini into your Windows directory.
105 Make sure you have the Windows version of Angband installed.
106 If you don't have it yet, then download it from
107 http://rephial.org/ and install it.
109 Open angband.ini with a text-editor and modify "AngbandPath" so that
110 it points to the directory where Angband for Windows is
111 installed. Note that the path has to end with a backslash ('\').
113 The "SaverFile" variable should contain the name of the character you
114 want to use for the screensaver.  A random character will be
115 automatically created if the character doesn't exist yet.  Note that
116 the savefile will be marked as cheater and won't get an highscore
117 entry!  With the changes to the 3.0.9 game code, there is a slight flaw
118 in how the borg rolls up the first character for the screensaver.  The
119 character is rolled but the borg won't engage until the next time the
120 screensaver is activated.
122 It is recommended that you create a savefile and setup your term windows
123 then save that file and use that file name as the "SaverFile" for your
124 screensaver.
126 Select the screensaver in the Windows display properties and test it!
129 Technical stuff:
130 ----------------
132 The screensaver is basically just a renamed Windows Angband
133 executable.  The main-win.c file has been heavily modified to allow
134 the game to act as screensaver.
136 "SCORE_BORGS" has been turned on so that normal Borgs (but not Borgs
137 used with the continuous play mode turned on like in the
138 screensaver!) will get highscore entries.
140 The screensaver uses the angband.ini of the normal Angband
141 installation to determine the screen-layout, as well as the graphics
142 and sound settings.
144 My "ALLOW_BORG_GRAPHICS" code that is included in the APW Borg has
145 been turned on, so the Borg runs nicely with the various graphics
146 and "view_foo_lite" lighting settings.
148 The screensaver can be used as normal Angband executable by renaming
149 it to angband.exe and replacing the old exe in the Angband 
150 installation directory with it.
152 The screensaver tries to be "nice" and only uses processor cycles
153 when the processor would be idle otherwise.  It shouldn't slow down
154 other processes that might be running.
156 The user can also switch that feature on with the "Options/Low
157 priority" menu-entry when using the screensaver as normal Angband
158 executable (very useful for running Borgs in the background).
160 Known problems:
161 ---------------
163 - No preview of the screensaver when in the Windows display
164   properties.
165 - Password protection doesn't work yet (note that Windows NT seems
166   to handle password protection itself, so this might be no problem
167   on NT and maybe Windows 2000 machines).
168 - Configuration of the screenserver should be possible with a dialog
169   instead of an ini-file.
170 - Selecting "Show scores" while the Borg is running will probably
171   crash the Borg since it can't parse the score-screen.
172 - The screensaver probably won't work correctly with other Borgs that
173   don't provide a continuous play mode compatible with the APW code.
174 - Running the same savefile twice at the same time (for example by
175   running a normal game and the screensaver with the same savefile)
176   might lead to problems.
177 - The size of some info windows can increase when exiting the "pseudo-
178   screensaver" mode started from the options menu.
179 - The Borg is a very complicated piece of code and contains lots of bugs.
180   Expect slowdowns, loops, crashes, and other problems.  If you encounter
181   a suspect bug, first consult the APWBorg Webpage for a updated screen-
182   saver, and check the Daily Log of Changes to see if your bug has been
183   fixed.  If not, then send the bug and savefile to Dr. White at
184   apwhite@itctel.com
187 Links:
188 ------
190 APW-Borg homepage:
191 http://itctel.com/~apwhite/andrew.html
193 Angband homepage:
194 http://rephial.org/