;
; RESOURCE.HLP - SRE Configuration File Help
;
; The format of the resource file "RESOURCE.DAT" is the name of the parameter
; on the left and the value(s) on the right.
;
; Strings can be optionally enclosed in double quotes; SRE reads one
; WORD:  if you put "hello there", it'll read the entire string
; 'hello there'; if you put hello there, it'll read the first word,
; 'hello'.
;
; Numbers can be input in decimal, hex (with 0x before the hex number),
; or octal (with 0 as the first digit).  This is in the format specified
; by the 'C' language.
;
; Booleans can be false values or true values; false values include
; 'off', 'false', '0', 'f', and 'no'; true values include 'on', 'true',
; '1', 't', and 'yes'.
;
; Comments start with any non-alphabetic character.  I'm using ";" in here,
; but SRE never reads RESOURCE.HLP, so it doesn't really matter!
;
; All of the Boolean resources can be specified on the command line.  For
; example, you can run any of:
;    SRE /SpecialEffects
;    SRE /SpecialEffects=T
;    SRE /SpecialEffects=1
;    SRE /SpecialEffects=Y
; to turn on special effects; you can run any of:
;    SRE /NoSpecialEffects
;    SRE /SpecialEffects=F
;    SRE /SpecialEffects=0
;    SRE /SpecialEffects=N
; to turn off special effects.	You can also use -SpecialEffects instead
; of /SpecialEffects.  (SRE also respects whatever your switch character
; may be set to.)

; CheckTimeLimit : Boolean
;   Would you like SRE to read the time limit from the doorfile?  SRE
;   expects the value in minutes; if your value is in seconds, SRE will
;   give your users 60 times as much time as they should have.	I will
;   add an option if there is a demand for it to take the value in
;   seconds instead of minutes.  DORINFO1.DEF and DOOR.SYS both give
;   time values in minutes.
CheckTimeLimit          no

; LockBaudRate : Number
;   This replaces SRLOCK.  You can (and probably should) use this to
;   tell SRE at which speed your modem is locked.  In the future, SRE
;   will use both the unlocked baud rate and the locked baud rate to
;   correctly handle special effects.
LockBaudRate            19200

; ComN : (port) Number (interrupt level) Number
;   You can define Com1 through Com8.  Currently, the SRE modem routines
;   only work with IRQ levels 3 and 4.	I'm trying to get them to work
;   with other IRQ levels.  (You can try IRQ other than 3 or 4, and see
;   if it works -- it might!)  Normally, COM1 through COM4 are already
;   defined.  You don't have to mess with this unless your COM port isn't
;   the standard port 3F8/2F8/3E8/2E8 with IRQ 3/4/3/4.
Com8                    0x3E8 4

; TimeOut : Number
;   This is the number of seconds to wait before printing the warning
;   "30 seconds before timeout!".  30 seconds past the amount you specify
;   here, SRE will return to the BBS.
TimeOut                 300 seconds

; Beeps : Boolean
;   You can disable the *UNREGISTERED* beep by setting this value to
;   false.  It's true by default for those people who don't bother reading
;   any of the documentation.  :-)
Beeps                   true

; SpecialEffects : Boolean
;   For locked baud rates, it's not always good to keep special effects
;   (the pause cursor) on, since it might overflow the modem buffer and
;   cause sluggish displays for users on at low speed.  You should try
;   leaving it on, and if users complain, then turn it off.
SpecialEffects          on

; Menu : Boolean
;   If you want the secret intro menu, set this to 'yes'.  It's another
;   bonus for reading the docs.  :-)
Menu                  no

; FastWrite : Boolean
;   If you set this to 'yes', SRE will use maximum speed direct screen
;   writes.  It only works for color monitors, and it won't work in
;   DESQview or Windows.
FastWrite             no

; BIOS : Boolean
;   If you set this to 'yes', SRE will write to the BIOS instead of to
;   the screen.  It makes it "well-behaved" according to DesqView and
;   MS-Windows.
BIOS                  no

; ANSI : Boolean (or -1)
;   The default is -1; if you set 'yes' or 'no', SRE will force ANSI or
;   non-ANSI modes.
ANSI                  -1

; IBMCharacters : Boolean (or -1)
;   The default is -1; if you set 'yes' or 'no', SRE will force output
;   of IBM characters or output of only the low part of the ASCII set.
;   (If you like to experiment, try running with ANSI, but without
;   IBMCharacters to see some unusual combinations!)
IBMCharacters         -1

