CF GUI HELP

Questions related to Carrion Fields can be answered using the in-game HELP command, or by visiting
our forums at forums.carrionfields.com.

  Enter: guihelp <number> to learn about a feature.

   1 - Variables
   2 - Highlights
   3 - Aliases
   4 - The Friends and Enemies System
   5 - Gauges and the 'Setprompt' Command
   6 - Item Journal
   7 - Target Swapping
   8 - Logging
   9 - Combat Damage Colors
   10 - Mapping
   11 - Advanced Aliases & Scripting
   12 - Useful Utility Commands - NEW, Must-Read!
   0 - Troubleshooting

Note: *Right-click* the top area in any of the windows or elements on this screen, and you can
unlock them, move them, or even close them. If you mess up, guireset will revert to your previous
state. Use guisave to save the layout once you're satisfied. If you accidentally closed a window,
use 'guirestore'.

To get started quick: Type alias to create aliases, var to create variables.

guihelp 1
Variables

Syntax: var <variable name> <value>
        var to see and manage existing variables

Variables are special words that can be set to stand for another for use in aliases (which are
detailed in guihelp 2).  For example, you might set the variable @food to 'chicken', or @target to
the name of the person you're trying to kill.  This makes your aliases more flexible and
multifunctional.

Some of the variables are "default variables," which are recommended and used throughout your
interface.  In the bar at the bottom of your screen, you will see six boxes labeled Target, Action,
Ally, Aid, Mainhand, and Offhand. These are important variables to set, so they're listed in a
place where you can always see them.  On the right side of your screen, there is also an alias and
variable window, which displays all of your set aliases and variables for your convenience.

If one of your variables refers to an item, we recommend that you use the in-game KEYWORD command
and copy all of the keywords, encased in single-quotes (example: 'whole chicken') into your
variable to avoid accidentally using the wrong item.

guihelp 2
Highlights

Syntax: high <color> <text>
        high to see and manage existing highlights

Highlights change the color of certain words or phrases.  This can make it easier to see when
important affects fall, or if you walk into a room with a "chest" in the description, for example.

For a full list of colors, use the showcolors command.

Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

Enter 'guihelp' alone to return to the main help menu.

guihelp 3
Aliases

Syntax: alias <pattern> <full command> to create or modify an alias
        alias to see and manage existing aliases
        alias remove <pattern> to delete a single alias
        alias clear_yes to delete all aliases
        Special characters: # = Your input, @ = Variable, ; = Split

Aliases are like shortcuts that allow you to enter a complex command by just typing a few letters.
You can make your own using the alias command, and you can even throw in variables you create using
the var command.

Examples:
alias heal co 'heal'
Input:      Output:
heal     -> co 'heal'
heal pal -> co 'heal' pal

alias bt bash @target
Set @target or any other variable with the variable command (i.e. var @target Joe). If you enter
something else after 'bt', your command will replace the @target.

Input:       Output:
bt        -> bash Joe
bt giant  -> bash giant

alias aa @action @target
(If we set @action to "trip" using: var @action trip)
Input:       Output:
aa        -> trip Joe
aa giant  -> trip giant

alias gc get # @container;eat #
The # character translates into whatever you enter after the pattern. The ; character splits your
alias into multiple commands. So, if @container = "knapsack"...
Input:            Output:
gc bread       -> get bread knapsack
                  eat bread

Need more help?  Ask on The Carrion Fields Official Discord channel!


guihelp 4
The Friends and Enemies System

Syntax: info
        friend <name>
        enemy <name>
        neutral <name>
The Friends and Enemies System exists to help you keep track of characters you encounter. You can
add friends, enemies, or just neutral people to the list, and then fill in details about them as
you learn more about them in-game.
This useful feature might help you remember an enemy's cabal, a warrior's specializations or a
shapeshifter's forms. On the WHO and WHERE lists, names of friends will be tinted blue, while
enemies' will be tinted red.

* We recommend that you begin by typing the info command by itself. *

Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

Enter 'guihelp' alone to return to the main help menu.

guihelp 5
Gauges and the 'Setprompt' Command

Syntax: setprompt (shows all options)

The gauges on the bottom console show your health, mana, movement and experience to next level
based on the percentage of each. They gather those numbers from your prompt, from level-up messages,
 and from the SCORE command, when you use it.

The setprompt command fixes your prompt to work with the GUI. Typing setprompt by itself will set
the default Carrionfields prompt for you. You can also make your own prompt using the format
described in the in-game HELP PROMPT.

Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

Enter 'guihelp' alone to return to the main help menu.

guihelp 6
Item Journal

Syntax: journal to see a list of stored items
        journal <item number> to view a stored item identification
        journal remove <item number> to remove a stored item identification
        journal <keyword> to search for a keyword, which could be any word in the stored item
identification. Suggested keywords include item type, material, attack type, or affect type.

The Item Journal is an automatic feature that automatically logs and stores every item that you
identify.

Because some methods of identification are imperfect (i.e. the lore skill), you may wish to use
journal remove <item number> on an item before trying a more reliable method to correct any bad
data.

Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

Enter 'guihelp' alone to return to the main help menu.

guihelp 7
Target Swapping

Syntax: t1 <name>
t2 <name>
t3 <name>
t4 <name>

Each of these commands adds an alternate target to buttons at the top of your interface. The t1
command sets a name that will become your Target when you press the F1 key or click the button. The
t2 command corresponds to your F2 key, and so on.

For example: Edward is your Target, and Jacob is your t1 alternate target. You press F1 or click on
Jacob's name. Jacob then becomes your Target.

The a5, a6, and a7 commands can be used to add alternate actions to the buttons at the top of your
interface.

See guihelp 1 for more on The Targeting System.

Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

Enter 'guihelp' alone to return to the main help menu.

guihelp 8
Logging
Syntax: autolog
        log <filename>
        searchlog <filename> <word or phrase>

Examples: log cabalraid
searchlog cabalraid is DEAD!!

The autolog command toggles automatic logging of each and every session.  Those raw logs go into
the log folder and are named using a date and time code.

You can also use the log command to start a separate log. If you enter a filename that doesn't
exist, it will create it as a text file in the log folder, which can be easily accessed by clicking
the 'Logs' button at the top right corner of the screen. Use log off to stop logging. The searchlog
command will find instances of a word or set of words in a log.

This quick logging function was contributed by a member of the Mudlet community. If you want to
create more robust logs, you may use Mudlet's stock logging or replay features, located in the row
of buttons to the right of the input prompt.

Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

See the Mudlet forums for more on The Simple Logger

Enter 'guihelp' alone to return to the main help menu.

guihelp 9
Combat Damage Colors
Syntax: damcolor <on/off>
              damcolor <incoming/outgoing> <color>

You can change the colors of damage affecting your character and damage that your character is
doing to others.  This makes it easier for many players to immediately understand what is going on
in the heat of battle.

Use the showcolors command for a list of valid colors.

    Helpful Links:

Chat our friendly immortals and playerbase for help: Carrion Fields Discord

For help with the client, visit The Mudlet Manual

Enter 'guihelp' alone to return to the main help menu.

guihelp 0
Troubleshooting

Many issues with the GUI can be fixed by entering SCORE or AFF in-game. On rare occasions, you may
need to use the setprompt command again. If something seems hopelessly broken, try restarting
Mudlet. If that fails, try creating a new profile and reloading this package. If you have further
questions, comments or suggestions, please email [email protected] and I'll do my best to
help you out. If you're having trouble with an alias or some other type of customization, and
copying/modifying an existing one isn't cutting it, check out Mudlet's wiki and forums - they do a
great job and the community there is extremely supportive.