Mods / Campaign Cartographer

Category: #Cosmetics #Other #QoL #Tweak #Utility
Author: Apache
Side: Both
Created: Feb 16th 2021 at 2:23 PM
Last modified: Apr 8th at 4:54 AM
Downloads: 3872
Follow Unfollow 66

Campaign Cartographer

Adds multiple Cartography related features to the game, such as custom player pins, GPS, auto waypoint markers, and more.

This mod can be installed as a client-side only mod, which will allow you access to most of the features of the mod. If the mod is also installed on the server, extra features will be available to you. These features have been highlighted below.

SERVER OWNERS: If you install this mod on your server, it will remain as an optional mod for your clients. They can choose whether or not to have it installed on their client, and it will not cause any issues logging on, if they don't have it installed.

Languages:

  • English (100%)
  • French (100%)
  • Russian (100%)

If you would like to contribute your expertise in a language to translate this mod, or other mods within my Mod Suite, or if you spot any mistakes within the translations that have already been contrributed, please send me a message on my contact page, or leave a feature request on my issue tracker for this mod.

Features:

  • Manual Waypoint Addition (.wp)

    Quickly and easily add waypoints at your current position, via the chat window. There are over 130 pre-defined waypoints for many different block types, and areas of interest.

    • Add a waypoint at the player's current location, via a chat command. (.wp)
    • Add a waypoint to a translocator, within five blocks of the player. (.wptl)
    • Add a waypoint to a teleporter block, within five blocks of the player. (.wptp)
    • Add a waypoint to a trader, within five blocks of the player. (.wpt)
    • Add a waypoint for the block the player is currently targetting. (.wps)
    • Toggle the Manual Waypoints settings window. (.wpSettings) (Default HotKey: F7)
      • Change the waypoint settings for BlockSelection waypoints.
      • Add new pre-defined waypoint types.
      • Edit existing pre-defined waypoint types.
      • Remove existing pre-defined waypoint types.
  • Automatic Waypoint Addition (.wpAuto)

    Make exploration even more rewarding, by documenting your journeys as you travel. From rock strata, to traders, to essential foodstuff; waypoints are added as you interact with the world.

    • Automatically add waypoints for Broken Translocators, as the player steps on them.
    • Automatically add waypoints for Repaired Translocators, as the player travels between them.
    • Automatically add waypoints for Teleporters, as the player travels between them.
    • Automatically add waypoints for Traders, as the player interacts with them.
    • Automatically add waypoints for mine-able Ores, when the player collects surface deposits.
    • Automatically add waypoints for Rock types, when the player collects loose stones.
    • Automatically add waypoints for Berries, Mushrooms, and Resin, when the player harvests them.
    • Toggle the Auto Waypoints settings window. (.wpAuto)
      • Enable / Disable automatic waypoint placements for each type.
  • Centre Map (.cm)

    Allows you to centre the mini-map, and world map on any location you wish.

    • Re-centre the map on the current player. (.cm)
    • Re-centre the map on any specific X, Z coordinates. (.cm pos)
    • Re-centre the map on any specific online player. (.cm player)
    • Re-centre the map on world spawn. (.cm spawn)
    • Re-centre the map on a specific waypoint. (.cm wp)
    • Re-centre the map on player's spawn point. (.cm home) (Requires Server Installation)
  • Global Positioning System (.gps)

    Display and share your current location within the world.

    • Display your current XYZ coordinates. (.gps)
    • Copy your current XYZ coordinates to clipboard. (.gps copy)
    • Send your current XYZ coordinates as a chat message to the current chat group. (.gps chat)
    • Whisper your current XYZ coordinates to a single player. Disabled by default. (.gps to) (Requires Server Installation)
    • Admin: Change permissions to whisper other members of the server. (/gpsAdmin) (Requires Server Installation)
      • Enable whispers between players. (/gpsAdmin enable-whispers)
      • Disable whispers between players. (/gpsAdmin disable-whispers)
  • Customisable Player Map Pins (.playerPins)

    Change the colour and scale of player pins on the world map.

    • Add other players as friends, to distinguish their player pins on the map. (.friend add)
    • Remove a player as a friend. (.friend remove)
    • Toggle the Player Pins settings window. (.playerPins)
      • Change settings for your own player pin.
      • Change settings for the player pins of friends on the server.
      • Change settings for the player pins of other people on the server.
  • Waypoint Utilities (.wpUtil)

    A selection of utility commands that makes working with waypoints a lot easier.

    • All purge commands will need confirmation. (.wpUtil confirm)
    • Purge all waypoints. (.wpUtil purge-all)
    • Purge all waypoints within a given radius of the player. (.wpUtil purge-nearby)
    • Purge all waypoints with a specified icon. (.wpUtil purge-icon)
    • Purge all waypoints with a specified colour. (.wpUtil purge-colour)
    • Purge all waypoints where the title starts with a specified string. (.wpUtil purge-title)
    • Reset "FirstRun" settings, and re-open the FirstRun GUI. (.wpUtil reset)
    • Toggle the Waypoint Export window. (.wpUtil export)
      • Choose which waypoints to export.
      • Export waypoints to file.
    • Toggle the Waypoint Imports window. (.wpUtil import)
      • Import waypoints from file(s).

