This document last updated: 9/28/2001
Table of Contents:
1. Introduction
        -History
        -Purpose
        -Team

2. Options Dialog information

3. The Scripts
        -Files
        -Formats
            -Global Tags
            -Tab
            -Button
            -Label
            -Frame
            -List Box
            -*.lst
            -*.dlg

4. Known Issues
5. Revision History
6. Other Information

Welcome to Accomplice v2.0 "Your Partner in Crime."  Accomplice is a fully feature, fully scriptable Game Master tool for Ultima Online Emulators.  While originally designed for UOX3, Accomplice's unique scripting flexibility allows scripts to be created and tailored to the needs of any emulator.

Accomplice 1.0 was first created in July, 2000 as a UOX only GM tool.  This tool premered a format similar to that of the UOX classic "CGMT."  Accomplice only had one original version, consisting of most commands for UOX.  Despite positive encouragment, the tool was never updated for lack of Developer interest (I get bored easily).

Accomplice 2.0 was created to follow the same general verticle tab layout of Accomplice 1, this however is where the similarities end.  Accomplice 2.0 possess an extreme flexible (yet at times complex) script engine.  This engine impliments a grid system to allow the "scripter" to easily create buttons that align correctly with each other to allow for a smooth interface through the script.  The system allows users to create a (basically) unlimited number of tabs, buttons, labels, frames, and even listboxes to provide extend functionality.

The Accomplice Team currently consists of:
"Zippy"  : Lead (Only) Developer
"Sephiroth"  : Scripter
"Alkiser" : Webmaster

These values are stored in accomplice.ini along with other user specific information.

Command Prefix: The SINGLE character to be placed in front of all commands entered into the  client.  Do not include this in script files.

Always On Top: HIGHLY recommended.  Places Accomplice as the top most window,  always visible in front of the UO client.  Makes the tool very easy to access.

Link to UO: Also Recommended; This links Accomplice to your UO Client window,  automatically minimizing and maximizing Accomplice with the client, keeping it out of the  way when you minimize your client to do other things (like chat, or update your  Accomplice Script)

Prefix Hex: This prefixes hex numbers in commands with "0x".  This is provided for compliance  with UOX version 0.95 and up, and is REQUIRED for those users.  (NOTE: Some  *.lst files require hex values to be "hardcoded\" into them.  This is because multipul  parameters in an lst if are treated as STRINGS and are not modified before being sent  to the client.)

^Top^
Accomplice.cfg File Format:
tag=parameter1,parameter2,optional
(All strings require quotations unless otherwise specified, all numbers are decimal.)

PARAMETERFORMAT:
(Any number of the following values)
N - No parameters for this command
D - Decimal Parameter
H - Hex parameter
W - Open Dialog file. MUST BE ONLY PARAMETER
S - String parameter (String must be the LAST parameter, and can have no more than 4 number parameters before it)

LINK:
PROMPT - Indicates Accomplice should prompt the user for the value(s)
"LinkName" - indicates the button's value is linked to Listbox "LinkName"

Example:
Button=1,1,30,1,"Who's Online?","who",N
Button=1,1,30,1,"Goto Character","gochar",HHHH,PROMPT,"Enter 4 part serial number:"
Button=1,1,30,1,"Add this item","additem",D,"ItemList"
Button=1,1,30,1,"Open Charater Dialog Box","chars.dlg",W

Example:
Label=1,1,25,1,"Welcome to Accomplice"

Example:
Frame=1,1,40,40,"Add Items"

A listbox is "linked" to a Button, and reads values from an *.lst file.

Internal Name is used to link this listbox to a Button.  File name is a listbox menu file (*.lst)

Example:
Listbox=1,1,33,20,"ItemList","items.lst"

Optional Format Tag:
format=FORMATPARAMETERS,Prompt
Use this tag if you wish to prompt users for other values in addition to the value obtained from the listbox.  This is useful for such things as a UOX 'set command.  The listbox would contain a list of skills, and then prompt the user for the value to set.  You may prompt for upto 8 values, or upto 4 values and a string value.  The string value must be LAST, and the listbox value will always be FIRST.  This format tag and prompt is IDENTICAL to the one used with Buttons.  If no format tag is supplied, the format will be taken from the one supplied with the button, and the user will not be prompted for any additional values.

Example:
format=SD,"Enter other DECIMAL value:"
In this exmaple, the value from the listbox is treated as a string, and the user is prompted for an additional value.

format=DDHDS,"Enter a decimal, hex, decimal and string:"
This exmaple will prompt the user for 3 numbers and a string in addition to the listbox value.  The middle value is hex.

Menu Name
{
Sub menu 1
{
name tag=VALUE
Sub Menu
{
name tag=VALUE
}
}
}
name tag=VALUE

Sub Menus:
are defined by simply placing a name followed by a { } pair.  There is no physical limit to number of submenus, but let's keep it realistic.

name tags:
NO QUOTATIONS
May be as long as you like (be realistic) followed by = and then a SINGLE value.  If you wish to have more than one value, it must be linked to a string parameter in it's button.

Menus are displayed in the listbox with a > in front of them showing they are menus and NOT values.  This > is added for you, and you should not include it in the lst file.

Sub menus all have a < Back as their first entry so the user my return to the previous menu selection.

A dlg files is used in conjunction with a Button.  Supply the FORMATPARAMETER W in the button's format parameter list, and supply the dlg file name instead of a command.
 
 

title=S	Title to be displayed in title bar of this Dialog. (NO QUOTATIONS)
rows=X	Grid definition; size of each row on the dialog.
columns=Y	Grid definition; size of each column
hspace=X	Grid definition; padding around controls
vspace=Y	Grid definition; padding around controls
xsize=X	Width of Dialog (200 default)
ysize=Y	Height of Dialog (100 default)

Controls on a dialog box work exactly the same as controls on a Tab.  The only difference is you may NOT open a dialog box from within a dialog box.
 
 

Multipul UO Windows:  Some programs (such as UOGateway) modify the client so it can run more  than one copy at once.  This may confuse Accomplice, and commands may appear in  the wrong window, or not at all.  FOR DEVELOPERS: Accomplice sends the  command to the top msot window that has the window class "Ultima Online".  If your  program modifies the window class, Accomplice will not be able to send it commands.

Script Reloading: Might occationally crash Accomplice.  This is provided mainly for script  testing purposes, and users should avoid using this command.

Link2UO: May OCCATIONALLY cause problems, such as not reactivating the Accomplice window properly.  This should be completely fixed as of 2.0b6

Check for Accomplice updates, scripts, and forums at http://accomplice.uoxdev.com/

The Accomplice Source Code is currently CLOSED.  In the spirit of UOX, the source will (at some point) be released.  This will most likely be when I feel that Accomplice has reach a "Final" state.  Also when the code is cleaned up, and I can feel proud of it :-).

Accomplice Program, Libraries, File formats Copyright 2001 Bryan "Zippy" Pass. All rights reserved.
Accomplice web page, Icons, Bitmaps Copyright 2001 Casey "Alkiser" McAdams. All rights reserved.

"Ultima Online" is a copyright of Origin Systems, Inc. and Electrionic Arts.

Much of the art associated with Accomplice was originally taken from screen shots of Ultima Online.  These images are Copyright Origin Systems, Inc/Electronic Arts.

This program may be freely distributed, please include this file.