ericyoondotcom / MinecraftManhunt

Minecraft Bukkit plugin to run Manhunt minigames, with Discord music integration
GNU General Public License v3.0
27 stars 7 forks source link

Mention that the compass automatically updates in the docs #67

Open cssbz opened 3 years ago

cssbz commented 3 years ago

Description

In your documentation at https://dev.bukkit.org/projects/dream-style-manhunt, I don't see any mention of a feature that you do actually have: live compass updating. I think it's an important thing to mention there... more context to explain follows...

I'm helping to choose a compass plugin to use on a server I play on. There are many, many options! After some experimentation and reading, I noticed that many plugins require the hunters to right click their compass to update the location it points to. In those plugins, although the compass remembers which player it is tracking, it doesn't update the tracked location of that player until you right click. So, superficially, the compass looks like it is "working", because when you turn, it turns in response - but it isn't tracking the right location. I think this would cause much confusion on our server - many of our players are quite young.

I looked through your code, saw probable implementation https://github.com/yummypasta/MinecraftManhunt/blob/06f9b3ae5f65b7f58a577fbb0f38bd899b68a7b8/MinecraftManhunt/src/main/java/com/yoonicode/minecraftmanhunt/PluginCommands.java#L308, and we've found in testing that it works.

So - the plugin is great! But I very nearly skipped over it when considering the options, because I didn't see this feature (important to us) mentioned in the docs. Seems a good thing to mention, to differentiate this plugin from others.

ericyoondotcom commented 3 years ago

Hello! Glad you enjoyed the plugin. Some other people were actually asking for a feature where you have to click the compass to reset tracking every time (to be more "authentic" to the videos), so I'm considering making this configurable and documenting that as an additional so users can choose whichever suits their needs.