Mods / minimal compass

Category: #QoL
Author: sirlan
Side: Client
Created: Sep 13th at 3:28 PM
Last modified: Oct 1st at 1:43 PM
Downloads: 719
Follow Unfollow 35

Latest file for v1.19.8:
minimalcompass_1.0.0.zip 1-click install


A minimalist compass HUD that displays the cardinal (and ordinal) directions and your waypoints as icons on the top of your screen, more immersive than a minimap but just as useful

You can choose which waypoints it shows by marking them as pinned or unpinned

There are a few options you can toggle with the .minimalcompass command (for client only settings) and /minimalcompass (per world/server*), there's also a settings GUI if you have Config lib installed

One of the options is to require having specific items in the hotbar to show the compass, for more immersion

 

🐲 <( not too pretty, but it works )

 

* the server needs to have the mod installed to change these settings, you can still join servers that don't have the mod, and people without the mod on the client can join servers that have mod, though the server and client mod versions need to be the same for it to work

Version For Game version Downloads Release date Changelog Download 1-click mod install*
v1.0.0 169 Oct 1st at 1:43 PM Show minimalcompass_1.0.0.zip Install now
v0.9.8 149 Sep 24th at 12:25 PM Show minimalcompass_0.9.8.zip Install now
v0.9.1 257 Sep 15th at 12:11 AM Show minimalcompass_0.9.1.zip Install now
v0.8.4 110 Sep 13th at 10:37 PM Show minimalcompass_0.8.4.zip Install now
v0.8.0 34 Sep 13th at 3:33 PM Show minimalcompass_0.8.0.zip Install now

17 Comments (oldest first | newest first)

💬 sirlanAuthor, 4 days ago

ArcticWarfare fair, all of those sound pretty good as visibility options, I think I can do those when I have time by next week

💬 ArcticWarfare, 5 days ago

First of all, great mod! If you'd be so kind, I have some feature requests.

  1. I would love it if I could configure the width of this compass. I use an ultrawide monitor, which makes using this compass VERY disorienting. A few degrees of camera movement translates to the icons flying across the top of my screen much faster than I can visually track them. Staying centered on one waypoint is very difficult. I would love it if I could scale down the compass so that it covered the top third of my screen, proportionally decreasing the speed that icons move around when I move the camera.
  2. A centerline would also help a lot with staying centered on one waypoint.
  3. My screen is also quite tall. A configurable vertical offset would be very helpful to keep the compass closer to my field of vision.
  4. A black gradient background would improve contrast better than the gray gradient background, imo.

If you like these ideas but don't have the energy to implement them, I wouldn't mind taking a stab at implementing them and submitting a pull request. I won't go ahead without your signal since this is your project and I don't want to encroach. If you hate these ideas, I'll probably fork it and implement these changes privately. Thanks!

💬 Snowfall94, Oct 1st at 4:08 PM

Just checked it out, I love the background thing, it helps me be able to actually see it without squinting.

The only thing I have left is a suggestion of making the symbols themselves, as in the directions, the map icons, be a little more "bright" as an option. If that's something you're interested in of course.

💬 sirlanAuthor, Oct 1st at 1:49 PM

Snowfall94 did just tackle both of those issues, both a settings gui, and optional backgrounds

💬 Snowfall94, Sep 29th at 12:47 AM

It'd be great if this had the in game options in that mod settings mod, Idk what it's called I just know there's a button that has "Mod Settings" that I can tweak other mods with. I just can't really see it, it's so faint I have to squint at it (I am blind basically)

And some customization would be amazing. Like to me I think it's too Translucent, I'd personally love to darken it up so it's not so see through.Unless that's a command that I just don't see of course. Like even a dark/darkish background would be much better for me

💬 sirlanAuthor, Sep 24th at 12:27 PM

Cuddly_Khan did just fix that, now the positioning of the icons on the compass do take into account your game FoV and window width, and also added ordinal directions (can be toggled from the settings commands)

💬 Okaibae, Sep 17th at 8:11 PM

Very nice! Just a suggestion, I think a toggle option for the commands would be very helpful for macros, currently you need one to turn it on and another to turn it off.

💬 Cuddly_Khan, Sep 16th at 4:09 PM

I've been using this for a little while now and I've noticed that the FOV of the compass is much too wide. I'm not sure if that makes sense haha. When I look SE, I can see neither S nor E on the compass which gets me a bit lost sometimes. When I look slightly to the left or right of a pinned mark it almost goes entirely off screen. I'm not sure if this is something that is adjustable or not, but even the addition of ordinal directions on the compass would help I think.

💬 sirlanAuthor, Sep 15th at 7:59 PM

DeanBro for the time being not really, as the main design goal is to be minimallist (small-ish and not too eye catching), although am considering having an optional background for visibility, but nothing too decorated

💬 DeanBro, Sep 15th at 4:44 PM

Will there be any future variants of the look? For example skyrim 😁

💬 RuneScholar, Sep 15th at 12:29 AM

That is such a great idea. It adds more flexibility for players who might have other compass mods or who might want to bind a vanilla item to the compass use.

💬 sirlanAuthor, Sep 15th at 12:20 AM

RuneScholar this latest update adds something like that, it doesn't specifically add those items as requirements, but you can configure per world which items you need in your hotbar to enable the compass. Right now you need to already have the item in your hand to be able to set it as required, but you only need to do that once per item. There are more details on the command help for /minimalcompass

💬 Origin_Alpha_43, Sep 14th at 8:32 PM

Good to hear.
great mod btw
i've always been getting off track when trying to head towards waypoints
now i'll know i'm going the right direction 😅

💬 sirlanAuthor, Sep 14th at 10:27 AM

Origin_Alpha_43 tested it, and actually the bad was on my part for doing something wrong, changed a few things, and it might work with that mod in the next update (at least here it works)

💬 Origin_Alpha_43, Sep 14th at 4:41 AM

never mind. found the culprit
Maybe add to the description that it's not compatible with PomShaderCache, "will crash your game"

💬 Origin_Alpha_43, Sep 14th at 4:25 AM

was it tested for server usage? cause i'm trying it, it doesnt seem to wanna work, but crashes if i try to join my server, while simply having it player-side.
i'm about to try if it requires it server-side too or if it crashes as well

edit: server has fully loaded, not a server issue
Crash report says:
at MinimalCompass.HudRenderer.LoadShader() in /home/drag0n/prj/vintage-story/MinimalCompass/MinimalCompass/CompassHud.cs:line 302

💬 RuneScholar, Sep 14th at 1:00 AM

I like this. But I like the immersion of having a physical compass in game with the Compass mod. Would there be a way to tie the functionality of this mod to the requirement of having the compass from that mod on your hot bar?

(edit comment delete)