Mods / Projectile Tracker
Author: MrFastZombie
Side: Both
Created: Mar 22nd 2024 at 6:53 AM
Last modified: 2 days ago
Downloads: 941
Follow Unfollow 28
Latest file for v1.20.0:
projectiletracker_1.0.1.zip
1-click install
My first mod for VS!
Projectile Tracker automatically creates waypoints when your fired projectiles land and deletes them when they are either picked up or despawned. Note that this mod is required serverside when playing multiplayer.
Important for 1.20 Players: My mod is temporarily incompatible with Combat Overhaul. I believe I know how I can add compatibility but it will take longer than I had initially expected. My mod also appears to be incompatible with Autoconfig lib 2.0.2 due to a bug on PT's end. I am currently ill but I will try to fix that and add compat w/ CO when I recover.
Server operators: If my mod crashes your server upon startup, copy a clientside config (Servers use the same file) to your server's config folder. This will be fixed in the next update.
How It Works
When a projectile is spawned the server will detect when the projectile impacts and it will create the waypoint and send it to the player that fired the projectile. Upon despawn or pickup the waypoint will be removed if the player is online, or saved to a list if not and processed the next time the player comes online.
Commands
/ptpurge -- Removes all of your PT waypoints. More specifically, it removes any waypoints that start with "Projectile ". So keep that in mind if you have any other waypoints named like that for some reason.
/ptclearorphans -- Removes any PT waypoints that no longer have an associated entity, in case any don't get removed automatically.
/ptremovepending -- Can only be called by those with ban permissions. This command removes a player from the pending waypoint update list (which is used to update waypoints for players that were offline) when supplied a playerUID, or clears the list if the input is just "all". Examples: /ptremovepending all, /ptremovepending BxGR+8W4FOoB+arlMpjRxNq+
Config
"EnableProjectileTracker": true,
-- Enables or (soft) disables the mod. When the mod is disabled this way, new waypoints will not be made for the player but old ones will still be removed as normal."allowWelcomeMessage": true,
-- When joining a server, a welcome message will alert the user of waypoints that have been deleted since their last join. This setting controls if that is displayed."icon": "ptarrow",
-- The waypoint icon. Accepts any icon name from the Waypoint icon list. By default, uses an icon () included with the mod. If you'd like an icon that is more precise, you can use "x" or "star1" instead. Invalid values will make it default to the circle icon."color": "#f9d0dc",
-- The HEX code for the color of the waypoint. You should be able to get it from an online color picker. Do not forget the #."InjectModdedProjectiles": true,
-- If true: modded projectiles will be tracked. "projectileBlacklist": []
-- An array of item names that will not be tracked. On the serverside, this will disable those projectiles for everyone but on the client side it will prevent waypoints being made for that client. Projectile names that are being tracked are listed in the server-debug log, and you can find them by searching "Injecting entity". Example: ["arrow-crude", "bullet-lead"]
QnA
- Why serverside? By going serverside, Projectile Tracker can update your waypoints if you are not near them or even if you are offline from a server using the mod. Waypoints are also made manually on the server rather than by making the client use the waypoint command, so your chat log doesn't get spammed when you are using projectiles.
- Where can I report bugs? In order of preference, you can report bugs on the GitHub issues page, or in the comments here. I'll try to keep track of them but I may be slower to notice comments.
- What happens if someone else picks up my projectiles? When someone picks up your projectiles the waypoints will still be removed for you.
- Can I edit PT waypoints? As long as you do not change the name of the waypoints PT will be able to access them as normal. You can also remove them manually without any issues.
- What languages does this support? As of right now, only English. There's not much to translate for this mod, but I do have it prepared for translation and I will accept translations.
- Does this work on version x.xx.x? As of the intial release, I have tested the mod only on 1.19.4 and 1.19.5. It may work on older versions but you would have to try it to see. I do not expect this to break often with future updates.
Known issues
- If a projectile leaves your simulation distance, it will not create a waypoint until it is loaded again and lands.
- If a projectile in-flight in an unloaded chunk lands after the server or save has been reloaded, it will not create a waypoint.
- Incompatible with Combat Overhaul. I will add compat from my end. See https://github.com/MrFastZombie/ProjectileTracker/issues/3 if you want details.
Compatibility
This mod should not cause issues with most mods. Any mods that have their projectiles use the type "EntityProjectile" or "AdvancedEntityProjectile" (from FSMlib) should be tracked. If you've found a mod that does not work, let me know and I may try to make it work.
Current (temporary) incompatibilites: Combat Overhaul, Autoconfig Lib
See Also
Version | For Game version | Downloads | Release date | Changelog | Download | 1-click mod install* |
---|---|---|---|---|---|---|
v1.0.1 | 155 | 2 days ago | Show | projectiletracker_1.0.1.zip | Install now | |
v1.0.0 | 786 | Mar 22nd 2024 at 11:04 PM | Show | projectiletracker_1.0.0.zip | Install now |
i don't use autoconfig lib, no. from my theory it looks like this was caused by the "assembly already loaded" issue which can be fixed with a full game restart- i think it happens when i had the previous version enabled at any point and disable it later in favour of another version. i had this with another mod recently, as well. mod is working ^^
tauceti2114 Do you happen to use Autoconfig lib? I think it is causing my config to fail to load. I know that doesn't necessarily explain why 1.0.0 works, but both versions appear to work for me but it breaks with that mod. EDIT: If you can share me your logs (client-main.log, client-debug.log, server-main.log, server-debug.log in %appdata%\VintageStoryData\Logs if you are not using VS launcher and are on Windows. Pasting that directory into your explorer's path bar should take you there regardless of where your appdata is.) It might help me figure out what caused this issue. If you do choose to share those, please use something like github gists, pastebin, or just hosting them on a cloud service so the comments don't get filled here.
I suppose 1.20.1 broke it in some way, but it is very odd that it only broke 1.0.1 of my mod since it was only a version bump. Thanks for letting me know, I'll try to update it soon.
for some reason 1.0.1 doesn't seem to be working for me (no waypoints or commands, "no such command exists") on 1.20.x but i might keep testing it out. 1.0.0 works just fine
For any server players: If you get the welcome message upon joining a server that says you've had some waypoints removed since you were last logged in for projectiles that have likely despawned rather than been picked up, let me know so I know the notification system is working in that case. I still need to figure out a better way to test this feature.
This is a great QoL idea. Thank you for implementing it. Also, a mega thank you for such nice documentation, as well. It's rare to see people spend time documenting their mods, but it's very much appreciated.
Great idea, it reminds me of people writing down notes in The Long Dark to go find arrows they lose when trying to hunt.