https://github.com/customrealms/bukkit-runtime

A JavaScript runtime for Minecraft server plugins
https://github.com/customrealms/bukkit-runtime

bukkit gaming javascript minecraft server

Last synced: about 4 hours ago
JSON representation

A JavaScript runtime for Minecraft server plugins

• Host: GitHub
• URL: https://github.com/customrealms/bukkit-runtime
• Owner: customrealms
• License: mit
• Created: 2021-11-10T06:19:11.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T17:51:13.000Z (5 months ago)
• Last Synced: 2024-06-28T21:12:59.611Z (5 months ago)
• Topics: bukkit, gaming, javascript, minecraft, server
• Language: Java
• Homepage: https://customrealms.io
• Size: 112 KB
• Stars: 21
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bukkit-runtime



This is a Bukkit plugin, written in Java, that can execute CustomRealms plugins that are written in JavaScript.

This project implements a JavaScript runtime for running CustomRealms plugins on a Minecraft server. If you're just trying to build a Minecraft plugin using JavaScript, check out [github.com/customrealms/core](https://github.com/customrealms/core).

## How it works

When this plugin is run on a Bukkit-compatible Minecraft server, the plugin launches a V8 JavaScript runtime. Then, it fills that runtime with several globals that allow the JavaScript code to interact with the Minecraft game. Then, finally, it executes the JavaScript code for the CustomRealms plugin.

## JavaScript runtime globals

The JavaScript runtime is populated with several globals. The most basic are `console.log`, `setTimeout`, and a few other related ones. However, the most interesting are related to Minecraft itself.

A few notable globals that are specific to CustomRealms are `Java.resolve`, `BukkitEvents`, and `BukkitCommands`.

The full declaration file for JavaScript globals in CustomRealms is [found here](https://github.com/customrealms/core/blob/master/src/globals.ts).

## How does this project relate to [customrealms/core](https://github.com/customrealms/core)?

This is a Java project that allows you to run JavaScript plugins on a Minecraft server. It implements some bare-bones JavaScript functions, but that's all.

On the other hand, **customrealms/core** is a JavaScript library that picks up where this project leaves off, to make it much easier to build Minecraft plugins. It basically just provides some developer-friendly utilities.

You can create CustomRealms plugins without **customrealms/core**, but you'll find it's much more tedious.

## Contributing

We need your help to solve bugs, implement new features, and optimize the entire system. If you want to help, please join our [Discord](https://discord.com/invite/bbS2ACdTCM) and/or check out the [Issues tab](https://github.com/customrealms/bukkit-runtime/issues).