Executive summary: make a text file with some commands in it and read this file in using Import Settings. You can perform almost every Mineways operation by using a command instead of the user interface. You can change how the mouse buttons are mapped. You can also temporarily change, add, or clear any blocks you like for an export. You can also associate scripts with Mineways so double-clicking any of them starts Mineways and runs the script.

• Mineways Scripting Language
  • Model File Import
• Scripting Overview
  • Model Export Commands
    • Export example
  • Scripting Interface Commands
    • Multiple exports example and tools
  • Sketchfab Export Commands
    • Example
  • Script-Only Commands
    • Change blocks command examples
  • Comments
    • Examples
• Command Line Options
• Associating .mwscript files with Mineways
• Default Rendering Options
• Perl Script Example

Mineways Scripting Language

The "Import Settings" item in the File menu has two uses. One is that you can read in a model previously created with Mineways. Doing so will set up Mineways to be identical to how it was when the file was exported: the world, terrain file, color scheme, and all export settings will be set to what you used when you exported the model. This is handy for continuing to work on a model you exported in a previous session.

However, "Import Settings" can do much more. As of version 4.18 of Mineways, you can make a text file of Mineways scripting commands and read it in to:

• Set up a start-up configuration, similar to how model files can set the environment, plus setting initial location, zoom level, and other parameters.
• Automate a series of exports, so that you could create a whole series of files. This is handy if you want to export hunks of terrain for a level of detail system, for example.
• Access script-only commands that are too involved to expose in the menus. Some examples include:
  • Turning your cobblestone castle into true stone, or even gold or diamond.
  • Adding a base to a model you produced so it will stand up when 3D printed.
  • Create sets of commands to make whatever you want out of different blocks.
  • Or, simply trimming away particular cubes that you don't want to remove in your Minecraft world itself.

None of these functions will affect your original Minecraft world. Mineways considers that data unmodifiable. The changes are performed temporarily on whatever you next export, and not displayed on the map.

Script files have the suffix ".mwscript". When using "Import Settings" note that you can use the file filter of the import dialog to display only these types of files.

Model File Import

Model files have first lines such as:

Model export files have all their commands preceded by a "#", scripting language files do not. Script files are simple text files, and are usually stored with the suffix "*.mwscript". See the files that come with the Mineways distribution for examples. A file is considered to be a script if Mineways looks at it and doesn't think it's from a model.

One note on model import: for STL files the file you need to import is labeled *.txt. For example, if you export AwesomeCastle.stl, Mineways also creates an AwesomeCastle.txt file with statistics and settings about your export. OBJ and VRML files have these statistics contained at the top of their exported *.obj and *.wrl files.

Scripting Overview

Most commands consist of a single line, and usually have a colon in them. There are two classes of commands: those that are recognized when an exported model is read in, and those recognized when a script is read. Most, but not all, of the exported model commands are recognized as script commands.

You can take many of the export commands found in model files and use them in a script you're creating. Transferring text from the top of a exported model to a script file is an easy way to get properly-formed commands in place. Simply remove the "#" from in front of each command to use it in a script file. See this section for what the default settings are when exporting for rendering.

Model Export Commands

