Skip to content

Commit

Permalink
DOCS fixes
Browse files Browse the repository at this point in the history
- Fix filenames in EDITOR doc viewer (some extensions had been renamed)
- Fix Instructions option on USURPER login menu
- Remove FUTURE.DOC from EDITOR doc viewer as it does not exist
- Add AT-CODES and BETATEAM to EDITOR doc viewer
- Update doc files to use 78 columns as max length, so they display nicely in EDITOR doc viewer
Also a few TAB to SPACE conversions
  • Loading branch information
rickparrish committed Apr 28, 2024
1 parent 42dd9f6 commit f269846
Show file tree
Hide file tree
Showing 11 changed files with 494 additions and 270 deletions.
82 changes: 45 additions & 37 deletions RELEASE/DOCS/AT-CODES.TXT
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
As of version 0.25, Usurper supports customizing some of the screens by editing
ANSI and ASCII files in the TEXT subdirectory.
As of version 0.25, Usurper supports customizing some of the screens by
editing ANSI and ASCII files in the TEXT subdirectory.

In these files, you can use @-codes (also known as Message Variables, MCI codes,
etc) to display game and player information on the screen.
In these files, you can use @-codes (also known as Message Variables, MCI
codes, etc) to display game and player information on the screen.

The @-code support is a partial implementation of the Synchronet @-code system,
which is described here: http://wiki.synchro.net/custom:atcodes
The @-code support is a partial implementation of the Synchronet @-code
system, which is described here: http://wiki.synchro.net/custom:atcodes

================================================================================
==============================================================================

To embed a variable in a screen, you must wrap the variable in @ symbols, and
To embed a variable in a screen, you must wrap the variable in @ symbols, and
use all upper case, for example @TOWN_NAME@ to display the name of your town.

Currently supported @-code variables are:

ACTIVE_POISON The player's active poison (applies to Alchemist)
Values: Not Applicable, None, Light, Medium, Strong, Deadly
Values: Not Applicable, None, Light, Medium, Strong,
Deadly
AGE The player's age, including trailing 'years'
AGILITY The player's agility
ARMOUR_NAME The player's armour name
Expand All @@ -24,26 +25,29 @@ BANK The player's bank deposit amount
CHARISMA The player's charisma
CHIVALRY The player's chivalry
CLASS The player's class
Values: Assassin, Barbarian, Bard, Cleric, Jester, Magician, Paladin, Ranger, Sage, Warrior
Values: Assassin, Barbarian, Bard, Cleric, Jester,
Magician, Paladin, Ranger, Sage, Warrior
DARKNESS The player's darkness
DEFENCE The player's defence
DEXTERITY The player's dexterity
DISEASE_RESISTANCE The player's disease resistance
Values: very poor, poor, medium, average, above average, strong, very strong, EXTREME, *IMMUNE*
Values: very poor, poor, medium, average, above average,
strong, very strong, EXTREME, *IMMUNE*
DRUG_ADDICTION The player's drug addiction, including trailing % sign
DUNGEON_FIGHTS The player's dungeon fights left today
EXP The player's experience points
EYES The player's eye colour
Values: white, red, blue, green, brown, black, purple, grey, yellow
Values: white, red, blue, green, brown, black, purple,
grey, yellow
GOLD The player's money on hand amount
HAIR The player's hair colour
Values: same as EYES
HEALINGS The player's healing potion count
HEIGHT The player's height, including trailing 'cm'
HP_FRACTION The player's hit points in CURRENT/TOTAL format (ie 20/20)
HP_FRACTION The player's hit points in CURRENT/TOTAL format (eg 5/20)
LEVEL The player's level
MENTAL_STABILITY The player's mental stability, including trailing % sign
MONEY_TYPE The type of money used in the game, as set in EDITOR (ie gold)
MONEY_TYPE The type of money used, as set in EDITOR (ie gold)
MONSTER_DEFEATS The player's number of deaths from a monster
MONSTER_KILLS The player's number of monster kills
NAME The player's name
Expand All @@ -52,7 +56,8 @@ PLAYER_DEFEATS The player's number of deaths from another player
PLAYER_FIGHTS The player's number of player fights left today
PLAYER_KILLS The player's number of player kills
RACE The player's race
Values: Dwarf, Elf, Gnoll, Gnome, Half-Elf, Hobbit, Human, Mutant, Orc, Troll
Values: Dwarf, Elf, Gnoll, Gnome, Half-Elf, Hobbit,
Human, Mutant, Orc, Troll
RESURRECTIONS The player's number of resurrections left today
SKIN The player's skin colour
Values: same as EYES
Expand All @@ -68,14 +73,14 @@ WEAPON_POWER The player's weapon power
WEIGHT The player's weight, including trailing 'kg'
WISDOM The player's wisdom

================================================================================
==============================================================================