Client-Side Commands:

Command Description
.wp Add a waypoint at the player's current location, via a chat command.
.wptl Adds a waypoint to a translocator, within five blocks of the player.
.wptp Adds a waypoint to a teleporter block, within five blocks of the player.
.wpt Adds a waypoint to a trader, within five blocks of the player.
.wps
Adds a waypoint to the block the player is currently targetting.
.wpUtil Various utilities for managing waypoints, en-masse.
.wpSettings Toggle the Manual Waypoints settings window.
.wpAuto Toggle the Auto Waypoints settings window.
.cm Centre the mini-map, and world map on a specific location.
.gps Display and broadcast your current location.
.playerPins Toggle the Player Pins settings window.
.friend Distinguish a player's marker pin on the map.

Server-Side Commands:

Command Description
/gpsAdmin Change GPS settings for the server.

Acknowledgements:

Thank you to the following people:

  • Doombox: Original creator of the Customisable Player Pins feature.
  • egocarib: Huge inspiration for much of the Auto Waypoints feature.
  • Melchior: For assistance with ProtoBuf, and overwriting vanilla classes.
  • Craluminum2413: Translation into Russian, and playtesting.
  • Aledark: Translation into French, and playtesting.
  • Novocain: Original creator of some of the back-end reflection helpers, and ClientSideEverywhere hack.
  • Tyron: For refactoring some of the API to make this mod easier to make.

Version For Game version Downloads Release date Changelog Download
v2.2.2 853 Apr 8th at 4:54 AM Show ApacheTech.VintageMods.CampaignCartographer_v2.2.2.zip
v2.2.1 53 Apr 6th at 5:38 PM Show ApacheTech.VintageMods.CampaignCartographer_v2.2.1.zip
v2.2.0 171 Mar 31st at 11:37 PM Show ApacheTech.VintageMods.CampaignCartographer_v2.2.0.zip
v2.1.3 256 Mar 19th at 4:42 PM Show ApacheTech.VintageMods.CampaignCartographer_v2.1.3.zip
v2.1.2 280 Mar 8th at 7:27 PM Show ApacheTech.VintageMods.CampaignCartographer_v2.1.2.zip
v2.1.1 127 Mar 8th at 6:15 AM Show ApacheTech.VintageMods.CampaignCartographer_v2.1.1.zip
v2.1.0 132 Mar 6th at 2:24 PM Show ApacheTech.VintageMods.CampaignCartographer_v2.1.0.zip
v2.0.2 337 Jan 22nd at 11:36 PM Show ApacheTech.VintageMods.CampaignCartographer_v2.0.2.zip

30 Comments (oldest first | newest first)

Apache, Jun 1st at 2:38 AM

bringitonwimps,

There is currently no way, in game, to share waypoints from person to person. This is something that I plan to work on in future. Currently, the best way to share waypoints is to export the waypoints you wish to share, and then send the JSON file to someone else to import. It's not the best solution, but it's all we have, for now.

bringitonwimps, May 18th at 12:10 AM

So when we put down waqypoints with .wp 'name'  no one else can see the waypoint but we can see everyones "auto points"  is that a setting or intended or do you have to use export import to share? how does this work?

Apache, May 6th at 10:48 AM

Shion,

I'm planning on a major overhaul of the whole waypointing system in this mod. I've been putting off for as long as I can, because it's going to be a pain to write. I want it to be a lot more modular than it currently is; so I can easily map between block codes and waypoint types. At that point, I will definitely be able to make `.wps` a much more useful command. I can't promise it will be soon, but it has been added to the backlog.

