mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-10 04:57:00 -04:00
twanvl
664c12ec52
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1277 0fc631ac-6414-0410-93d0-97cfa31319b6
75 lines
3.3 KiB
Plaintext
75 lines
3.3 KiB
Plaintext
Interactive command line interface
|
|
|
|
DOC_MSE_VERSION: since 0.3.7
|
|
|
|
--Description--
|
|
|
|
]]mse --cli [<em>my-set.mse-set</em>]
|
|
|
|
The MSE interactive command line interface provides a way to work with set files without a graphical environment.
|
|
The CLI shows a prompt where commands can be entered, which are then executed by MSE.
|
|
|
|
--Commands--
|
|
|
|
! Command Short version Description
|
|
| @:help@ @:?@ Show a help screen describing the available commands.
|
|
| @:quit@ @:q@ Exit the MSE command line interface.
|
|
| @:load@ @:l@ Load a set file. The current set will be unloaded.
|
|
For example:
|
|
]:load my-set.mse-set
|
|
| @:reset@ @:r@ Clear all variable definitions.
|
|
| @:cd@ @:c@ Change the working directory.
|
|
| @:pwd@ @:p@ Print the current working directory.
|
|
| @:!@ Perform a shell command. For example @:! dir@ shows a directory listing.
|
|
| ''other'' Execute the command as a line of [[type:script]] code.
|
|
The script has access to the loaded set and all [[fun:index|built in functions]].
|
|
|
|
--Raw mode--
|
|
|
|
]mse.exe --cli --raw
|
|
|
|
For interfacing MSE with other programs the raw mode is most convenient.
|
|
|
|
In the raw mode the only output is in response to commands.
|
|
For each command a single ''record'' is written to the standard output.
|
|
The records consists of:
|
|
* A line with an integer status code, @0@ for ok, @1@ for warnings, @2@ for errors.
|
|
* A line containing an integer ''k'', the number of lines to follow.
|
|
* ''k'' lines, each containing UTF-8 encoded string data.
|
|
|
|
Strings are not further encoded or escaped.
|
|
|
|
In this mode multi line strings can be transfered from MSE without much encoding/parsing hassle.
|
|
|
|
The behaviour of the raw mode is guaranteed not to change between versions of MSE (subject to bugs and changes in the scripting language),
|
|
for the normal mode no such guarantee is made.
|
|
|
|
--Example--
|
|
|
|
Here is an example session, the text entered by the user is shown in blue.
|
|
|
|
]]$ <span class="hl-input">mse --cli</span>
|
|
] ___
|
|
] __ __ _ ___ _ ___ _ _ _ |__ \
|
|
] | \/ |__ _ __ _(_)__ / __|___| |_ | __|__| (_) |_ ___ _ _ ) |
|
|
] | |\/| / _` / _` | / _| \__ | -_) _| | _|/ _` | | _/ _ \ '_| / /
|
|
] |_| |_\__,_\__, |_\__| |___|___|\__| |___\__,_|_|\__\___/_| / /_
|
|
] |___/ |____|
|
|
]
|
|
]]> <span class="hl-input">:load myset.mse-set</span>
|
|
]]> <span class="hl-input">first_card := set.cards.0 <span class="hl-comment"># the first card</span></span>
|
|
][[card]]
|
|
>>>>> <span class="hl-input">first_card.name</span>
|
|
]"Pineapple of Doom"
|
|
>>>>> <span class="hl-input">write_image_file(first_card, file: "firstcard.jpg")</span>
|
|
]]> <span class="hl-comment"># the image file "firstcard.jpg" is now saved</span>
|
|
]]> <span class="hl-input">:! dir</span>
|
|
]2008-08-04 22:57 92 891 firstcard.jpg
|
|
] 1 File(s) 92 891 bytes
|
|
] 0 Dir(s) 986 562 560 bytes free
|
|
]]> <span class="hl-input">:reset</span>
|
|
]]> <span class="hl-input">first_card.name <span class="hl-comment"># variable was cleared</span></span>
|
|
]]<span style="color:red">ERROR:</span> Variable not set: first_card
|
|
]]> <span class="hl-input">:quit</span>
|
|
]Goodbye
|