YoxiUI-Minimap icon

Minimap

A live minimap in the corner. It renders the world under you in real time, marks you, your boat and your crew, and works with custom islands out of the box.

CHANGELOG

Changelog

1.1.0

It sizes itself to the island now

The islands in this game are nothing like each other. Measured, their radii run from about 29 metres to about 80 - the biggest is nearly three times the width of the smallest - so no single range was ever going to frame them all. One that suits a big island leaves a small one as a dot in a lake, and one that fills the small one shows a corner of the big one.

It now zooms itself to whatever you are standing on. The number does not come from a list kept in this mod, which would only ever cover islands it had been told about: every island scene carries its own size, set by whoever built it, and the game already reads it for its own ambience. So a custom island is framed properly the day it is installed, and there is nothing to configure and nothing for anyone to add it to.

The zoom keys now set how much sea you want around the shore rather than a raw distance, so your preference carries from island to island instead of needing redoing on each one. The readout still shows real metres.

If an island reports a size that is not a believable radius - a map built without the component, say - it falls back to a fixed range rather than showing you something broken, and says so in the log along with the number it saw.

Turn the whole thing off with Scale to the island if you would rather have the same distance everywhere.

Also

  • Zoom is on the up and down arrows rather than Page Up and Page Down. Existing installs keep whatever is already in the config; change it there or delete the file to pick up the new default.
  • The icon is a photograph of the mod running rather than a drawing of one.

1.0.0

First release.

A live minimap in the top right corner.

What it does

  • Renders the world directly beneath you with a second top-down camera, so what you see on it is what is actually there. Nothing is stored and nothing has to be taught: custom islands, added islands and anything built since work with no setup.
  • Marks you in the middle as an arrow pointing the way you are facing.
  • Points the way back to your boat once it is off the edge, with the distance beside it. While the boat is on the minimap there is no marker at all, because the boat itself is in the picture and a dot on top of it was covering up the thing it was pointing at.
  • Marks everyone else in your game.
  • Marks north on the rim.
  • Turns with you by default, or keeps north at the top if you prefer.
  • Stays off until you are actually standing in the world. A local player exists well before you can do anything with it, so waiting on that alone put the minimap over the top of the loading screen showing a half-built island. It now waits for the loading screen to go, the island to finish streaming in, and the player to be switched on.

How it looks

  • A circle with a thin white ring on its rim, and no other furniture. There is no panel behind it: the view is the part worth looking at, so it is very nearly the only part there.
  • The square the camera renders is genuinely cut to that circle rather than covered over at the corners, which is what makes having nothing behind it possible at all.
  • The ring is built to END at the edge rather than to sit just inside it, so it lands on the rim instead of floating a few pixels in.
  • Set in the game's own font, found at runtime, with a hard dark ring round every letter the way the game does it.

Settings

  • Toggle on N, zoom on Page Up and Page Down, all rebindable.
  • Size, margin, opacity, and whether the map turns with you.
  • Show or hide the boat, other players and north independently.
  • Refresh rate and render detail, for anyone who needs the frames back.

Alongside the CustomIslands Loader

  • Made to go with it, but it does not depend on it and works on its own. The loader is found by name rather than referenced, so nothing here breaks when it is absent or when it changes.
  • The loader's full screen chart has been dropped in favour of this. On an older loader that still has it, the minimap gets out of the way while the chart is open.

Notes

  • Contains no game assets.
  • Nothing is networked and nothing is written to your save.