As a user,
Given I am using the `.wps` command,
When the command is activated,
Then it should map the block selection to a pre-defined list of waypoint types.

Shion, May 5th at 3:12 AM

Is it not possible for .wps command to make a fitting waypoint the same way Automatic Waypoint addition works?

Apache, Apr 16th at 10:37 PM

PeterSanderson. With v2.2.2, I've tested in Single-Player, on a LAN Game, and on three different SMP servers; with and without the mod installed Server-Side. I cannot get the game to freeze when cutting down trees like it used to. This issue was caused by excessively determining which app-side the code was running on. I've now addressed this, by caching the app-side that the current thread is running on. It was such an issue with trees because each block update as it's determining the extent of the tree-cut, re-calculated the app-side. Usually multiple times per block. Make sure you're using v2.2.2, and if problems persist, open in issue on my GitHub, and give full details, including your PC specs, and software versions. I can then set up a virtual machine with your exact PC specs, so I can test it fully to try to reporoduce the bug.

PeterSanderson, Apr 14th at 6:23 PM

I seem to still be getting a freeze on chopping down a tree

Apache, Apr 8th at 1:47 AM

Thanks for the feedback. I'll have to revert the changes. This means it won't be able to downloaded by the auto-download feature for servers.

CreativeRealms, Apr 7th at 8:24 PM

I was having an issue where when trying to join a SP world with v2.2.1, the game would bring me to a screen in which it asks if I want to download the mod and if I click yes it crashes. Managed to bypass it for now by removing the "RequiredOnClient" section in the modinfo file.

Ikirou, Apr 7th at 6:49 PM

Ye Having same Problem as PeterSanderson

PeterSanderson, Apr 7th at 3:05 PM

Had 2.2.1 installed on MP server and a copy in my client mod folder. Went to join my server and the download screen came up:

"Checking campaigncartographer@1.0.0... No such version... Ask the mod author to upload this version on moddb"

Rolling back to 2.2.0 for now

Lisabet, Apr 2nd at 5:15 AM

Is there a way to save my configuration so that it works for any new maps/worlds that I start? I feel like there was a setting the very first time I used the mod and I can't remember if I checked the right boxes to save my settings for future maps.  My vision isn't what it used to be and I end up changing all of the icons from the pickaxe one to the star or diamond ones because they're easier for me to see on the map and it gets a bit frustrating to need to redo it every time I start a new map (and I like making new maps :P)

edit ok, I found the .wputil reset thing; any chance you can get the popup without having to reset the whole batch of autowaypoints? lol...at least I should only need to fix them one last time if it works :)

macoto_hino, Mar 24th at 4:16 AM
Assassin_chad_23, Mar 24th at 2:45 AM

Love the mod  BUT...   Found tonight that it is causing crashes with translocators.   Live on stream the game kept crashing.  I have a clip on my twitch of what is happening and 3hours 15 minutes in to todays stream you can see when i fix the issue.  Tested both single and MP server.  as soon as you touch a translocator the game will freeze no spinning but you will hear noise.  I killed off all my mods and one by one turned them back on and this mod was the culprit.  I was on the older version but i updated to the newest (.3)  and it was still happening.    Hope you can figure out the issue.  If you need crashlogs ask me as i do have a few.    Oh my twitch is my name here

Nashty, Mar 21st at 8:00 PM

Thanks Apache!  It is but a minor inconvenience.  I set up new pre-defined waypoints for them, but it was really nice when I could just right click them and magic happened!

I have not examined your code much, but I have an idea for a new feature that may or may not be feasible:

In the pre-defined waypoints, have a field for the search term such that when one interacts with that entity it triggers the /waypoint addati.

P.S. Loving the Rusty Gears!

Apache, Mar 19th at 5:21 PM

Nashty,

I'll be adding a Interop library soon, that will allow other mods to extend the functionality of the auto waypoints features. This may take some time though, as it will mean a major re-structure of the auto waypoints feature.

Apache, Mar 19th at 5:18 PM

Mamessu, what is the name of the other mod? Can you share a link to it? I might be able to add a compatibility feature. Because of the way this is implemented, if someone is determined to cheat, they will do; it's all client-side. Even the mod that you use to disable the map-pins will implement it, client-side. There's also another mod called "Custom Player Pins", by DoomBox, which is what this feature was based on. All systems, such as the ones you have implemented, work on an honour system. None of it can be policed, or kept safe from people that are determined to break the rules.

