Point Of Interest Mod for TUG

Version 0.2.4

This version of Point Of Interest mod works with TUG alpha build 0.8.4.

What it is?

The mod allows players to mark certain locations as Points of Interest in order to help find those locations easily again on a later point.

Note: This is quite early version of the mod, and not everything is working just yet.

It adds an invisible PointOfInterest.lua gameobject that player and other mods can spawn to the world (via this mod). The mod then keeps track of these objects and their location in relation to player.

Most importantly it adds a compass to show the markers.

How do you use it?

The compass shows you the main directions, and any created markers for Points of Interest that you have decided to mark down.

New Points of Interest are creted by clicking the blue stone like button on the right side of the compass.

Known bugs

This is dev build, and because of that there might be game breaking bugs left.
There is no way to limit what PoI markers are shown on compass. Currently everything is shown, which gets messy after couple of markers.

What is coming later?

Possibility to add name, description and different icon for created PointsOfInterests in GUI. Already possible in code.
Way to show the name of PoI to player. This will possibly be shown above compass when targeting PoI and when reaching it. Gramma's recipes style.
Way to list and edit existing Points of Interest.
Limit visible markers by their distance. Show only nearest n markers, or markers inside radius of m.

Installation

Where to install

Copy all the files into a Mods file under your TUG installation. If you are using Steam, TUG is probably installed at C:\Program Files (x86)\Steam\Steamapps\common\TUG. Under this folder create a folder called 'Mods', if you already don't have one. Inside the Mods folder, create folder 'PointOfInterest' and copy all of this mods files under it.

Easiest way to do this is to download the mod as zip, by clicking the link on this page, and extract everything under \mods. After this just rename the generated folder as 'PointOfInterest'.

In addition to this, you have to edit the file \config\mods.txt and add it the following row below other similar lines:

  "Mods/PointOfInterest"

So that it looks something like:

Mods
{
  "Game/Survival"
  "Game/Creative"
  "Game/Core"
  "Mods/PointOfInterest"
}