Mycelium Forms

Warning

This plugin is archived and will not receive any further updates.

A combination of the Mycelium PocketMine-MP plugin and the Nylium virion.

About

Mycelium Forms is another forms library for PocketMine-MP. It was originally created for a server that never ended up being released, and eventually sat forgotten for several years.

Although it was made public around the time of the PMMP EOL announcement, the project has not been tested on recent PocketMine-MP versions (such as 5.44.3).

Components

Mycelium

A PocketMine-MP plugin that acts as a central hub for Nylium networks.

It allows separate plugins to connect to a shared network, making it possible for plugins to access and communicate with each other's registered forms and dialogues.

Furthermore, it provides a custom in-game form builder with forms provided by Nylium.

Nylium

A PocketMine-MP virion for building connected user interfaces.

Instead of manually chaining callbacks and tracking state, Nylium lets you create a network of forms and dialogues that can easily navigate between one another using identifiers.

Supported UI elements include:

• Forms
  • Simple Form
  • Modal Form
  • Custom Form
    • Dropdown
    • Input
    • Label
    • Slider
    • Step Slider
    • Toggle
• NPC Dialogues
  • Custom or vanilla entity display
  • Dialogue text
  • Multiple buttons
• Planned
  • Window UIs (such as villager trading)

All UI elements support callbacks when they are submitted, a button is pressed, or the UI is closed.

It is possible to run various types of actions, such as commands or open other forms. It also provides an API to execute callbacks and to implement custom forms or form elements.

Why?

Nylium was designed to reduce the amount of boilerplate needed when creating connected interfaces.

Forms can be registered with identifiers and opened directly, opened from another form as part of a flow, or even navigated backwards to previously opened forms. This makes it much easier to build larger UI systems without manually keeping track of callbacks and navigation.

Mycelium extends this by allowing multiple plugins to share the same Nylium network through a centralized plugin.

Usage

Documentation is still a work in progress.

You can build the project using Pharynx and composer.

Status

This project is currently provided as an archive of an older project.

License

This project is licensed under the GPL-3.0 license.