Skip to content

Latest commit

 

History

History
154 lines (112 loc) · 6.96 KB

cli.md

File metadata and controls

154 lines (112 loc) · 6.96 KB
Raw

Command Line Interface

--compile

--compile <input file path> [output file path] - compiles the file and exits

sanny.exe --compile C:\myscm.txt C:\myscm.scm

{% hint style="info" %} The output file path parameter is optional. If there is no output path parameter, the compiler uses the format rules to compute the output file name. {% endhint %}

{% hint style="info" %} The input file must have no errors. If there are errors found during compilation, they will be logged in the file compile.log. When compilation ends, the program shuts down. {% endhint %}

Shortcut: -c

--decompile

--decompile <input file path> [output file path] - decompiles the file and exits

sanny.exe --decompile C:\myscm.scm C:\myscm.txt

{% hint style="info" %} The output file path parameter is optional. If there is no output path parameter, the compiler uses the format rules to compute the output file name. {% endhint %}

{% hint style="info" %} The input file must have no errors. If there are errors found during decompilation, they will be logged in the file compile.log. When decompilation ends, the program shuts down. {% endhint %}

Shortcut: -d

--use-source - optional argument that makes the decompiler use the source code embedded in the script (if present). By default the source is ignored.

sanny.exe --decompile C:\1.cs --use-source

--debug

--debug - toggles debug options

sanny.exe --debug 110000

--game

--game <game> - selects the default mode for the given game. Known game values are:

  • gta3
  • vc
  • sa
  • lcs
  • vcs
  • vc_mobile
  • sa_mobile

Shortcut: -g

sanny.exe --game sa

--mode

--mode <id> - selects the mode by id. Modes and their ids are defined in respective mode.xml files.

Shortcut: -m

sanny.exe --mode vcs_psp

--no-splash

--no-splash - runs Sanny Builder without the splash screen

sanny.exe --no-splash

-x

-x - reloads edit modes configuration (useful for testing the mode changes)

sanny.exe -x

--option

{% hint style="info" %} Available since v3.8.0 {% endhint %}

-o <option name> <value> - sets the value of the specified option. To set multiple options, list each of them individually:

-o <option1 name> <option1 value> -o <option2 name> <option2 value> ... -o <optionN name> <optionN value>

Option name can be one of the following:

{% hint style="warning" %} This list is not final and subject to change at any moment. {% endhint %}

Name Allowed Values Options Tab
Editor::ShowPanel 0, 1 Editor
Editor::ShowOpcodeInfo 0, 1 Editor
Editor::ShowLineNumbers 0, 1 Editor
Editor::ShowGutterBorder 0, 1 Editor
Editor::OpenLastFile 0, 1 Editor
Editor::OpenAllClosedFiles 0, 1 Editor
Editor::ConfirmExit 0, 1 Editor
Editor::LanguageService 0, 1 Editor
Editor::SemanticConstHighlighting 0, 1 Editor
Editor::IdentifiersListAuto 0, 1 Editor
Editor::ScanDistance 0..65535 Editor
Editor::Lang known locale id General
Editor::QuickGameLoading 0, 1 General
Editor::ShowProgress 0, 1 General
Editor::ShowReport 0, 1 General
Decompiler::OverwriteOutputFile 0, 1 General
Decompiler::ManualIMGOpening 0, 1 General
Decompiler::HexadimalOffsets 0, 1 Formats
Decompiler::LabelsFormat 0, 1, 2 Formats
Decompiler::AlwaysWriteOpcodes 0, 1 General
Decompiler::ReplaceMissionNumbers 0, 1 General
Decompiler::InsertOriginalMissionNames 0, 1 General
Compiler::ShowIMGWarning 0, 1 General
Compiler::CheckConditions 0, 1 General
Compiler::CheckLocalVariables 0, 1 General
Compiler::AddExtraInfo 0, 1 General
CustomNames::UseCustomLabels 0, 1 Formats
CustomNames::UseCustomVariables 0, 1 Formats
CustomNames::UseCustomArrays 0, 1 Formats
CustomNames::Format 0, 1, 2 Formats

{% hint style="info" %} Options set via CLI are not persistent and only applied to the current session. On the next launch Sanny Builder will use values stored in the settings.ini. {% endhint %}

Shortcut: -o

sanny.exe -o Compiler::CheckConditions 0 -o Editor::LanguageService 1