Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lokka30/rulesengine

[MC] Library to integrate YAML-based scripting into plugins
https://github.com/lokka30/rulesengine

bukkit library minecraft scripting yaml

Last synced: about 1 month ago
JSON representation

[MC] Library to integrate YAML-based scripting into plugins

Awesome Lists containing this project

README

        

# RulesEngine

**Work in progress and not yet suitable for production usage; see Roadmap below.**

A small Kotlin library to enhance Bukkit/Velocity/Folia/Bungee/Minestom/Krypton plugins with an expandable YAML scripting engine.

## Quick Links

| |
|--------------------------------|
| [Rules Example][Rules Example] |

## How It Works

By integrating RulesEngine into your plugin, server administrators can use the power of your plugin with YAML-based scripting to make something powerful. For example, a 'run commands on ' plugin can be configured almost purely with RulesEngine scripts and its built in features.

## Roadmap

Show/Hide

### Stage 0

- [ ] Core implementation complete
- [x] Work in Progress

### Stage 1
- [ ] Bukkit platform implementation complete
- [ ] Velocity platform implementation complete

### Stage 2
- [ ] Folia platform implementation complete
- [ ] BungeeCord platform implementation complete

### Stage 3
- [ ] Minestom platform implementation complete
- [ ] Krypton platform implementation complete

## 📜 License

RulesEngine is licensed under GNU GPL v3.0: see [License][License].

- Copyright (c) 2024 lokka30

[License]: LICENSE.md
[Rules Example]: misc/rules-example.yml