Here is the full list of model export commands. When found in a model file, each line is preceded by a "#"; in scripting files the "#" is not used. Text in italics is shown as an example. "[deprecated]" means this format is output by older versions of Mineways. WARNING: I currently don't do much checking of what options you set. Some options don't work with some modes, e.g., you can turn on "Simplify mesh" when exporting individual blocks but it will do nothing. I try to guard against illegal combinations (though you won't be warned). Still, you may get a weird crash if you ask for something impossible.

Model Export/Script command syntax	Notes
# Wavefront OBJ file made by Mineways #VRML V2.0 utf8 # Minecraft world: beta test world # Extracted from Minecraft world saves/BestWorld [deprecated]	Model only. One of these must be the first line encountered in a model (or for STL, text statistics) file that is imported. The italicized text is the world's folder in the .minecraft/saves directory.
World: Royal Albert Hall Minecraft world: Happy Blocks Land Minecraft world: C:\Users\erich\AppData\Roaming\.minecraft\saves\Round World Minecraft world: C:\Users\erich\schematics\teapot.schematic Minecraft world: [Block Test World] Extracted from Minecraft world saves/BestWorld [deprecated]	The world to load (or reload), accessed by the folder name. The .minecraft/saves directory is assumed, but a full path can be given if desired. The full path is always needed for schematics. Use [Block Test World] to load this special test world.
View Overworld View Nether View The End	Change to the given map level (will appear all gray if the level does not exist). For model export "View Overworld" is not output, since it's the default.
Terrain file name: C:\Users\erich\Desktop\Mineways\terrainExt_Sphax.png Terrain file name: terrainExt_DokuLight.png	Sets terrain file to be used. Full path is recommended; if just a file name is given, Mineways looks in the load or last-used directory.
Color scheme: no glass blocks	Selects the named color scheme, if available. "Standard" is the default.
Selection location min to max: -199, 0, -466 to -176, 255, -442 Selection location: 60, 0, 60 to 80, 255, 100 Selection location: none Selection location: all	Select the volume to be exported, inclusive. Either form is fine. The volume is defined by a minimum and maximum block location. The commas, spaces, and "to" string do matter here. If "none" is found, deselection occurs (Escape key in Mineways). If "all" is found, the values -5000, 0, -5000 to 5000, 255, 5000 are used, which is usually enough to select any schematic imported - this is just a simple shorthand instead of writing it all out. This option is also handy for superflat Creative worlds, where you just want to export the whole place.
Set render type: Wavefront OBJ absolute indices Set render type: Wavefront OBJ relative indices Set render type: USD 1.0 Set render type: Binary STL iMaterialise Set render type: Binary STL VisCAM Set render type: ASCII STL Set render type: VRML 2.0 Set 3D print type: Wavefront OBJ absolute indices Created for Viewing - Wavefront OBJ absolute indices [deprecated] Created for 3D printing - Wavefront OBJ absolute indices [deprecated]	Set target for commands to export for rendering or 3D printing, and specify the file format to be used. Whatever file type is set, render or 3D print, along with the file format, is the set of export options that will be affected by the export commands that follow. If none is set, export commands will affect "Set render type: Wavefront OBJ absolute indices". If you set export settings and then switch to another file export type or file format, don't expect the options to also be set there. Not all file types are shown for the 3D print type and deprecated versions, to avoid repetition; these are all the same as shown for rendering.
File type: Export no materials File type: Export solid material colors only (no textures) File type: Export noise textures with color File type: Export all textures to three large images File type: Export individual textures to directory texture	Yes, this is kind of a bad name, "Material type" would have been better. The type of material export done. Note that for "individual textures," where a separate texture is exported for each block face, a directory is also specified. This is shown here as "directory texture" and should be a simple folder name, not a path.
Units for the model vertex data itself: millimeters	Meaningful only for 3D printing export. Valid units: millimeters, centimeters, meters, inches.
Rotate model 0.000000 degrees	Number of degrees model is rotated on output. Valid values are 0, 90, 180, 270.
Scale model by making each block 2 mm high Scale model by fitting to a height of 5 cm Scale model by using the minimum wall thickness for the Sculpteo multicolor material Scale model by aiming for a cost of 25.00 for the colored sandstone material	Meaningful only for 3D printing export. There are many variants here; the simplest way to find the text you want is to export manually and examine the top of the file exported. See the export options for more information.
Fill air bubbles: YES; Seal off entrances: no; Fill in isolated tunnels in base of model: no Connect parts sharing an edge: YES; Connect corner tips: YES; Weld all shared edges: no Delete floating objects: trees and parts smaller than 16 blocks: YES Hollow out bottom of model, making the walls 2 mm thick: no; Superhollow: no	Typically used for 3D printing export. See the export options for more information.
Texture output RGB: YES Texture output A: YES Texture output RGBA: YES Export separate types: YES Export individual blocks: no Material per family: YES Split by block type: YES Make groups objects: no Custom material: YES Export lesser blocks: YES Fatten lesser blocks: no Simplify mesh: no Double all billboard faces: no Create composite overlay faces: no Center model: YES Create block faces at the borders: YES Tree leaves solid: no Make Z the up direction instead of Y: no Melt snow blocks: no Debug: show separate parts as colors: no Debug: show weld blocks in bright colors: no	Booleans. Boolean values are set as YES/yes/TRUE/true/1; anything else found for a boolean is considered false. See the export options for more information. "Use biomes: YES" also turns on biome display, so that the effect is seen.

Example

Here is an example of a script using the commands above.

This loads a world, changes its color scheme to "no glass", selects a terrain file, selects rendering to an OBJ file, turn biomes on, and finally selects a volume to export.

Scripting Interface Commands

The commands above are available for scripting, unless listed as "Model only." All script commands are used without a "#" in front of each line. Comments "//" and "/* */" are respected.

If you wish to set any export options, it's wise to first set the export mode and file type by using the "Set render type:" or "Set 3D print type:" command. If you don't, the export settings will be applied to whatever file type was last exported, if any, and a warning will pop up.

Because it's a powerful system that can itself create files, the script file is read twice. Syntax errors are checked for and flagged on the first read; no actions are done. If there are no syntax errors, then the script is read again and executed line by line. Script execution is aborted for the whole script if any execution error is found and caught. Pro tip: if you want to test a script for syntax errors and not execute it, put "FAIL" (or anything else that's not a command) as a line in the script. It will flag this line, and any other lines causing errors, and will not execute the script until all are fixed.

