byteful/minimapgui

An easy-to-use Spigot library that implements a GUI interface within offhand maps.

MiniMapGUI

An easy-to-use Spigot library that implements a GUI interface within offhand maps.

Video

Maven/Gradle Dependencies

Replace Tag with the latest version. (Latest version is in the Releases tab.)

Gradle

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

dependencies {
  implementation 'com.github.byteful:MiniMapGUI:Tag'
}

Maven

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

<dependency>
  <groupId>com.github.byteful</groupId>
  <artifactId>MiniMapGUI</artifactId>
  <version>Tag</version>
</dependency>

Example Usage

public class WarpGUI extends MiniMapGUI {
  private final JavaPlugin plugin;

  public WarpGUI(JavaPlugin plugin, Player player) {
    super(plugin, player);
    this.plugin = plugin;

    wraparoundStages = false;
  }

  @Override
  public void setup() {
    try {
      addStage(
          0,
          SimpleStage.newBuilder()
              .wraparoundOptions(true)
              .addOption(
                  new ImageOption(
                      getPlayer().getWorld(),
                      new URL("someimgurlink.com/image.png"),
                      gui -> {
                        gui.close();
                        gui.getPlayer().teleport(Bukkit.getWorld("world").getSpawnLocation());
                      }))
              .addOption(
                  new ImageOption(
                      getPlayer().getWorld(),
                      new URL("someimgurlink.com/image2.png"),
                      gui -> {
                        gui.close();
                        gui.getPlayer()
                            .teleport(Bukkit.getWorld("world_nether").getSpawnLocation());
                      }))
              .build());
    } catch (MalformedURLException e) {
      e.printStackTrace();
    }
  }

  @Override
  public void onLeftClick(boolean isSneaking, boolean isClickingBlock) {
    if (getCurrentStage() != null) {
      getCurrentStage().nextOption();
      render();
    }
  }

  @Override
  public void onRightClick(boolean isSneaking, boolean isClickingBlock) {
    selectCurrentOption();
  }
}

minimapgui's Issues

Optimize map rendering and re-use map views.

Map rendering currently is continuously ran. Maybe each MiniMapGUI instance can have its own renderer instead of each option. MapViews are also created and disposed of carelessly. This can clutter up the amount of maps in the server.

Add GIF support and add a text option (renderer).

Add support to use .gif files. The image will be split into multiple BufferedImages with a tick delay attached to each. A global tick delay will also be available.