Edit Modes
Sanny Builder supports many games and platforms and so there is a predefined configuration for each supported game called an edit mode.
Edit modes supply Sanny Builder with the following information:
a target game
paths to files with the game data
Sanny Builder stores the edit modes within the data folder. When a subfolder inside data contains a file named mode.xml, this file is automatically loaded as the configuration file for the respective edit mode.
The modes configuration is automatically loaded upon startup of Sanny Builder. If needed, it can also be manually reloaded by running Sanny Builder with the -x CLI option.
The configuration of the modes is open to modification and extensions, and users can create their own modes for specific needs.
File Format
The mode.xml file is formatted in XML and is editable using any text editor.
Each configuration file should begin with the following XML declaration:
<?xml version="1.0" encoding="UTF-8"?>Following the declaration, there should be a single root node, <mode>. The file must only contain one root node.
Within the <mode> tag, there are both mandatory and optional attributes, as described below. The content of the <mode> tag consists of specific tags (properties) that define paths to directories or files.
Mode Attributes
id
id is a required and unique identifier of the mode. Sanny Builder uses the id to save some user settings for this mode, e.g. a game directory.
A valid value for this attribute is a unique series of characters not used for any other mode's id.
extends
A mode can extend another mode (a parent mode) to reduce a number of duplicated properties. It is helpful for different versions of the game where most of the configuration is the same except for a few properties. By extending another mode the mode inherits all its unique properties and can override them with the new values.
The parent can also extend another mode.
A valid value for this attribute is an id of another mode.
title
title defines the mode's displayed name. Due to the interface constraints avoid long names and keep it within the limit of 24 characters.
game
The game attribute defines a target game for the mode. There are 6 valid values:
gta3vcsalcsvcsvc_mobilesa_mobile
Before disassembling or compiling a script, make sure that the correct edit mode is active. Each game has an unique script format and the scripts compiled for one game are not compatible with scripts for another game. Even if the script is compiled without errors, the game would crash trying to read a script in different format.
Sanny Builder displays a game icon in front of the edit mode name so you know the target game.
type
One mode for each target game must be a default one. It means Sanny Builder uses this mode when run with the --game CLI option.
The valid value for this attribute is default. Omit this attribute for non-default modes.
Mode Parameters
arrays
path to CustomArrays.ini
copy-directory
path to a directory where to put a compiled script on Compile + Copy run.
Has a required attribute type:
type="scm" - used for regular .scm scripts
type="cleo" - used for scripts with directive {$CLEO}
classes
path toclasses.db
Has an optional attribute autoupdate:
autoupdate="yes" - let autoupdate tool replace this file with the latest version from the SBL website
A mode may have multiple <classes> elements.
constants
path toconstants.txt
data
path to the mode directory
enums
path to enums.txt
Has an optional attribute autoupdate:
autoupdate="yes" - let autoupdate tool replace this file with the latest version from the SBL website
A mode may have multiple <enums> elements.
ide
path to either an .ide or .dat file:
.ide files contain game model names and characteristics
.dat files contain paths to other .ide files
ide element may have an optional base attribute to specify a folder that is used to resolve relative paths in the .dat file.
<ide base="@game:\">default.dat</ide>Without base all relative paths are resolved starting from the location of the .dat file.
A mode may have multiple <ide> elements.
keywords
path to a list of keywords
labels
path to CustomLabels.ini
missions
path tomissions.txt
library
librarypath to a JSON file with scripting command definitions used in the target game. Available for download in Sanny Builder Library.
Has an optional attribute autoupdate:
autoupdate="yes" - let autoupdate tool replace this file with the latest version from the SBL website
A mode may have multiple <library> elements.
opcodes
path to a file with opcodes. Can be used multiple times with different files. This file is optional if you have specified a library path (see above).
templates
path to a file with the mode's exclusive templates
Has a required attribute type:
type="default" - path to the predefined templates shipped with Sanny Builder
type="custom" - path to a file with user templates added via the Add Template form. This file is never overwritten during a Sanny Builder update.
text
path to a .gxt file
<text> has one required attribute: format. The supported values are:
gta3: .gxt has one table, plain keys, ANSI encoding
vc: .gxt has multiple tables, plain keys, ANSI encoding
sa: .gxt has multiple tables, hashed keys, ANSI encoding
sa_mobile: .gxt has multiple tables, hashed keys, UTF-16 encoding
variables
path to CustomVariables.ini
examples
optional path to opcodes.txt. Will be autogenerated from library definitions when not set.
Has an optional attribute autoupdate:
autoupdate="no" - exclude this file from automatic SBL update
cleo-default-extensions
path to a file with the list of default extensions enabled when the compiler finds {$CLEO} or {$USE CLEO} directives. Each extension should be listed on its own line.
Built-in Variables
Sanny provides a few variables that can be used in parameters and attributes (if applicable).
@game: - path to the game directory configured in the options
@sb: - path to the Sanny Builder directory (where sanny.exe is located)
Both paths do not include the trailing slash.
Available Modes
Sanny Builder offers many different modes, and their number may vary from version to version:
Title
Id
Naming schema
Parameters order
Game
GTA III
gta3
community
custom
all versions of GTA III
GTA VC (SBL)
vc_sbl
Rockstar
original
all versions of Vice City
GTA VC
vc
community
custom
all versions of Vice City; deprecated in v4.0, use VC SBL instead
GTA SA (v1.0 - SBL)
sa_sbl
Rockstar
original
SA v1.0
GTA SA v1.0
sa
community
custom
SA v1.0; deprecated in v4.0, use SA SBL instead
GTA SA v2.0
sa_v2
community
custom
SA v2.0
GTA SA (v1.0 - SCR)
sa_scr
Rockstar
original
SA v1.0; removed in v4.0, use SA SBL instead
GTA LCS
lcs
Rockstar
original
all versions of Liberty City Stories
GTA VCS (PSP)
vcs_psp
Rockstar
original
VCS for PSP
GTA VCS (PS2)
vcs_ps2
Rockstar
original
VCS for PS2
VC Mobile
vc_mobile
community
custom
VC Android and iOS versions
SA Mobile
sa_mobile
community
custom
SA Android and iOS versions
The naming schema defines the way of describing the opcodes. The community schema has the names randomly guessed over the years, such as actor or thread. The Rockstar schema has the original taxonomy used by the game developers (e.g., char or script) that is consistent with the game's inner structures.
The parameters order defines the way of arranging the opcode parameters. In the custom order the parameter with the higher index may go earlier in the script. This is applicable to community opcode descriptions. The original order has all parameters arranged from the smallest index to the largest index. This goes along with the Rockstar schema to make scripts look like they are meant to be by the developers.
Experimental Modes
Experimental modes provide early access to new features, but not ready for production use and are subject to change without notice.
Experimental modes can be updated and backward compatibility with existing scripts is not guaranteed.
Version 4.1 includes two experimental modes:
GTA SA v1.0 - Somersault. This mode provides access to new script compiler toolchain called 'Somersault'. You can learn more about it at https://next.sannybuilder.com. This compiler is in early stage of development.
GTA SA v1.0 - SAMPFUNCS. This mode provides easy way to write scripts using SAMPFUNCS extensions. Currently this extension is undergoing documenting in Sanny Builder Library and some naming conventions are not finalized yet.
Selecting a mode
To change the mode, click at the right bottom corner of the Sanny Builder's main window. A list of the available modes will appear. As you click the mode name Sanny Builder makes all necessary adjustments and you may continue working immediately.
List of displayed modes can be customized via Options.
To select the mode using CLI run Sanny Builder with the --mode option. To select a default mode for the game, use the --game option.
Running Sanny Builder with the -x option reloads the modes configuration and updates the list of modes.
You can register a new shortcut to instantly refresh edit modes configuration without having to close Sanny Builder. Add the following configuration in the User tools:
Path: sanny.exe
Parameters: -x --no-splash
Shortcut: <any combo of your choice>
Last updated