Navigator

Navigator is an api mod that allows for other mods to add integration for

• JourneyMap
• Xaeros World & Minimap
• VoxelMap (Limited support)

Dependencies

• GTNHLib

Documentation

Example Layer Implementation

Navigator provides a debug layer which can also be used as a template for your own layers.

• JourneyMap Dirty Chunk Layer
• Xaeros Dirty Chunk Layer
• The ButtonManger, LayerManager and the ILocationProvider are always shared between the two mods.

Example JourneyMap Layer

Navigator provides an API for custom and interactive layers. This API will keep all maps as optional mod at runtime and not crash you game if it is missing.

Start by extending LayerManager this will eventually handle all the logic behind your layer and will also generate a cached list of your ILocationProvider implementation. You should only add whatever items are visible to this list. There are more methods to override, that will assist you with that. Take a look!

class MyLayerManager extends LayerManager {

    public static final MyLayerManager INSTANCE = new MyLayerManager();

    public MyLayerManager() {
        super(buttonManager);
    }

    @Nullable
    @Override
    protected LayerRenderer addLayerRenderer(InteractableLayerManager manager, SupportedMods mod) {
      // You can safely return null here until you have implemented your own LayerRenderer.
        if(mod == SupportedMods.JourneyMap) {
          return new MyLayerRenderer();
        }
        return null;
    }

    @Override
    public void updateElement(ILocationProvider location) {
      // Update the information of your location here
    }

    @Override
    protected @Nullable ILocationProvider generateLocation(int chunkX, int chunkZ, int dim) {
        return new MyLocation();
    }
}

Next up extend ButtonManager to create your own logical button.

class MyButtonManager extends ButtonManager {

  public static final MyButtonManager INSTANCE = new MyButtonManager();

  @Override
  public ResourceLocation getIcon(SupportedMods mod, String theme) {
    return new ResourceLocation(YOUR_MOD_ID, "textures/icons/example.png");
  }

  @Override
  public String getButtonText() {
    return "My Button";
  }
}

If you start the game now, you will see a new button in the menu!

Continue by implementing ILocationProvider. This class is a container and will provide all information required to display your item on screen. It won't do any rendering.

class MyLocation implements ILocationProvider {

    public int getDimensionId() {
        return 0; // overworld
    }

    public int getBlockX() {
        return 0;
    }

    public int getBlockY() {
        return 65;
    }

    public int getBlockZ() {
        return 0;
    }

    public String getLabel() {
        return "Hello Minecraft";
    }
}

Congratulations, you have finished the logical implementation of your custom map layer! Now it is time for the visual integration. This example is provided for JourneyMap, but you might as well take a look at the other possibilities. You will need to follow it up with an implementation of JMRenderStep, this class will receive an instance of MyLocation and perform the actual rendering.

class MyDrawStep implements JMRenderStep {

    private final MyLocation myLocation;

    public MyDrawStep(MyLocation myLocation) {
        this.myLocation = myLocation;
    }

    @Override
    public void draw(double draggedPixelX, double draggedPixelY, GridRenderer gridRenderer, float drawScale, double fontScale, double rotation) {
        final double blockSize = Math.pow(2, gridRenderer.getZoom());
        final Point2D.Double blockAsPixel = gridRenderer.getBlockPixelInGrid(myLocation.getBlockX(), myLocation.getBlockZ());
        final Point2D.Double pixel = new Point2D.Double(blockAsPixel.getX() + draggedPixelX, blockAsPixel.getY() + draggedPixelY);

        DrawUtil.drawLabel(myLocation.getText(), pixel.getX(), pixel.getY(), DrawUtil.HAlign.Center, DrawUtil.VAlign.Middle, 0, 180, 0x00FFFFFF, 255, fontScale, false, rotation);
    }
}

Continue with your own implementation of JMLayerRenderer. This class will cache all Rendersteps and provide it to JourneyMap whenever it is time to render.

class MyLayerRenderer extends JMLayerRenderer {

    public MyLayerRenderer() {
        super(MyLayerManager.instance);
    }

    @Override
    protected @Nullable RenderStep generateRenderStep(ILocationProvider location) {
        return new MyDrawStep((MyLocation) location);
    }
}

Finally, you will need to register your new layer with Navigator. This should only be done client-side and is done through the NavigatorAPI class during any one of the init phases.

NavigatorApi.registerLayerManager(MyLayerManager.INSTANCE);