Even with error checking, it's definitely possible to set combinations that may crash Mineways, as there are complex interactions between systems and especially between blocks and some combinations are simply illegal. If things get wedged, just restart Mineways, which always resets its defaults to a known good state.

Script command syntax	Notes
Jump to Spawn Jump to Player Jump to Model	Jump the view to the specific location.
Reset export options: Render Reset export options: 3D Print Reset export options: Schematic	Reset all the options for all file formats for the given export mode. Lets you start with a clean slate.
Focus view: -210, 73	Set the view to be centered on this position on the map, X (East-West, East is positive) and Z (North-South, South is positive).
Zoom: 5	Zoom in on the view, higher is more zoomed in. The legal range is 1 to 40, inclusive, and represents the width of each block in pixels.
Show all objects: true Show biomes: YES Elevation shading: false Lighting: no Cave mode: TRUE Hide obscured: yes Transparent water: no Map grid: no	Set map view mode on or off, using TRUE/true/YES/yes/1 for on. Note that, as usual, showing the biomes doesn't set the checkbox to export them (well, export the biome in the center of the volume exported). The command "Use biomes: YES" does that.
Select minimum height: 55 Select minimum height: -12 Select minimum height: +5 Select minimum height: V Select minimum height: v Select minimum height: V43 Select minimum height: v63	Set the minimum height slider for the box volume to be exported. The +/- versions give a relative change, e.g., "-12" means subtract 12 from the current level, whatever it is. V/v is used to set the height level by looking at the selected area, plus a one-block border around it, and selecting the lowest height of the entire set of visible blocks. "V" means "ignore semitransparent blocks", those that can be seen through, such as water and glass. "v" means to pay attention to such blocks. Finally, V/v followed by a number means to use the level found, or the level specified, whichever is larger. For example, "V47" means find the minimum level of the selected area (plus one block border). If that level is greater than 47, use it; if less than 47, set the level to 47. While involved to explain, settings such as "V43" can be useful for exporting the above-ground visible area - 43 is as deep as the oceans normally ever go. Deeper than this and the selected area probably has a deep hole that throws off the level. If you're exporting separate pieces of terrain for viewing, "V" is usually safe for showing everything above ground (you might miss an area with a large overhang, though, since the overhang will limit the minimum level found). If you know that you don't care about anything lower than, say, 57, then use "V57" to make sure the minimum level set is never lower than 57.
Select maximum height: 119	Set the maximum height slider for the box volume to be exported and that is visible.
Give more export memory: YES	On the 32-bit version (and on the Mac) you can run out of memory on export. This option frees up all the allocated map data and reloads it only as needed during export, giving Mineways more memory to use for its other processes. At the end of export the visible world is reloaded for display. This option can cause export to go more slowly.
Export for rendering: c:\temp\my_save.obj Export for 3D printing: my_print.stl Export schematic: c:\temp\my schematics\my_object.schematic Export map: my_map.png	Export the selected area using the given file type to the specified file. Note that (unlike the manual process, where you pick the file then set options) this export happens immediately, so you need to set all your export options before giving this command.
Close	This command has a dramatic effect: it closes the program! This can be useful if you want to run a script and exit when it's done. Combined with a startup script, you can make Mineways run a script and exit by just a double-click. You can also use the "-m" command-line option to have Mineways start up minimized, not showing its window. Note that if the script runs with any errors, error processing is done before the script closes, so that processing will stop and you'll be warned. If you don't want to ever halt on errors, use a log file; see the commands that follow.

