Skip to content

Repository for LiquidBounce's JavaScript API.

License

Notifications You must be signed in to change notification settings

MukjepScarlet/ScriptAPI

 
 

Repository files navigation

LiquidBounce Script API with TypeScript

LiquidBounce's script API allows the development of custom modules and commands for the client without having to modify its source code. It is based on GraalJS, an ECMAScript 2023 compliant JavaScript implementation built on GraalVM. GraalVM's polyglot functionality enables saemless interoperation between scripts written in JavaScript and the client written in Java and Kotlin. This integration facilitates easy access and utilization of Java's and Minecraft's classes, methods, and fields, making development particularly intuitive for those already familiar with Minecraft modding.

Documentation can be found on our website.

Welcome for providing interfaces!

Structure of this repository

Get Started

This is a Node.js project, so you need it to complie .ts files to .js files which can be used in game.

  • Open the folder with VS Code or some other editors you prefer.
  • Run npm install for libs.
  • Edit index.ts .
  • Run npm run build to complie with webpack.
  • Result: output.js .

You can use vanilla coding styles or OOP styles with classes started with K.

Vanilla Examples

  • /examples: Contains example scripts that may be used as a reference.

OOP Examples

License

All files in this repository are licensed under the MIT License.

About

Repository for LiquidBounce's JavaScript API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.5%
  • JavaScript 6.5%