Optional format strings can be used to alter how the variable will be displayed.
A pipe character (|) is used to separate the variable name from the format
string, so for example @TOWN_NAME|U@ will display the town name in uppercase, or
@TOWN_NAME|C20@ will display the town name centered in a 20 character wide
section, or you can combine the two with @TOWN_NAME|UC80@ to display the town
name in uppercase centered in a 40 character wide section.
Optional format strings can be used to alter how the variable will be
displayed. A pipe character (|) is used to separate the variable name from the
format string, so for example @TOWN_NAME|U@ will display the town name in
uppercase, or @TOWN_NAME|C20@ will display the town name centered in a 20
character wide section, or you can combine the two with @TOWN_NAME|UC80@ to
display the town name in uppercase centered in a 40 character wide section.

Currently supported format specifiers are:

Expand All @@ -86,34 +91,35 @@ R## Pad and right align the text in a section of the given width (eg R20)
T Add thousands separator to the text (intended for numeric values)
U Convert the text to uppercase
u Convert the text to lowercase
Z## Zero-pad and right align the text in a section of the given width (eg Z3)
Z## Zero-pad and right align the text in a section of given width (eg Z3)

================================================================================
==============================================================================

In addition to the @-code variables like @TOWN_NAME@ mentioned above, there are
also boolean @-codes that can be used to conditionally show text. The format
for these @-codes is similar to the ?: ternary operator used in various
In addition to the @-code variables like @TOWN_NAME@ mentioned above, there
are also boolean @-codes that can be used to conditionally show text. The
format for these @-codes is similar to the ?: ternary operator used in various
programming languages. For example this type of @-code is used on the STATUS
screen: @IS_ME?Your status, #NAME#:#NAME#'s status@

This will display "Your status, #NAME#" if the user is looking at their own
status screen because "IS_ME" will evaluate to true, or it will display
"#NAME#'s status" if the user is looking at a teammates status, because "IS_ME"
will evaluate to false.
"#NAME#'s status" if the user is looking at a teammates status, because
"IS_ME" will evaluate to false.

There's a few things to keep in mind when using the boolean @-codes, because
certain decisions were made in how to implement the parser to keep it simple:

1) Variables embedded in the true/false portion of the string use # instead of
@, so in the example above you'll see that #NAME# was used instead of @NAME@
@, so in the example above you'll see that #NAME# was used instead of
@NAME@

2) The three characters @ # : are reserved characters, and so if you need to
display one of these characters in a boolean @-code, then you must use an
alternate string, which is \a for @, \h for #, and \c for :

In addition to the \a, \h, and \c strings mentioned above, boolean @-codes also
support \r to insert a carriage return, and \n to insert a linefeed, which
allows you to move to the next line if necessary.
In addition to the \a, \h, and \c strings mentioned above, boolean @-codes
also support \r to insert a carriage return, and \n to insert a linefeed,
which allows you to move to the next line if necessary.

Currently supported boolean @-codes are:

Expand All @@ -123,10 +129,12 @@ HAS_TEAM True if the player is a member of a team
HAS_TRAININGS True if the player has training sessions they can use
IS_ALCHEMIST True if the player's class is an Alchemist
IS_KING True if the player is the king
IS_ME True if the screen is showing the player's info, False if it is showing another player's info (ie a teammate)
IS_ME True if the screen is showing the player's info, False if it
is showing another player's info (ie a teammate)
IS_QUEEN True if the player is the queen

================================================================================
==============================================================================

Real-world examples of how all this works can be seen in TEXT\STATUS_CLASSIC.ANS
(as well as other files, but it has a good combination of everything)
Real-world examples of how all this works can be seen in
TEXT\STATUS_CLASSIC.ANS (as well as other files, but it has a good combination
of everything)
3 changes: 2 additions & 1 deletion RELEASE/DOCS/BETATEAM.TXT
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ The Good Guys in the later years 2001 - 2003
Olle Olsson (Fido 2:203/321) - Skilled bug hunter
Daniel Svanstrom (Fido 2:205/246) - Skilled bug hunter
Johan Klitkou (Fido 2:205/452) - ANSi ARTISt!
Johan Sch�ning (user) - Great player / suggestion machine / support / tester
Johan Sch�ning (user) - Great player / suggestion machine /
support / tester
18 changes: 9 additions & 9 deletions RELEASE/DOCS/SYSOP.TXT
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ you want to change.
The USURP.CTL file(s)
---------------------
As of version 0.24 the USURP.CTL file is optional, as "smart" defaults will
be used, which should hopefully work for most people. If you'd like to override
these defaults, then you can follow the usual step below.
be used, which should hopefully work for most people. If you'd like to
override these defaults, then you can follow the usual step below.

Copy the USURP.CTL from the SAMPLES subdirectory, and edit to suit your needs.

Expand Down Expand Up @@ -152,7 +152,7 @@ Batch File EXAMPLE for Usurper
%1 is the Node Number which the BBS software passes to the
batch file.

*** Example batch for a Single node system OR a single-CTL Multinode system START ***
*** Example for a Single node system OR a single-CTL Multinode system ***

