Mindcode: a Mindustry Logic high-level language

Mindcode is a high-level language that compiles down to Mindustry Logic - mlog. Mindcode includes higher-level constructs, such as expressions, user-defined functions and control statements. Here are some examples to give you an idea how to use Mindcode:

Mindcode Source Code: Mindustry Logic:

// Patrols around a building and heals any damaged building
// Since the patrolling ship is close by, repairing will happen faster than usual

// Units is a system library providing functions for easy acquisition of units
require units;

// This part of the script will create mlog variables which can be modified
// in the compiled code to change which unit to use and which building to circle around
// The following line is a special comment which will be written to the mlog code as well.

/// Configurable options:
param CENTER = foundation1;
param UNIT = @poly;

// We'll write messages onto this block
// It is used by the units system library to output messages as well
param MESSAGES = message1;

/// Don't modify anything below this line.

// Title printed to messages to help identify the processor purpose
const TITLE = "Healing damaged buildings\n";

begin
    // Find a unit if we don't have one
    if @unit.@dead != 0  or @unit.@controller != @this then
        waitForFreeUnit(MESSAGES, TITLE, UNIT, 1);
    end;

var dmgx, dmgy;
    if ulocate(:damaged, out dmgx, out dmgy) then
        println($"${TITLE}Found damaged block at $dmgx, $dmgy");
        approach(dmgx, dmgy, 5);
        target(dmgx, dmgy, true);
    else
        println(TITLE, "Patrolling");
        approach(CENTER.@x + 10 * sin(@tick), CENTER.@y + 10 * cos(@tick), 2);
    end;

printflush(MESSAGES);
end;

40 lines of code

jump 2 always 0 0
print "Configurable options:"
set CENTER foundation1
set UNIT @poly
set MESSAGES message1
jump 7 always 0 0
print "Don't modify anything below this line."
sensor *tmp0 @unit @dead
jump 11 notEqual *tmp0 0
sensor *tmp2 @unit @controller
jump 26 equal *tmp2 @this
ubind UNIT
jump 18 notEqual @unit null
print "Healing damaged buildings\nNo unit of type "
print UNIT
print " found."
printflush MESSAGES
jump 11 always 0 0
sensor *tmp8 @unit @controlled
jump 25 equal *tmp8 0
print "Healing damaged buildings\nLooking for a free "
print UNIT
print "..."
printflush MESSAGES
jump 11 always 0 0
ucontrol flag 1 0 0 0 0
ulocate damaged core true @copper :dmgx :dmgy 0 *tmp11
jump 36 equal *tmp11 false
print "Healing damaged buildings\nFound damaged block at "
print :dmgx
print ", "
print :dmgy
print "\n"
ucontrol approach :dmgx :dmgy 5 0 0
ucontrol target :dmgx :dmgy true 0 0
jump 46 always 0 0
print "Healing damaged buildings\nPatrolling\n"
sensor *tmp14 CENTER @x
op sin *tmp15 @tick 0
op mul *tmp16 10 *tmp15
op add *tmp17 *tmp14 *tmp16
sensor *tmp18 CENTER @y
op cos *tmp19 @tick 0
op mul *tmp20 10 *tmp19
op add *tmp21 *tmp18 *tmp20
ucontrol approach *tmp17 *tmp21 2 0 0
printflush MESSAGES

47 lines of code

Bug reports, suggestions and questions are welcome at the project page.

Program output (0 steps):

Compiler messages:

79 instructions before optimizations.
1 instructions modified by Temp Variables Elimination (4 iterations).
10 instructions eliminated by Dead Code Elimination (6 iterations).
1 instructions eliminated by Jump Normalization (5 iterations).
4 instructions eliminated by Condition Optimization (6 iterations).
3 instructions eliminated by Single Step Elimination (3 passes, 8 iterations).
4 instructions eliminated by Data Flow Optimization (4 iterations).
1 instructions eliminated by Jump Straightening (6 iterations).
2 instructions updated by Jump Threading.
1 instructions eliminated by Unreachable Code Elimination (3 iterations).
8 instructions eliminated by Print Merging.
47 instructions after optimizations.
Code size and number of instantiations by function: Size Times AvgSize Function 32 1x 32.0 <no function> 15 1x 15.0 def waitForFreeUnit(in message, in preface, in unit_type, in initial_flag)
Performance: parsed in 28 ms, compiled in 4 ms, optimized in 7 ms.

Mindcode Compiler Mlog Decompiler Schematics Builder Schematics Decompiler

Mindcode Compiler
Mlog Decompiler
Schematics Builder
Schematics Decompiler