Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 3.89 KB

README.md

File metadata and controls

111 lines (83 loc) · 3.89 KB
Raw

Iodine

A Minecraft mod - server plugin pair that adds custom GUIs and overlays. No more inventory and chat menus! This is a successor to NickAc's Lithium project.

This project is under heavy development currently. There are no stable releases, but Bukkit and Forge builds are automatically generated after each commit. These can be downloaded from the Actions page. The plugin API is available through JitPack, see the API section.

Currently a Forge based client-side and a Bukkit based server-side is being worked on. Adding Fabric or especially Sponge support shouldn't be much trouble at all thanks to how the project is structured: Forge and Bukkit are abstracted away.

What this project offers:

  • GUIs that can be viewed and interacted with by multiple players simultaneously
  • Clickable buttons, sliders, checkboxes, linear and grid layouts, etc.
  • Overlays which can be made into minimaps or custom status bars
  • An easy-to-use API for plugin developers to harness this all
  • Security: no remote code execution is done, the bandwidth is minimized as well
  • All this while keeping the Minecraftian feeling!

Showcase

Showcase of some of the implemented elements:

Showcase of a proof-of-concept Factions minimap:

API

Very simple, "Hello World" sample code:

IodineApi.get().createGui()
    .addElement(GuiElements.TEXT, e -> e.setText("Hello, world!").setWidth(75))
    .addElement(GuiElements.BUTTON, 0, 15, e -> e.setText("Exit").setWidth(75)
        .onClicked((ee, p) -> p.closeOpenGui()))
    .onClosed((gui, p, byPlayer) -> p.sendMessage(
        byPlayer ? "You pressed the escape key" : "You clicked the exit button"))
    .openFor(IodineApi.get().getPlayer(player.getUniqueId()));

Real examples can be found in the showcase subproject.

The JavaDocs are available online, hosted on JitPack: latest
(It might take a while to load, because the build might have to run first.)

Gradle coordinates:

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    compileOnly 'com.github.Trigary.Iodine:api:master-SNAPSHOT'
}

Maven coordinates:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.Trigary.Iodine</groupId>
    <artifactId>api</artifactId>
    <version>master-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Modules

This project consists of multiple subprojects, each with their own role:

  • common: contains code that both api and backend require
  • api: the API that plugin developers use, included in server
  • backend: contains code that both server and client require
  • server: contains code that is used by multiple server-side plugin projects
  • client: contains code that is used by multiple client-side mod projects
  • bukkit: the Bukkit plugin part of the project
  • forge-VERSION: the Forge mod part of the project, for the specified version
  • showcase contains sample code, this is an actual Bukkit plugin

The forge-VERSION projects are not real subprojects due to ForgeGradle issues, they are actually considered separate projects by Gradle. The showcase project isn't a subproject either since it's not an actual component in Iodine, it only depends on it.

To recap which projects depend on which:

  • api: common
  • backend: common
  • server: backend + api (inherited: common)
  • client: backend (inherited: common)
  • bukkit: server (inherited: api, backend, common)
  • forge-VERSION: client (inherited: backend, common)
  • showcase: api (inherited: common)