Examples

Here is an example of a script using the commands above.

For the world that is currently loaded, this sets the render type and file format, switches to the Nether level of the world loaded, selects an area, zooms the map, and performs a rendering export to the file nether.obj

Note that you could use this type of command sequence to export a bunch of adjacent areas, which you could then load into Blender or any other application as you wished. This can help you avoid hitting memory limits in Mineways, etc. As an example, here are the commands in hunk_output.mwscript, a script that comes with Mineways (along with hunk_maker.py, a Python program you can modify to generate sets of hunks as you wish; open and read the top of hunk_maker.py for how to edit and run it):

Load your world, run this script via Import Settings, and it will dump four exports, with absolute coordinates, so that they can be loaded into a modeler and nicely join with each other. The "50" lower Y height is just a guess as to how deep you might want to go for a typical above-ground export - you can override this as you wish. Biomes are off, since the biome is computed for the center of each hunk and so will differ. Block faces at the borders being off means that the polygons where the hunks join are not output, saving on polygon count. You can set that to "yes" if you prefer. You

The one gotcha is that differently named (but usually identical in content) PNG texture files are made for each separate model. If you prefer sharing PNG files (which saves on memory), I solve this problem here by setting the File type to use individual textures for each block type face, such as "grass_top.png"; these have the same names for all exported files, all put in the same "hunks_textures" directory.

Sketchfab Script Commands

You can use script commands to upload models to Sketchfab, where you can set up a free account. The one element you must set is the token.

Script command syntax	Notes
Sketchfab token: 32 character token from your account	The API token from your Sketchfab account. Must be present. Keep your API Token SECRET.
Sketchfab title: title	Title for your upload, maximum of 48 characters.
Sketchfab description: description	Description for your upload, maximum of 1024 characters.
Sketchfab tags: tag1 tag2 ...	Tags for your upload, e.g., "castle waterfall". The tags "minecraft" and "mineways" are always added. Maximum of only 29 characters.
Sketchfab private	If present, the "Private (Pro only)" box is checked.
Sketchfab password: password	If "private" is set, as above, then you can also specify a password, up to 32 characters long.
Publish to Sketchfab	As it says. Once the API token and any other options are set, the currently-selected volume is exported to Sketchfab.

These commands can set almost all the fields that Sketchfab permits. The one exception is "Categories" - if you want to set these, you will need to do so manually on Sketchfab's site.

Example

Here is an example of a script using the Sketchfab commands above.

The description and tags are optional. The proper strings are set, and then the model is uploaded to Sketchfab.

Script-only Commands

These are the value-added commands, things you simply can't do otherwise in Mineways, such as set how your mouse is mapped (which you may want to do when you start the program, by calling a script on startup), set parameters for the estimation of 3D print costs, or temporarily change blocks for the next export done.

Want to turn your stone castle into diamond? Or have all the leaves disappear from your trees? Or add a giant pyramid to your spawn point? The Change blocks command is the genie that can made your dreams come true, if only for a short while.

The idea behind Change blocks is that you can specify extremely temporary changes to your world. These will not show up on the map, and they affect only the next export you perform. After the export the changes are cleared out; you have to load these changes again if you want to apply them again. No actual changes are made to your Minecraft world files.