While I can change my mod to work in this one edge case, it would be better to create a much more robust solution for your circumstances. For instance, this mod can only work with data that is sent to it, from the server. If you had a server mod, that filters players based on their map-pin display preference; then the player position will never even be broadcast to the client. This can be done pretty simply by changing their "DefaultTrackingRange" from 128, to 0, (saving this to a JSON file for persistence) when the preference is enabled. Everything else should be automatically determined from there. In that way, no client-side mod will ever be affected, or can affect the running of that feature.

Personally, I would not want to add that functionality into this mod. It goes against what the mod is designed for. However, CC will work perfectly alongside a mod that doesn't even send player map pin data to the client in the first place. Just treat all players as being more than 128 blocks away from the player at all times. That's all a server-side mod needs to do.

Nashty, Mar 18th at 2:40 PM

Any chance you can look into compatability with Wildcraft berry bushes?

I am asking gabb about it also.

Maimessu, Mar 15th at 4:22 AM

Hey there! I love the mod, but I have noticed a pretty big compatibility issue!

Our server uses a different mod that allows people to turn off their nameplates and map-pins to remain hidden from other players, however Campaign Cartographer will overwrite these settings. Users of CC are able to see other people's map-pins even when other people have them disabled. This means that people attempting to remain hidden by disabling their map-pin are still able to be seen by people using CC.

Is there any way to prevent this? Perhaps by making map-pin customization require the mod to be installed on the server?

Or maybe such a nameplate and map-pin disabling feature can be rolled into CC?

There's no way to blacklist mods right now on servers as far as I know, so it is a bit of a problem that people can use CC as a client-side only mod on our server to essentially 'cheat'.

Ikirou, Mar 10th at 9:11 PM

Singleplayer crash still happens on new Worlds with new Version.

Shion, Mar 9th at 2:54 AM

How does the .wps work actually? When I use it on a Copper Ore block (malachite in limestone) it still gives a default marker.

Apache, Mar 6th at 2:30 PM

Falco, this issue seems to have been fixed within 2.1.0 Stable release. I've tested it on the Official Test Server, and was able to mark surface deposits, berry bushes, traders, and resin, in the time I had before the Storm rolled in.

Falco, Feb 28th at 8:26 PM

auto waypoints seem to have broken with 1.16.4

opening the .wpauto options always shows all options disabled on joining a dedicated server, and when turned on, it doesn't actually generate any waypoints.

Aledark, Jan 24th at 9:15 PM

Essential for anyone playing on a MP server, small group of players or even solo for many of the functions. Customizable to your desires :) Waypoint extensions was awesome and this is even better :) 5 Stars ☆☆☆☆☆

DArkHekRoMaNT, Jul 25th 2021 at 2:13 PM

Can't open the settings dialog

Fulgen, Jul 19th 2021 at 6:19 AM

From the 1.15 changelog:

> Notice: In AssetLocation, the domain and path should always be lowercase; the core game engine automatically sets them to lowercase if creating an AssetLocation from a filename on disk, or from a domain:path element in a JSON file 

The game's naming conventions are to use lowercase, and it will only load that.

DArkHekRoMaNT, Jul 9th 2021 at 1:03 AM

On Linux, the names in the mod do not work correctly. Most likely the problem is in the case-sensetive and the game does not see the lang files, because Assets instead of assets, Lang instead of lang, etc.

DArkHekRoMaNT, Jun 18th 2021 at 12:52 AM

You can use api.World.SavegameIdentifier to uniquely identify the worlds

Aledark, Jun 17th 2021 at 4:10 PM

I love it Apache especially the autowaypoint feature and the recenter map function(which should be in vanilla for sure) plus the center over a plr is awesome too :)

I was wondering if it was possible in a way that the autowaypoint lets me rename(keeping the coords) in title like TL to Wiggle without readding an other waypoint on top when i retake it. Certain TLs i modify the icon with a star and change the color and rename them like TL back home or TL to soandso and i keep the coords in parathesis.

Strex, Jun 12th 2021 at 1:08 PM

Can you add "auto waypoint" option?

Explanation:

When you hover your mouse on specific block (like surface deposit,clay,peat,terrapreta,etc) you press a key and it automaticly makes a specific type of waypoint to this block.

 

Craluminum, Feb 16th 2021 at 2:26 PM

I recommend you to add peat, olivine, mushroomresin natively (to the current default list ofc)

delete edit