REM The /P option forces Usurper to look for the dropfile in the given
REM directory.
Expand All @@ -176,7 +176,7 @@ USURPER /M%1 /PC:\BBS\NODE%1
*** Batch file example END ***


NOTE! You can also look at the samples files included in the SAMPLES subdirectory.
NOTE! You can also look at the samples files in the SAMPLES subdirectory.
MULTI1.BAT - RemoteAccess example
MULTI2.BAT - PcBoard example

Expand Down Expand Up @@ -440,13 +440,13 @@ Weapon.dat => All weapons for Usurper when running in CLASSIC mode.
Ynews.dat => What happened yesterday (ascii).
Rquests.dat => All quests created by the King.
Relation.dat => Social relations data file.
Children.dat => Children produced in the game. Npc kids are stored here as well.
Children.dat => Children produced in the game. Npc kids are saved here too.
Childmal.dat => MALE children names, used by NPCs to name their newborn.
Childfem.dat => FEMALE children names, used by NPCs to name their newborn.
Barrel.dat => Beer barrel lifters top list (the gym).
Gods.dat => All immortal characters are put here. immortals are never
deleted.
NpcChat.dat => Npc chat comments, when they are active in the Inn chat log.
NpcChat.dat => Npc chat comments, when they are active in the Inn chat.
Tnames.dat => Names used by computer players when forming teams.
A textfile which can be edited if you wish.
Monarchs.ANS => List of Monarchs, their comings and goings (ANSI).
Expand All @@ -458,7 +458,7 @@ MarrHist.ASC => List of Marriages in the Realm (ASCII).
BirtHist.ANS => List of Child Birth/Deaths in the Realm (ANSI).
BirtHist.ASC => List of Child Birth/Deaths in the Realm (ASCII).

Badwords.dat => you can find a sample of this file in the SAMPLES subdirectory
Badwords.dat => you can find a sample of this file in the SAMPLES dir.
put this file in the \DATA directory if you want Usurper
to replace bad words with others, defined by you.
The only area in which badwords are allowed is in
Expand Down Expand Up @@ -563,8 +563,8 @@ View the source : https://www.github.com/rickparrish/Usurper
**********************************
Registration is no longer necessary. If you would like to support the author
anyway, he previously indicated he accepts PayPal at [email protected]
It would be a good idea to reach out to that email address first, just to confirm
that he still has access to it.
It would be a good idea to reach out to that email address first, just to
confirm that he still has access to it.



Expand Down
20 changes: 10 additions & 10 deletions RELEASE/DOCS/USURPER.TXT
Original file line number Diff line number Diff line change
Expand Up @@ -250,9 +250,9 @@ pros and cons with being king;
(-) you cannot be in a team when you are king.
people wont appreciate you for the taxes, which you might have to set
if you want to be able to hire soldiers (security).
you have responsibility for the law and the proper behaviour of your subjects.
(you can of course be a bad king, but people will probably remove you
from office if you act mean and vicious)
you have responsibility for the law and the proper behaviour of your
subjects. (you can of course be a bad king, but people will probably
remove you from office if you act mean and vicious)
you must take care of all orphants produced by irresponsible parents!
a lot of people will hate your guts whatever you do.
you will probably be assassinated.
Expand All @@ -264,8 +264,8 @@ The Immortals
When a player completes his doings on earth, he may choose to retire from
Usurper altogether, or ascend to the world of the immortals (heaven).
Should you decide to become a immortal it does not imply immediate supreme
powers and "almightyness" at your fingertips. Contrary to popular belief, life in
heaven can be hell.
powers and "almightyness" at your fingertips. Contrary to popular belief, life
in heaven can be hell.



Expand All @@ -287,8 +287,8 @@ You can have kids. Your spouse can be nice to you (if you are lucky).
The drawbacks are mainly related to the kids. They can be kidnapped, put
in an orphanage or even die (causing grief and anxiety).
Having forced sex with other players/spouses can prove to be most
detrimental to yourself. Watch out especially for npc characters, who tend to pay back
as soon as the clock passes midnight :)
detrimental to yourself. Watch out especially for npc characters, who tend to
pay back as soon as the clock passes midnight :)


Raising children is an expensive business. If you can't afford to pay
Expand Down Expand Up @@ -321,12 +321,12 @@ Shortcuts to Success
* Are you willing to risk everything in these attempts?

If you answered yes to all of the questions above you should read further.
If you answered no to one or more of the questions : why not read this anyway?
If you answered no to one or more of the questions : why not read this anyway?

First of all, there are good and evil acts that can give you experience and
money. They can, of course, give you pain and death as well. Most important of
all, though, they influence your soul. Every bad act darkens your soul, and every good
lightens it. Swinging either side over the limit will give you some
all, though, they influence your soul. Every bad act darkens your soul, and
every good lightens it. Swinging either side over the limit will give you some
unpredictable and sometimes fatal consequences. Some races can withstand good
or evil better than others, and can therefore benefit longer.

Expand Down
Loading

0 comments on commit f269846

Please sign in to comment.