You can specify a series of commands, which are applied in the order given. Each command works on the results of whatever previous commands did. For example, if you turn all crops into potatoes, then turn potatoes into grass, this has the effect of turning all crops into grass.

One warning: just like a genie fulfilling your wishes, Change blocks commands can set up combinations that can inadvertently cause terrible things to happen, possibly causing assertions during export or even crashes. This is an expert-level feature, and it's up to you to do the right thing.

Script command syntax	Notes
Export using biome: 6 Export using biome: 13 Snowy Mountains	If Use biome in center of export area is selected on export, or script "Use biomes: YES", the biome type at the center of the exported area is used, affecting coloration. You can override which biome is used with this "Export using biome" command, setting a different number before exporting. IMPORTANT: you must also have set "Use biomes: YES". You must select the number associated with the biome you want this piece of code. For example, 6 is Swamp. Anything after the number is ignored (such as "Snowy Mountains" above), so you can use that area as a place to note what the number means. This number is -1 by default (which means it doesn't affect anything), and will get reset to -1 after a (successful or unsuccessful, biomes exported or not) model export. When you export, the biome you used will be displayed in a comment near the top of the model file created. When you import this file, this "Export using biome" setting will be ignored. This command is meant as a temporary override, controlled entirely by scripting. When in doubt, set it before any export if you're using this feature (and don't forget to also set "Use biomes: YES").
Show informational: true Show warning: NO Show error: script	You can suppress informational, warning, and execution error pop-up dialog messages by setting the corresponding property to false. By default, all these are set to true. If you instead set the status to "script", this means the messages will be suppressed for the current script only and returned to "true" (normally visible) after the script is executed. Note that it's usually wise to set these all back to true at the end of any script that turns them off, as these settings are permanent for the session, so "script" is usually your best bet. Execution errors (not warnings) will abort a script, even if turned off with this command. If turned off or set to "script", these messages will instead show up (usually briefly!) in the status line in the lower left of Mineways when exporting. They will also be sent to the script log file, if set - see the next command. A few warnings, such as when you manually turn on some experimental feature or for Sketchfab uploads, are always displayed and cannot be suppressed.
Save log file: filename	Instead of displaying script syntax errors, warnings, and informational messages to the screen in pop-up dialogs, write this information to the specified log file. Typically use this command at the beginning of a script. The log file is closed when the script is processed (that is, you'll have to issue this command again for any succeeding scripts). This is handy if you have syntax errors and want to look at them later. Normally only syntax errors in the script commands are saved to the log. Actual execution errors are still popped up. If you use "Show error: false" and similar commands for warnings, etc., these messages will be recorded in the log file instead. That said, a true execution error will still cause the script to abort, as usual. See the file hunk_output.mwscript for an example of how to use these commands.
Set mouse order: [left|middle|right] [left|middle|right] [left|middle|right]	Think of this command as setting the chosen mouse button for movement, bottom height selection, and rectangle selection, respectively, "Select mouse order: movement button, height button, rectangle button", and you specify a mouse button to each in turn. By default: The left button moves (pans) the view The middle button down selects the bottom height for export The right button sets or adjusts the selection rectangle's bounds So "Set mouse order: middle right left" makes the middle mouse perform movement and the left mouse selection. The mouse wheel (zoom) cannot be remapped.
Reset mouse	Reset the mouse to the default behavior. Equivalent to "Set mouse order: left middle right".
Change blocks: [from block range] [to type[:id]] [at x,y,z [to x,y,z]]	Define a range of block types to be affected, what those block types should turn into, and what location or volume of space the command should affect. Not all from/to/at bits are needed, but at least one is. See the examples below for how the various combinations work. These changes do not happen to your world nor show up on the map, they are applied the next time you export and then cleared out.
Clear change block commands	Clear out all stored 'Change blocks' commands. While exporting will clear out any Change block commands, you can also clear them out this way without exporting.
Set unknown block ID: 322	Set this value before opening a modded world. Modded worlds have block types not understood by Mineways. By default, unknown blocks are converted to bedrock blocks. You can set a block family ID that you want to use instead. Note that after the unknown block is turned into that block type, it is treated exactly like that block type, including gettings its faces removed if the face is fully covered by a neighboring block. By default the ID is set to 7, Bedrock. For Minecraft 1.12 and earlier this value must be 255 or lower. You might prefer setting it to, say, 103 - Melon. See "Translate" for a more powerful way to translate unknown blocks.
Translate: track_signal beacon Translate: unobtainium_slab purpur_slab+	Added to help mod and beta users a bit. For Minecraft 1.13 and newer. Pair some unknown block name to some standard name, e.g.: "Translate: nixie_tube beehive". Do not put quotes around the names, and any modding prefix in the file, e.g., "create:", should not be included - it is ignored. The list of block names that Mineways currently accepts is here. If you want to attempt to use the block states of the modded block, put a "+" at the end of the block you're translating to. For example, "Translate: white_stained_glass_trapdoor bamboo_trapdoor+" tells Mineways to use the block states of the trapdoor. Unknown block states will of course be ignored. See the script mod_translation.mwscript for an example setup. MCPrep's meshswap feature can also help modify things after export (more info). Normally you want to set these translations before loading a modded world. To have these changes take effect on a world that is loaded, hit "r" or use the script command "Minecraft world:" to reload. This feature is experimental! If you try to use block states via "+" and things don't match up, you'll likely get weird results or even possibly crash.
Clear translations	Clear all pairings set by the "Translate:" command. To have these changes take effect on a world that is loaded, hit "r" or use the script command "Minecraft world:".
Custom printer cost per ccm: 0.03 Custom printer cost per printer ccm: 0.00 Custom printer handling cost: 0.00 Custom printer minimum cost: 0.00 Custom printer currency: $ Custom printer maximum size: 20.0 20.0 19.0 Custom printer minimum wall thickness: 1.5	The custom printer material that is used by the STL exporter can have its attributes set for showing the cost on export. You can set the cost per cubic centimeter (ccm) of material used (assuming a solid model), the cost per ccm of printer volume used (i.e., including the empty space, a bounding box around the model; Shapeways uses this for its Strong & Flexible material, for example), the "handling" cost (added in), the minimum cost a model will cost, the currency symbol (only the first character is used), the volume size of the 3D printer in centimeters (to warn if the print is too large), and the minimum wall thickness in millimeters for printing. Any or all of these can be set; the defaults are shown when not modified. PLA is typically priced at $24 for a 1 kilogram (800 cubic centimeters) spool. That is, $24/800 ccm then costs $0.03 per cubic centimeter.

Change blocks command examples

The Change blocks command specifies a set of blocks to turn into a particular block ID and data value in a particular volume of space. It has seven variants, depending on whether you specify the from, to, and at values. Here are examples of each variant. A simple example is the heightfield.py Python program that comes with Mineways, which reads an image and creates a heightfield.mwscript file, example also included. See this video for the process.

Block names in the examples below are the standard English names seen in the game itself, not the internal "namespaced ID". For example, it's "block of diamond", not "diamond_block". See the names in this file. Capitalization is unimportant.

IMPORTANT NOTE: This feature uses the old "pre-flattening" type/dataVal format for specifying blocks, which went away in Minecraft 1.13. You can look up the type values here - click the "[show]" link to the right of the "Block IDs" title. Wiser is to use the block names explicitly, as found in this file. That said, I have shoved many newer 1.13+ blocks in various places, e.g., a warped_slab, blackstone_slab, and other new slabs have the same block ID, 361 (= 256+105), as crimson_slab, with a dataVal of 1, 2, etc. - see that encoded here. As an example, "crimson slab":2 means a blackstone slab (ignore "HIGH_BIT" in the code). I hope this helps.

Basically, if you're reading this and are extremely bitter that I don't clearly support some particular block you want and can't figure out how to set it, write me and plead your case. I could probably rework the nbt.cpp code to also use the namespaced ID names.

Block IDs 8 and 9 are the two types of water. These are cleared to "air" in the whole selection volume - the land's dried up.

Change all lime green wool blocks to a deep green wool.

The specific location, no matter what's in it (even air), is turned into TNT. For the next example below, no "from" means "everything except air". If you can't remember what the default is, just specify it, e.g., this command is the same as Change blocks: from 0-255 to "TNT" at 2112,71,548

Everything solid (not air) in the whole volume is turned into chiseled sandstone. The long form is Change blocks: from 1-255 to 24:1

Any of the given forms of glass are turned into glass blocks in the entire exported volume (defined by "Selection location:"). Note that the "from" range can be a list of blocks by ID number or name. A range can also be given, e.g., 64,71,193-197 specifics all full doors. You can also give specific data values, e.g., "wood planks":1-5 means all variants of wood planks other than oak, which uses data value 1.

The at/to volume specified is cleared out, turned to air. The long form is Change blocks: from 1-255 to 0 at -5,50,45 to 50,255,90

This example finds any wheat blocks in the given volume and changes them to cactus blocks. The names are those shown in the "Block" column on this page. Or, find these names and IDs in this table.

This is the same as say from "wheat" to "cactus", instead using the decimal "Dec" number shown in this table. If you're not sure of the name, use the ID to be safe - you can always add a comment, as shown. Note how the "at" location specifies only a single block in this example, just to show a different example; if that block is wheat, it will be turned into a cactus.

Here the data values for wheat are specified. The data value is a number from 0 to 15 and specifies variants of blocks. Wheat's values are 0-7, specifying the growth stage, 7 being fully mature. This example says to make all the wheat fully mature, by taking data values 0-6 and changing them all to 7.

Any growing wheat, carrots (ID 141) through potatoes (ID 142), and beetroot seeds (ID 207) are turned into fully grown wheat in the specified area. This is about as elaborate as you can go. All the commands below are shorthand variants, using defaults for missing fields.

Usually if you don't specify a "from" range, it means everything solid (not air). The one exception is if you set "to" and a volume, in which case air is also turned into the specified block type. The "to" value is "air" by default. If the location volume is not given, the whole export selection area is used.

All blocks greater or equal in ID to 198 ("end rod") in the given at/to volume are turned into "air", i.e., cleared out. If no "to" ID is given, air is used.

Comments

There is no comment syntax for model export files - usually it's better to not mess with these commands at all in the model file. For scripts you can use "//" and anything after is ignored. You can also use "/*" and "*/" to comment out blocks of text.

Examples

Command Line Options

You can use command-line options with Mineways so that it is customized on startup. For example, you could provide a different initial window size, then run a script that loads your favorite world and takes you to where you were last building.

You can store this command line in a .bat file and double-click that file, or change your options on the shortcut for Mineways itself. See the file mineways.bat in Mineways for an example. It starts Mineways with a larger window, then calls the scripting/startup.mwscript script (which does nothing, but which you can edit to perform the various startup script commands shown above).

Syntax:

The command-line options are:

file1.mwscript|obj|wrl
Specify the file name and path for a script or previously exported model file to load on startup. So, you can use scripting, as above, or you can use the "Import Settings" feature: provide an .obj, .wrl, or .txt (from an .stl export) file from a previous export and it will load the world, take you to the model previously exported, and select it for further work.

-w X Y
Specify the X and Y resolution in pixels of the startup window. Values must be positive integers.

-m
Start up Mineways as a minimized window. This setting is useful if you are running a command-line script that does a "Close" at the end, as all operations will run without (noticeably) popping up the Mineways window.

-s UserSaveDirectory
Specify the directory where all your Minecraft worlds are located, shown in the "File | Open World" list. This directory is "%appdata%\.minecraft\saves" by default, if not specified. The directory is not a single world's save folder, but rather a directory holding all world folders you want to choose from. If your directory path has spaces in it, you need to use double-quotes around the path, e.g., -s "C:\temp\My Minecraft Saves". Use "-s none" to load no world list at all.

-t terrainExt*.png
Specify the terrain file to use initially. See the documentation for more details on terrain files.

-l mineways_exec.log
For debugging startup problems; you'll normally never use this. This option saves a log of startup and commands executed. The file mineways_debug_log.bat runs Mineways in this way.

-suppress
Suppress all informational, warning, and error popups. Equivalent to "Show informational: false", "Show warning: false", and "Show error: false", but performed before any other operations are done in Mineways. This allows a nearly-batch mode for Mineways with no pauses, as no popups will appear at startup (such as "bad world" warnings) or during execution of any scripts executed. You can turn popup display back on during execution normally, e.g., a script with "Show error: true", "Show warning: YES", etc.

-zl MinZoom
Congratulations! You found an experimental feature, equivalent to Zoom out further. Setting this may cause memory problems or crashes on your machine. Normally Mineways has a limit to how far you can zoom out: 1 pixel per block. But, if you set this MinZoom value to something lower than 1.0, that's how low you can zoom out with the mouse wheel. For example, 0.5 means 0.5 pixels per block, aka 1 pixel for every 2 blocks in width on the screen. Lowest you can go is 0.0625 (16 blocks wide per pixel). This zoom level lets you see a lot more of your world in the window. It'll also load a lot more blocks (a LOT more. For example, 0.5 means loading four - 2x2 - more blocks to display. 0.0625 means loading 256 more blocks per pixel than normal). You may experience slowdowns or a crash as you zoom farther out, as more and more chunks get loaded. Have fun! Bonus behavior: if you set this zoom value on startup, you'll have more cache available as you pan around your map. So, for example, you could set "-zl 0.25" and more chunks will be cached overall, leading to less hesitation when you scroll around further. Give it a try if you find you scroll back and forth between areas a lot (or just use View -> Focus View on the menu).

Here are a few examples:

Start up Mineways in an 800 x 900 size window. Note that a larger window does mean a slower world load time, since more chunks are visible on load.

Import the settings for the previously-exported model MyCastle.obj, its rendering mode, selection volume, and all other export settings. Essentially runs the Import Settings function in the File menu.

Run the script startup.mwscript in the scripting directory at startup. Useful for setting default export options or other things you prefer.

If you exported a model just how you like it, you can import it and modify its settings with whatever commands are in your modify.mwscript. When using multiple scripts, it's wise to give the full path to each file, as Mineways will modify the default directory used to load files. Note that double quotes are needed when the file or path contains a space character, such as shown in this example for "My House.obj".

Start minimized and run the specified scripts at startup. The "Load Eiffel" script might load a world and select the Eiffel model in that world. The export script exports it, and the close script closes Mineways. This allows you to essentially run Mineways from the command line with no interactions needed. Running minimized also speeds up processing, since only the map chunks in the exported model are loaded.

Load the world folders contained in C:\MyWorlds so that they appear in the "File | Open World" menu list. If you want to not load any list of worlds, use:

Do not load any list of worlds on startup. This can be useful if Mineways does not start properly, to rule out world files causing the problem, or if you're running a script on startup and do not need the world list loaded.

Associating .mwscript files with Mineways

On Windows, run the batch file register-Mineways-run-as-administrator.bat as administrator. Go to the folder where the Mineways code is and right-click on register-Mineways-run-as-administrator.bat and then select "Run as administrator" from the list:

You should see any *.mwscript files with Mineways icons next to them:

Now when you double-click on a file ending with .mwscript, it will run this script on startup.

On the Mac, follow these instructions.

Default Rendering Options

What follows are the default rendering options when Export for Rendering is performed. This list was created by exporting a sample rendering from a world, editing the OBJ file, grabbing the header and removing the "#" character at the beginning of each line, and commenting out the lines that are purely comments by using "//". This is provided here as a guide to all the export options available.

Perl Script Example

Here's a simple Perl script to generate a Mineways script. It shows the power of scripting to make models. Another example is the heightfield.py file that comes with Mineways, which reads an image and creates a heightfield. See this video for the process.

Running the script to set up the scene, then exporting (manually) to Sketchfab, you get this:

Scripting test by Eric Haines on Sketchfab