Borgcomm


BorgComm is a flexible and powerful system for both communications and player management. For help on the various commands, try out the +help topics below:

BorgComm user User commands
BorgComm admin Admin commands
BorgComm wizard Wizard commands
BorgComm mail Enhancements for BrandyMail
Other topics:
BorgComm templates Introduction to the templates
BorgComm template commands Template related commands
BorgComm group types The different knot types
BorgComm advanced More advanced help

Note that the wizard help section is only viewable by wizards and that Pernworld uses @mail and not BrandyMail/+mail, so these sections have been left out.


User commands

BorgComm User Commands:

+comm Show version information
+comm/list List all knots
<code> +me Join a public knot
<code> -me Leave a public knot
<code> +quiet Quiet a knot so that you hear no speech
<code> -quiet Unquiet a knot again
=<code> [:/;/|]<text> Say, pose or emit <text> on the <code> knot
=<code>/<field> <text> Say, pose or emit <text> to all users whose <field> matches yours
<code> .who List connected users
<code> .who/all List all users.
<code> .who/admins List all admins on <code>
<code> .who/<field>:<txt> List all users whose <field> matches <txt>
<code> .who <template> List connected users using template <template>
<code> .who <template>/<field>:<txt> List all users whose <field> matches <txt> using template <template>
<code> .motd View <code>'s message of the day
<code> +ignore <player> Ignore all speech by <player> on <code>
<code> -ignore <player> Remove a previously imposed ignore
<code> .who/ignoring List all players you are ignoring on <code>
<code> .who/ignoredby List all players who are ignoring you on <code>
<code> .fields List <code>'s fields
<code> .field <player>/<field> Shows <player>'s <field> field on <code>

(top)


Admin commands

The admins (including all wizzes) on the knots may use the following commands to control those knots:

<code> +admin <player> Add <player> as admin
<code> -admin <player> Remove <player> as admin
<code> +user <player> Add <player> as user
<code> -user <player> Remove <player> as user
<code> =motd <text> Set MOTD
<code> +motd <text> Add <text> to MOTD
<code> -motd Clear MOTD
<code> +text <field> Add text field
<code> -text <field> Remove text field
<code> =text <user>/<field>=<text> Set <user>'s text <field> to <text>
<code> +boolean <field> Add boolean field
<code> -boolean <field> Remove boolean field
<code> =boolean <user>/<field>=on|off Set <user>'s boolean <field> on or off
<code> .fields List fields
<code> +restrict <field> Restrict <field> to admins only
<code> -restrict <field> Unrestrict field
<code> +squelch <player> Mute <player> on <code>
<code> -squelch <player> Remove <player>'s mute on <code>
<code> cleanup Remove non-player users and admins

The templates may also be set by admins.

(top)


Introduction to the Templates

A template is the format that the output from a knot user listing (.who) is displayed with. It consists of a list of fields and the width each field should be in the output. The field is seperated from the width by a colon. The total width, including spaces between fields, should be no more than 75 characters. Each template has a name, up to ten characters. The default template is called "Default".

(top)


Template Related Commands

The following knot system commands manipulate templates:

<code> =template <template>=<field list> Sets <template> to use <field list>.
<code> -template <template> Deletes <template> from use.
<code> .template <template> Shows the field list for <template>.
<code> .templates Lists the available templates.

Example <field list>: Quiet:1 Name:15 Sex:3 Location:30 Idle:4

(top)


Group Types

There are different knot types, each having different properties:

  • PUB - Public knots. Anyone may add themselves to this knot type.
  • PVT - Private knots. The standard type. Admins must add/remove users.
  • DRK - Dark knots. Only those on a knot may use the roster commands.
  • SEC - Secure knots. Only admins may use the roster commands.
  • INT - Internal knots. For use by wizards in coding commands.
  • BRD - Broadcast knots. Only admins may chat on these knots.

(top)


More Advanced Borgcomm Help

The following help describes the BorgComm system in more intricate detail.

Knot Types

Essentially, there are only two types of knots that are used by ordinary players: public and private.

  • Public: Public knots are those which any players can add and remove themselves from.
  • Private: These knots are those which an admin has to add or remove a player.

Field Types

The columns shown in a .who are called fields. There are five field types: Code, Text, Boolean and List. The command '<code> .fields' lists all of a knot's fields, and should be looked at while reading the following help.

  • Code: Coded fields are those which admins cannot set and are worked out via a small piece of code. They are fields like Sex, Name, and Location.
  • Text: These are fields which admins can set using the '<code> =text' command and consist of a text string. The Position field on most knots is an example of this.
  • Boolean: These fields are either on (yes) or off (no) and can only be set one of these two ways. An example is the Quiet field.
  • List: These fields cannot be changed by admins and contain data in the form of a list. Examples are the Ignoring, IgnoredBy and User lists.

In all the knot system commands, <field> values may be one of those listed above. In a command like '<code> .who/<field>:<text>' <text> is necessary for all the field types except for list fields. <text> may also be a wildcard string, like '*John*'. A command like '<code> .who/ignoring' is therefore just the above command without ':<text>' since Ignoring is a List field.

The same concepts apply to the CommSearch() function. A call of CommSearch(<code>/<field>:<text>) returns a list of user dbrefs which would be returned if the command '<code> .who/<field>:<text>' was used.

Hopefully this explains the lets you understand the knot system more and allow you to use it more to your advantage.
(top)

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License