The idea of allowing scripts to be run on the Minecraft client originated when EssentialClient was first being implemented. My scripting implementation achieved my goal, but it was poorly designed and due to running on my own interpreted language had severe performance limitations.
After discovering kotlin scripting I decided that it would be an ideal language to use for a scripting mod. It can compile directly into bytecode to run on the JVM as well as not requiring wrapper APIs allowing scripts to interface directly with Minecraft's code.
You can install the mod from modrinth, alternatively you can build the mod from source.
You can build the mod from source, you will need Java 25 for this:
- Clone the repo
git clone https://github.com/senseiwells/Kursive.git
- Compile the mod
gradlew build
- The build mod jar will be in
build/libs
Once you have the mod jar drag it into your mod folder. You will also need to install all of Kursive's dependencies:
- Fabric API
- Fabric Language Kotlin
- YACL (client-side only)
Warning
This mod lets you run arbitrary code, you should never run scripts you do not trust.
If you are a server owner you should only give permissions to those players who you fully trust.
Use this mod at your own risk.
The mod's documentation can be found here.
The documentation details how to start developing your first scripts as well as detailing how to run scripts on the client and server.
Distributed under the MIT License. See MIT License for more information.
