smrkn-Minimap icon

Minimap

Flexible and customisable minimap mod.

Last updated 3 weeks ago
Total downloads 91
Total rating 0 
Categories
Dependency string smrkn-Minimap-0.1.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_LensIsland-5.4.2303 icon
BepInEx-BepInExPack_LensIsland

BepInEx modloader. Preconfigured and ready to use.

Preferred version: 5.4.2303

README

Minimap

Adds a minimap to Len's Island. Actively under development, so expect the odd bug or incomplete feature.

Preview

Perspective Orthographic Orthographic + Flatten
8084e6c4-9f92-4579-80bb-ea682cde1f29 4d58830d-c7a8-4447-9b56-6f726ace690a 3c8a1c46-766b-4923-9d92-a418f6502614

See Rendering Style for more information about each mode.

Configuration

Several options are provided for customising the minimap to behave however you see fit.

Replace Compass

If you are using the default overlay, you may wish to disable the vanilla compass as the default overlay includes cardinals.

Rotate with Player

You can toggle rotation, or have the minimap in fixed orientation. Whatever floats your boat.

Custom Overlay

If you're artsy or simply hate the bland default, a Krita template is provided in the Overlays directory for you to customise the border of the minimap to your heart's content.

If you are creating a custom overlay to distribute via Thunderstore, your package should have the following structure:

.
├── BepInEx/
│   └── plugins/
│       └── smrkn-Minimap/
│           └── Overlays/
│               └── YourOverlay.png
├── icon.png
├── manifest.json
└── README.md

Camera Height

Typically, you won't need to touch this by hand. This is just how the plugin remembers your previous zoom level.

Zoom is currently controlled with 9 and 0, keybind support will be available in future updates.

Rendering Style

There are currently two different styles provided, aiming to cover different preferences for how a minimap should look/feel.

Orthographic

Orthographic more commonly resembles what many people are familiar with when they think of minimaps. Very two dimensional with limited to no depth.

[!NOTE] The game's water shader does not work with orthographic mode out of the box.

I've had to improvise a little with making something appear in place of water.

If orthographic mode still isn't quite what you're after, there's an optional "Flatten" mode.

Perspective

Perspective rendering behaves just like the main game camera except top down. This may be renamed to something like "3D Mode" for simplicity in future.

This is the default setting.