WolfyScript / viewportl

A Minecraft Inventory GUI framework, designed to easily create reactive GUIs. Based on the well known Signal Reactivity System.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Viewportl

Previously WolfyUtils

github_commit

Viewportl is a Minecraft Inventory GUI framework, designed to easily create reactive GUIs.
Based on the well-known Signal reactive system, popularized by web-frameworks like SolidJS, leptos-rs, etc.

It aims to provide a multi-platform GUI framework to quickly and easily integrate GUIs into any plugin/mod.

This repo was previously known as WolfyUtilities, but the GUI API got so advanced, that it deserves a separate library.
Current WolfyUtils Spigot Implementation

Still in WIP (Alpha)

This project is very much still in early alpha!
The API may receive breaking changes at anytime without notice!

Planned (TODO)

These are few of the things planned for the near future.
The list is not complete, and things may be added/removed along the way.

  • Move utils and platform compatibility to a separate project
    • See the scaffolding project
    • Makes this library optional for other plugins, that don't require GUIs
  • Complete name change
    • Rename packages
    • Rename strings & other appearances of WolfyUtils
  • Multi Platform Support
    • Spigot
    • Sponge
    • possibly more in the future

Current API Examples

Examples can be found in the examples directory of the common implementation.
-Example Directory-

Both Kotlin and Java examples can be found there.
Note that Kotlin is recommended for the best Development Experience.

About

A Minecraft Inventory GUI framework, designed to easily create reactive GUIs. Based on the well known Signal Reactivity System.

License:GNU General Public License v3.0


Languages

Language:Java 74.4%Language:Kotlin 25.6%