From 5c77278d44fb587d3d5767150aeff837db1a7c2f Mon Sep 17 00:00:00 2001 From: cardillan <122014763+cardillan@users.noreply.github.com> Date: Thu, 17 Oct 2024 12:09:45 +0200 Subject: [PATCH] Release 2.4.0 --- CONTRIBUTING.markdown | 2 ++ doc/syntax/SYNTAX.markdown | 2 +- doc/syntax/TOOLS-CMDLINE.markdown | 1 - doc/syntax/TOOLS-MLOG-DECOMPILER.markdown | 3 ++- pom.xml | 2 +- .../info/teksol/mindcode/cmdline/CompileMindcodeAction.java | 3 +-- webapp/src/main/resources/templates/mlog-decompiler.ftlh | 3 ++- 7 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 934fb62ed..3d75f1349 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -1,5 +1,7 @@ # Contributing +There's currently a bunch of issues marked with the `help wanted` label. You can also have a look [here](https://github.com/cardillan/mindcode/discussions/167). + ## Guidelines Mindcode uses JDK17, Maven and Spring Boot. diff --git a/doc/syntax/SYNTAX.markdown b/doc/syntax/SYNTAX.markdown index 739e87558..7b4f44f82 100644 --- a/doc/syntax/SYNTAX.markdown +++ b/doc/syntax/SYNTAX.markdown @@ -34,7 +34,7 @@ Supporting tools: * [Command line tool](TOOLS-CMDLINE.markdown) * [Mlog Watcher](TOOLS-MLOG-WATCHER.markdown) * [Schematics Refresher](TOOLS-REFRESHER.markdown) -* [Mlog Decompiler](TOOLS-REFRESHER.markdown) +* [Mlog Decompiler](TOOLS-MLOG-DECOMPILER.markdown) Additional information on Mindcode and Mindustry Logic: diff --git a/doc/syntax/TOOLS-CMDLINE.markdown b/doc/syntax/TOOLS-CMDLINE.markdown index f953ee51f..9c3491d65 100644 --- a/doc/syntax/TOOLS-CMDLINE.markdown +++ b/doc/syntax/TOOLS-CMDLINE.markdown @@ -163,7 +163,6 @@ run options: Options to specify if and how to run the compiled code on an emulated processor. The emulated processor is much faster than Mindustry processors, but can't run instructions which obtain information from the Mindustry World. Sole exceptions are memory cells (cell1 to cell9) and memory banks (bank1 to bank9), which can be read and written. - --run run the compiled code on an emulated processor. --run-steps {1..1000000000} diff --git a/doc/syntax/TOOLS-MLOG-DECOMPILER.markdown b/doc/syntax/TOOLS-MLOG-DECOMPILER.markdown index 55e024831..a11ac7057 100644 --- a/doc/syntax/TOOLS-MLOG-DECOMPILER.markdown +++ b/doc/syntax/TOOLS-MLOG-DECOMPILER.markdown @@ -2,7 +2,8 @@ The Mlog Decompiler allows to **partially decompile** an existing mlog file into Mindcode. The resulting file cannot be compiled by Mindcode right away, but needs to be manually edited to create loops, conditional statements, functions and other high-level control structures that may be directly or indirectly present in the original mlog. -The decompiler is mainly useful to produce expressions and function calls in the correct Mindcode syntax, saving time and possible mistakes that would otherwise be needed to rewrite mlog into Mindcode by hand. +The decompiler is mainly useful to produce expressions and function calls in the correct Mindcode syntax, saving some time and possibly helping to avoid some mistakes +compared to a manual rewrite of the entire mlog code from scratch. Mlog can be decompiled by both the [command line tool](TOOLS-CMDLINE.markdown) and the [web application](http://mindcode.herokuapp.com/mlog-decompiler). diff --git a/pom.xml b/pom.xml index 3a2b87486..52d23d871 100644 --- a/pom.xml +++ b/pom.xml @@ -21,7 +21,7 @@ UTF-8 4.3.5.RELEASE - 2.3.0 + 2.4.0 diff --git a/toolapp/src/main/java/info/teksol/mindcode/cmdline/CompileMindcodeAction.java b/toolapp/src/main/java/info/teksol/mindcode/cmdline/CompileMindcodeAction.java index af8ea6625..d3fdca35e 100644 --- a/toolapp/src/main/java/info/teksol/mindcode/cmdline/CompileMindcodeAction.java +++ b/toolapp/src/main/java/info/teksol/mindcode/cmdline/CompileMindcodeAction.java @@ -90,8 +90,7 @@ void addRunOptions(Subparser subparser, CompilerProfile defaults) { Options to specify if and how to run the compiled code on an emulated processor. The emulated \ processor is much faster than Mindustry processors, but can't run instructions which obtain information \ from the Mindustry World. Sole exceptions are memory cells (cell1 to cell9) and memory banks \ - (bank1 to bank9), which can be read and written. - """); + (bank1 to bank9), which can be read and written."""); runOptions.addArgument("--run") .help("run the compiled code on an emulated processor.") diff --git a/webapp/src/main/resources/templates/mlog-decompiler.ftlh b/webapp/src/main/resources/templates/mlog-decompiler.ftlh index 26dc33cd1..636d91d53 100644 --- a/webapp/src/main/resources/templates/mlog-decompiler.ftlh +++ b/webapp/src/main/resources/templates/mlog-decompiler.ftlh @@ -7,7 +7,8 @@ be directly compiled by Mindcode. Jump instructions in the original mlog are transcribed as if and goto statements which aren't supported by Mindcode and must be rewritten using conditional statements, loops and other high-level constructs. The decompiler is mainly useful to produce expressions and - function calls in the correct Mindcode syntax. + function calls in the correct Mindcode syntax, saving some time and possibly helping to avoid some mistakes + compared to a manual rewrite of the entire mlog code from scratch.