Skip to content

A platform to run JavaScript on Minecraft and other platforms. Provides tooling for faster content development.

License

Notifications You must be signed in to change notification settings

ClubObsidian/ObbyLang

Repository files navigation

ObbyLang

build License

Fourth generation of ObbyLang for Minecraft and Discord

Description

ObbyLang is a project to run es5 and some es6 JavaScript on Minecraft and on other platforms, it provides support for a number of modules to make content development quicker right out of the box. ObbyLang was written to be a scripting language with similar capabilities to Skript such as: being able to be hot reloaded, unloaded and loaded at will as well as being extendable but with the ability to write code in a formal programming language.

Platforms

ObbyLang supports the following platforms:

  • Bukkit
  • BungeeCord
  • Discord
    • Standalone bot that can run ObbyLang scripts
  • Velocity

Documentation

To work with ObbyLang you will want to be familiar with JavaScript. There is work in progress documentation for the ObbyLang API here. You will also want to be familar with nashorn which you can find documentation for here.

JavaScript Compatibility

ObbyLang runs off of nashorn so it supports es5 with some es6 support.

Supported es6 features:

arrow functions
let
const
block scope
for..of loops
Map
Set
WeakMap
WeakSet
data types
symbols
binary and octal literals

Tooling

ObbyLang supports the following tools:

  • SQL databases
    • With connection pooling through HikariCP
  • Redis
  • InfluxDB
    • With object pooling through influx4j
  • MongoDB

Performance

ObbyLang is pretty fast as it does not interpret Javascript code every time code is ran. ObbyLang takes advantage of nashorn's CompiledScript functionality to interpret code once and then compile it. These compiled scripts then provide values to listeners, commands etc which are quick to execute since they get compiled down into native Java lamdas, which can be confirmed by running a code profiler such as Spark or VisualVM.

Building

You'll need Java 11 or above and then run gradlew shadowJar

Contributing

//TODO - Contributor documents

//TODO - Issue templates

About

A platform to run JavaScript on Minecraft and other platforms. Provides tooling for faster content development.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages