Mods / minimal compass
Author: sirlan
Side: Client
Created: Sep 13th 2024 at 3:28 PM
Last modified: 3 days ago
Downloads: 3282
Follow Unfollow 103
Latest file for v1.20.3:
minimalcompass_1.1.3.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 to show by pinning them
- you can also choose to show all waypoints
- also set a maximum distance for waypoints to appear
- shows waypoint name and distance
- keybind to toggle compass
- can be configured to only show compass when holding a specific item, and which item it is
- this is a server side setting, if the server you join has the mod and this option enabled, it will apply to you
- players without the mod can still joint the server, and you can still join server that don't have the mod
- this is a server side setting, if the server you join has the mod and this option enabled, it will apply to you
- customizable with chat commands (with documentation in the help menu)
- compatible with Config Lib (at least v1.4.3) for a settings menu (do recomend)
- compatible with shared waypoints from Cartographer (at least v2.0.11)
- there are visual options for better visibility, like enabling a background, changing margins, and some others
= client commands
* set <option> <value>
| toggle different options of the compass with 'on' or 'off',
| or some other values
|
| * directions, ordinalDirections,
| * waypoints, waypointName, centerLine
| | show or hide each element
|
| * show
| | show or hide the whole compass
|
| * backgroundTexture ['none' 'simple' 'solid']
| | set background texture
|
| * horizontalMargin [size]
| | set horizontal margin in pixels
|
| * verticalOffset [size]
| | set vertical offset in pixels
|
| * textSize [size 16 to 24]
| | set the size of the waypoint name text
|
| * wpShadowColor ['black' 'white']
| | set colour of waypoint shadows
|
| * showUnpinned
| | also show unpinned waypoints
|
| * maxWpDistance [distance]
| | sets the maxium distance for wayppoints to show up
| | set this to 0 for no maximum distance
|
| * pinnedAlwaysShow
| | (if the maximum waypoint distance is set
| | and show unpinned is on)
| | pinned waypoints always show independent of
| | the maximum distance
|
| * iconSize [from 0.75 to 1.5]
| | set the size of icons in the compass
|
| * sharedWaypointOwner
| | (if you also have Cartographer mod installed)
| | whether or not to show the waypoint owner
| | besides the waypoint name
|
| * bypassHudCheck
| | when set to 'on' this mod will
| | ignore the check if some other mod controls the
| | block info hud and show the compass anyway
| | (may cause clashes)
|
| * ignoreHudWarnings
| | don't show the warnings if another mod controls
| | the info hud (if you know what you're doing)
|
> examples
.minimalcompass set directions off
.minimalcompass set waypointName on
.minimalcompass set textSize 20
.minimalcompass set wpShadowColor black
* settings <option>
| show or reset your current client settings
|
| * show
| | displays your client settings
|
| * reset!
| | resets your client settings to default
|
> examples
.minimalcompass settings show
.minimalcompass settings reset!
= server commands
* set <option> <value>
| also uses 'on' or 'off'
|
| * requiresItem
| | if you need specific items in your hotbar to show the compass
|
> examples
/minimalcompass set requiresItem on
* requiredItems <option> <value?>
| if 'requiresItem' is 'on' then you can use these to configure
| which item you need to show the copmass, there can be more than one
|
| * list
| | list the items that when held enable the compass
|
| * addHeld
| | add the currently held (seleced in the hotbar)
| | item on the list of items needed to show the compass
|
| * add [code]
| | adds an item code to the list of items needed to show
| | the compass
| | (use the command `.edi` to toggle showing item codes when hovering
| | them on the inventory, they are in the 'modId:itemId' format)
|
| * remove [code]
| | removes an item code from the list of items needed to
| | show the compass
|
| * clear!
| | clear the list of items needed to show the compass
|
> examples
/minimalcompass requiredItems addHeld
/minimalcompass requiredItems addItem compass2:compass-magnetic
* settings
| save the world settings to a file (`ModConfig/minimalcompass.server.json`)
| or load the settings from such fille (will ovewrite current settings)
|
> examples
/minimalcompass settings save
🐲 <( not too pretty, but it works )
ℹ️ if you have some other mod installed that patches the block info hud (for example Extra Info), this mod can't change its position reliably, so it will hide the compass whenever the info hud is shown, this is intended behaviour, it's a limitation of the game's code that no two mods can reliably patch the same component
if you did like this mod, consider byuing me a salad 🥗
btw when you comment here, you don't net to @ me, I already get a notification for comments, mentioning gives repeated notifications
Version | For Game version | Downloads | Release date | Changelog | Download | 1-click mod install* |
---|---|---|---|---|---|---|
v1.1.3 | 329 | 3 days ago | Show | minimalcompass_1.1.3.zip | Install now | |
v1.1.2 | 302 | 5 days ago | Show | minimalcompass_1.1.2.zip | Install now | |
v1.1.1 | 165 | 6 days ago | Show | minimalcompass_1.1.1.zip | Install now | |
v1.1.0 | 60 | 6 days ago | Show | minimalcompass_1.1.0.zip | Install now | |
v1.0.6 | 115 | 6 days ago | Show | minimalcompass_1.0.6.zip | Install now | |
v1.0.4 | 156 | Jan 22nd at 10:01 PM | Show | minimalcompass_1.0.4.zip | Install now | |
v1.0.3 | 186 | Jan 21st at 11:21 PM | Show | minimalcompass_1.0.3.zip | Install now | |
v1.0.2 | 899 | Oct 22nd 2024 at 1:11 PM | Show | minimalcompass_1.0.2.zip | Install now | |
v1.0.0 | 356 | Oct 1st 2024 at 1:43 PM | Show | minimalcompass_1.0.0.zip | Install now | |
v0.9.8 | 183 | Sep 24th 2024 at 12:25 PM | Show | minimalcompass_0.9.8.zip | Install now | |
v0.9.1 | 298 | Sep 15th 2024 at 12:11 AM | Show | minimalcompass_0.9.1.zip | Install now | |
v0.8.4 | 151 | Sep 13th 2024 at 10:37 PM | Show | minimalcompass_0.8.4.zip | Install now | |
v0.8.0 | 78 | Sep 13th 2024 at 3:33 PM | Show | minimalcompass_0.8.0.zip | Install now |
Good to know. Thank you!
@sirlan Thank you so much!
Pentasis added minimum distance setting
prototype464 maybe, will specifically consider when this mod gets to a point it doesn't get that many more changes for the near future, as is quite more work to support different versions of the game including different versions of other mods this interacts with
Any chance of a 1.19.8 backport of the latest fixes / Cartographer support?
Can I make a feature request? I'd love to also have a Minimum Distance setting so a waypoint does not show within that range (e.g. setting it to 100 would mean the waypoint does not show if you are within 100m of it)
MarximusMaximus the thing is that both mods patch the same method of the info hud class at runtime, with extra info's patch replacing the entire function body (mine just replacing a single value). To be 'compatible' with it would require both mods to work together⁽¹⁾ (i.e. both me and the other dev add logic to handle if both are installed) instead of one forcefully trying to ovewrite another either by re-patching the function or by creating another hud that would appear in front of theirs (which then could lead to people sending them bug reports when in fact would be my mod that is messing up); working together might be an option in the future (also this would apply to other mods that add hud elements, so quite mroe work), but right now I just choose to go the safe way and run in 'safe mode', if another mod touches that element the compass will hidden whenever the hud is shown, if you toggle the hud off (ctrl + b) the compass will appear, or you can override that so the compass appears behind the hud
(1) to be honest the better solution would be if the game devs refactored the ui to be more easily changed at runtime, instead of needing to patch them as they contain some hardcoded values, so for example a mod that changes the content of the hud would only touch the content methods, and a mod that changes its margins would would touch the margin variable, etc
As per your "i" message above, I disabled Extra Info, which I've had enabled this entire time (when the compass was working), and now it works. So either something changed between that mod or this mod that makes them no longer compatible together.
re: cannot reliably patch the same component -- Apologies if these are dumb questions. Is it possible to list another mod as an optional dependency for VS (this is a thing for Rimworld)? If so, can you copy off the existing function's reference, whatever it is, then patch yours, then call whatever the old one was? This is what some other mods seem to be doing to achieve reliability. Unsure if both conflicting mods in that case are doing it, or if one is forcing itself to load after the other one. Alternatively, could you just not patch that element and make your own element how StatusHUD does?
For some reason the last two updates don't show the compass anymore for me. I already tried resetting to default settings via GUI as well as manually deleting the config json file. Any ideas?
Great mod! Very usefull if you'd like to know where you are going, without the minimap taking up your screen space, or having to open your big map.
sirlan Damn, great work. The option to always show pinned, but show unpinned when nearby sounds like a nice feature. The less I have to open my map, the more valuable this mod is to me.
Edit: It seems this functionality is already implemented in 1.1.1. Incredible, haha.
MRGOOSE this latest 1.1.1 version might solve it?
it seems to only affect pinned waypoints by other players. my pinned shared waypoints do show
MRGOOSE I can't reproduce your issue, are you're sure you tested on the latest version of the mod? (and there can also be some issues with incompatible settings, you can try deleting this mod's setting file ModConfig/minimalcompass.json)
Also, won't add that; I am considering adding an extra mode later on where unpinned waypoints show up to a certain distance, and pinned waypoints always show up
pinned shared waypoints dont show and count as unpinned waypoints on the compass. also add a second slider for max distance for pinned waypoints
sirlan You are on a roll! Thanks for the quick updates! <3
Cuddly_Khan there's now a setting for the size of the waypoints and directions
BBlaze there's now an option to only show waypoints closer than a certain distance
ballou do you have some other mod that changes the hud installed? (for example extra info)
if so then this is the intended behaviour, as for now two mods can't really patch the same component and guarantee that it works, this is on the game's code so I can't do anything about it besides to go other mod devs and ask for changes on their mods to be compatible
if you don't have, then there is an error in this mod
Would it be possible to have an option for change the text size of the Cardinal and Ordinal directions as well? They seem a bit small to me. Maybe it's because I'm at 1440p but idk if that would effect it or not.
Great mod! I have a suggestion, however:
I often find that I have to open my map to find markers that are very close to me by happenstance but that I don't want to pin, such as resin trees for example. Showing all markers is also not really viable. Would it be possible to add a feature where map markers appear or fade in as you near them?
Just an idea. Thanks for making this!
Hello sirlan,
your mod does not work when the block info is checked in games can you fix the problem because I think the 2 overlays conflict. Thank you for the mod you created.
Cuddly_Khan ".minimalcompass set bypassHudCheck on", because is more of a debug/non intended setting won't really put it in the gui settings, all commands are listed in the in game guide though, also just put them in this page
How do I toggle bypasshudCheck to on? I can't see an option in the config for it, and I don't see it in settings either.
sirlan
gotta say
thank you all for the over 2000 downloads!! 🎉
MRGOOSE just did both
make it compatible with shared waypoints from cartographer mod and add a config to allow non pinned waypoints to be shown too.
Seems like I have a third mod that does the same thing but can't find its name (since it's first, his patching is successfull).
Shion with a quick look, both mods are trying to patch the same piece of code in the game (the `ComposeBlockInfoHud` method), so there is incompatibility there, although am not getting the same error here on testing, just having the info hud not go down. Will look a bit more into it to see if something helps, but at least at first thought they might keep being incompatible, unless there's a less hacky way to change the info hud top margin (or I add some 'compatibility mode' that doesn't move the hud)
23.1.2025 03:45:24 [Error] [minimalcompass] An exception was thrown when trying to load assembly:
23.1.2025 03:45:24 [Error] [minimalcompass] Exception: Assembly with same name is already loaded
at System.Runtime.Loader.AssemblyLoadContext.g____PInvoke|5_0(IntPtr ptrNativeAssemblyBinder, UInt16* ilPath, UInt16* niPath, ObjectHandleOnStack retAssembly)
at System.Runtime.Loader.AssemblyLoadContext.LoadFromAssemblyPath(String assemblyPath)
at System.Reflection.Assembly.LoadFrom(String assemblyFile)
at System.Linq.Enumerable.SelectListIterator`2.MoveNext()
at System.Linq.Enumerable.WhereEnumerableIterator`1.ToList()
at Vintagestory.Common.ModContainer.LoadAssembly(ModCompilationContext compilationContext, ModAssemblyLoader loader) in VintagestoryLib\Common\API\ModContainer.cs:line 481
Is it not compatible with Extra Info? It gives the same error.
Cuddly_Khan it already is a server side config, the server you join has to have the mod also installed to enforce it though
Would it be possible to make the config option to set the compass to a specific item as a server side config so that on servers that require you to craft a compass it applies to all users? Or would that require having this as a separate mod?
Brick fixed the lag in this latest (1.0.4) update, was because each waypoint was trying to change the text at the same time
LunaGore just added the font size setting, and you could already change the compass width (the horizontal margin setting)
Thank you for the update!! Hope life is going well, and if not, that it will be soon!
sirlan Can you add the ability to customize the font size and the width of the compass?
Thanks for the update! I've been looking forward to using this one again. :D
I hope you're doing well.
hey yall, sorry for not updating this in a while, was quite occupied with other life things, but now am back to update and fix this as necessary, thanks for your patience
Hoping for a 1.20 update. I installed this on 1.19 right before 1.20 came out and loved it so much. Only to be disappointed when it didn't work anymore! T_T
Hope you can find the time. Thank you!
Sadly does not seem to work on 1.20.0-rc.8
When you have a lot of pinned waypoints far away, they cluster together and create lag spikes in the game when you look in that direction.
sorry for taking quite some time to update, was pretty busy these days
SE and SW seem to have swapped places with eachother.
ArcticWarfare fair, all of those sound pretty good as visibility options, I think I can do those when I have time by next week
First of all, great mod! If you'd be so kind, I have some feature requests.
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!
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.
Snowfall94 did just tackle both of those issues, both a settings gui, and optional backgrounds
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
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)
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.
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.
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
Will there be any future variants of the look? For example skyrim 😁
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.
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
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 😅
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)
never mind. found the culprit
Maybe add to the description that it's not compatible with PomShaderCache, "will crash your game"
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
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?