Koord Programming Framework¶
The Koord language is a new language for coordination in bots.
TODO briefly introduce and show example Koord code
Quick start using JAR package¶
Requirements¶
- Java Runtime Environment 11 (JRE 11) or above
- Download the JAR file
koord-*-jar-with-dependencies.jar
from one of our releases (or compile from source code)
Usage¶
Given a Koord program app.krd
, run the following command to generate Python code
app.py
:
$ java -jar /path/to/koord-*-jar-with-dependencies.jar app.krd app.py
Compile JAR package from source code¶
Requirements¶
- Java Development Kit 12 (JDK 12)
- Maven
- Python 3.5 or above for testing
Compilation¶
The parser is written in Java and uses Antlr. This project uses Maven.
Run following command to build and test the JAR package file:
$ mvn package
The created JAR file should be under target
folder following the name
pattern koord-*-jar-with-dependencies.jar
.
With the JAR file, please follow the instructions in the previous section to run
Koord compiler.
Koord Language
Koord Compiler