; LOG : Boolean
;   If this is 'yes', SRE will write each user's actions into a LOG
;   file called SRE.LOG.  It will overwrite the previous SRE.LOG file.
;   You can use this in combination with the INSTRUCTIONS parameter
;   to save the instructions to a file in ANSI or non-ANSI modes, but
;   this is easier to do if you use the command-line parameters.
LOG                   no

; Local : Boolean
;   If this is 'on', SRE will force local play, regardless of the COM
;   port specified in the doorfile.
Local                 off

; HelpMode : Number
;   If this is 0, the help strings are entered by typing in the entire
;   string, or pressing <TAB> to complete the word.  If this is 1, the
;   topics can be entered by just typing "enough", and it will automatically
;   fill in the rest of the word when it can.  If this is 2, the topics
;   are typed as far as possible whenever a key is pressed (like pressing
;   <TAB> after every key).  You can experiment with this by changing
;   the mode here and running "SRE HELP".
HelpMode              1

; ExtendedSwapping : Boolean
;   If this is 'yes', SRE will attempt to swap to extended memory instead
;   of disk.  This or ExpandedSwapping will speed up the game a lot.
ExtendedSwapping        no

; ExpandedSwapping : Boolean
;   If this is 'yes', SRE will attempt to swap to expanded memory instead
;   of disk.  If both Extended and Expanded options are selected, SRE
;   will first try extended, and if that fails, it will try expanded.
ExpandedSwapping        no

; Statistics.Top : Number
;   If you want SRE STATISTICS to show only the top 10, put a 10 here;
;   the default is 25, so it will show everyone in the statistics listings.
Statistics.Top        25

; Statistics.ShowName : Boolean
;   If this is true, SRE STATISTICS will display empire names rather than
;   the distribution of planets owned.
Statistics.ShowName   yes

; Treaty : Boolean
;   If this is 'off', no diplomacy will be allowed.  Remember that diplomacy
;   is required for trading, so trading will be disabled as well.
Treaty                on

; Treaty.Neutrality       : Boolean
; Treaty.FreeTrade        : Boolean
; Treaty.MinorAlliance    : Boolean
; Treaty.ArmedDefense     : Boolean
; Treaty.CruiserDefense   : Boolean
; Treaty.TotalDefense     : Boolean
; Treaty.Break            : Boolean
;   These control which treaty options are allowed.  By default, all of
;   them are shown on the menu (they are all 'on').

; Attacks.Nuclear  : Boolean
; Attacks.Chemical : Boolean
;   These control (individually) whether nuclear & chemical attacks are
;   enabled.  These work ONLY if you've selected "Special Attacks" as
;   well, which is a Registered-Only option.
Attacks.Nuclear       yes
Attacks.Chemical      yes

; Attacks.Maximum : Number
;   This is the number of attacks (other than pirate raids) that a player
;   may make in each maintenance interval (usually a day).  -1 is no limit.
Attacks.Maximum       -1

; Messages : Boolean
;   If 'no', messages are disabled.
Messages                yes

; Trading : Boolean
;   If 'no', trading is disabled.
Trading                 yes

; Scores : Boolean
;   If 'yes', after each user plays, the scores are written to SRESCORES.TXT
;   (text file) and SRESCORES.ANS (ANSI file).
Scores                  yes

; Output.Comma : Boolean
;   If 'yes', commas are shown for numbers 5 or more digits long.  If 'no',
;   no commas are output.
Output.Comma          yes

; VGA : Boolean
;   If 'yes', SRE will do VGA effects.  I haven't put too many in yet, but
;   if there is a demand, I'll add more later.
VGA                     no

; These are the defaults that you might want to copy over to RESOURCE.DAT
; and then modify:

TimeOut                 300 seconds
Beeps                   true
SpecialEffects          on
Menu                    no
CheckTimeLimit          no
FastWrite               no
BIOS                    no
ANSI                    -1
IBMCharacters           -1
LOG                     no
Local                   off
HelpMode                1
ExpandedSwapping        off
ExtendedSwapping        off
Statistics.Top          25
Statistics.ShowName     yes
Attacks.Chemical        yes
Attacks.Nuclear         yes
Output.Comma            yes
VGA                     no
Scores                  yes
Trading                 yes
Treaties                yes
Messages                yes

