mtsedit/docs/usage.md

MTSEdit User Manual

This little tool can be compiled on any system easily. It's only dependency is SDL2. Without an argument, or with -h it prints an usage to stdout.

See also batch mode usage.

MineTest Schematics Editor by bzt Copyright (C) 2019 MIT license

./mtsedit [-v] [-l <lang>] <.mts|.schematic|directory>

Configuration

For the data directory, see blocks.csv. If not found, provide the path in MTSDATA environment variable.

The User Interface is translatable. It should detect your computer's language automatically, but if not, set the LANG environment variable, or add -l to command line (useful in .desktop and .lnk files). Supported languages:

• "en" English
• "hu" Magyar
• "es" Español
• "fr" Français
• "de" Deutch
• "pl" Polski
• "ru" Русский
• "pt" Português
• "it" Italiano

LANG=hu ./mtsedit monkeyisland.mts
./mtsedit -l hu monkeyisland.mts

Note that block names are user provided, there's no translation for those, unless you provide blocks_(lang).txt files too.

Interactive Mode

This is the default. If you start MTSEdit with a single parameter, being an MTS file's path, it will open it in the GUI editor. If that parameter is a directory, then MTSEdit will start with the "Load Schematic from File" screen.

Main Editor Window

You can find the toolbar A on the left. The icons are:

1. Load Structure
2. Save As
3. Save Preview
4. Layer Operations (small icons)
5. Undo / Redo (last two small icons)
6. Select Brush
7. Add Blocks to Palette

Layer Operations are: change orientation, flip structure, insert Y layer, remove Y layer, insert X layer, remove X layer, insert Z layer, remove Z layer.

Beneath the icons is the palette B. You can add blocks to here from the Add Blocks menu, and then you can quickly access them by shortcuts.

On the bottom left corner, you find the Layer-related options C:

1. Layer Up
2. Layer Down
3. Set Ground Level
4. Current Layer
5. Current Layer's Probability

The bottom line is the status bar D. You'll see the block names here as you hover over them. Messages like file saved also shown here. On the right, you see:

1. current block's probability (param1, 00 - 7F)
2. current block's rotation (param2, 00 - 1F)
3. current block's force placement indicator icon
4. the current zoom ratio, and
5. the brush's height and shape.

Everything else on the screen is the main editor area E.

Mouse Handling

Mouse Event	Description
mouse left button	place the selected block
mouse right button	rotate block
middle buttons (wheel)	scroll the editor area
Shift + wheel up/down	move the upper layers up and down
Shift + wheel left	rotate the current block counter clock-wise
Shift + wheel right	rotate the current block clock-wise
Ctrl + wheel up/down	zoom in or out

Keyboard Shortcuts

The GUI was designed in a way that you can use it without a mouse (actually it's faster to only use the keyboard in some cases). Therefore the keyboard shortcuts may seem odd; the reason for the layout is that Space is the main "painter" key, and the other functions are arranged close to it depending how often they are needed. Having a key of the letter that the function starts with was a secondary importance.

Main editor window:

Key	Description
PgUp / PgDn	change current layer
arrow keys	move cursor, select current block
Space	place selected block
Backspace	erase current block
Enter	flood fill (or erase) entire areas
Ctrl + arrow keys	scroll the editor area
Shift + up / down	move the upper layers up and down
Shift + left	rotate the current block counter clock-wise
Shift + right	rotate the current block clock-wise
+ / -	change current layer's probability
L	open load schematic window
S	quick save schematic to current file
Shift + S	open save as window
P	save preview PNG
Shift + P	save preview with structure cut in half
E	export blueprint PNG
Shift + E	export plain blueprint without legend
R	change orientation, rotate entire structure CCW
Shift + R	change orientation, rotate entire structure CW
F	flip the entire structure along the Z axis
Y	redo node placement from history
Z	undo last node placement / erase
X	insert a new, emtpy Y layer
Shift + X	duplicate current Y layer
Ctrl + X	remove current Y layer
C	insert a new, empty X layer
Shift + C	duplicate current X layer
Ctrl + C	remove current X layer
V	insert a new , empty Z layer
Shift + V	duplicate current Z layer
Ctrl + V	remove current Z layer
B	select brush (use geometric objects)
N	pick node
A	toggle show all / show current layer only
M / Tab	open block map, search all available blocks
;	toggle grid
, / <	zoom out
. / >	zoom in
0, Backquote	select Air block (erase mode)
1 - 9	quickly access one of the blocks from the palette
G	set current layer as ground level
D	toggle force placement flag
Q / Esc	quit MTSEdit

Add blocks to palette window:

Key	Description
any key	instant search blocks
Ctrl + number	add the Nth search result to the palette
Tab / Esc	return to main editor window