CompassEx
CompassEx 3
Your compass, but heavily improved.
This plugin allows you to easily set your compass to different positions. You can set it to coordinates, players and of course, back to spawn.
Features
- Set your compass to players, coordinates and your current position
- Save your location or current compass target for later use
- Make saved locations private or public
- Automatic updates to player positions
- Set yourself as hidden, so that you cant be tracked by others
- Admins can follow even hidden users
- Economy support with Vault for
save,private, andpubliccommands - Dynmap support
- Multiworld support
Commands
The original CompassEx command /compassex has also aliases: /cp and /compass.
Warning: Since CompassEx 3.0.2 only the /compassex command will always be available,
/compass may be used by another plugin!. See Bukkit aliases
for more information about how to set /compass to /compassex for conflicts.
Basics
Basic commands to set your compass target.
| Command | Alias | Description |
|---|---|---|
/compass help |
Shows the help page with all commands. | |
/compass reset |
/compass spawn |
Sets the compass back to spawn. |
/compass here |
Sets the compass to the player's current position. | |
/compass bed |
/compass |
Sets the compass to your bed. |
/compass north/east/south/west |
/compass n/e/s/w |
Sets the compass to a specific direction. |
/compass X Y Z |
/compass pos X Y Z |
Sets the compass to the given coordinates. |
/compass deathpoint |
/compass dp |
Sets the compass to the player's latest deathpoint. |
/compass PLAYER |
/compass player PLAYER |
Sets the compass to the given player. |
/compass live PLAYER |
Sets the compass to the player and updates it. |
Saving and Loading
CompassEx allows you to save locations by IDs which can be later loaded.
Since CompassEx 3 these are seperated per player, so that multiple players can have locations saved
with the same name without conflicts. Public locations are also possible.
However, these will be "shadowed" by private locations, for example if there's a public
location named home and a player has one home too, then when loading, the private location of the
player will be used.
To create public locations, first create a private one and then publicize it.
| Command | Alias | Description |
|---|---|---|
/compass save ID |
Save your current compass target to a private location. | |
/compass save here ID |
Save your current location. | |
/compass load ID |
Set your compass to a previously saved location. It will first try to find a private location and then a public location. | |
/compass rename ID NEWID |
Rename a private compass target. | |
/compass rename public ID NEWID |
Rename a public compass target. | |
/compass rename OWNER ID NEWID |
/compass rename private OWNER ID NEWID | Rename a private compass target. |
/compass remove ID |
Remove a private compass target. | |
/compass remove public ID |
Remove a public compass target. | |
/compass remove OWNER ID |
/compass remove private OWNER ID | Remove a private compass target. |
/compass list public PAGE-NUMBER |
List public compass targets. | |
/compass list PAGE-NUMBER |
/compass list private PAGE-NUMBER |
List private compass targets (all if you have the compassex.list.private.any permission). |
/compass nearest |
/compass near |
Show the three nearest private compass targets. |
/compass nearest public |
/compass near public |
Show the three nearest public compass targets. |
/compass publicize ID |
/compass public ID |
Convert a private compass target to a public compass target. |
/compass publicize OWNER ID |
/compass public OWNER ID |
Convert a private compass target to a public compass target. |
/compass privatize ID |
/compass private ID |
Convert a public compass target back to a private compass target. |
Hiding
Hiding allows you to hide yourself from being tracked by other players through the /compass player
and the /compass live commands if they're not admins.
| Command | Alias | Description |
|---|---|---|
/compass hide |
Toggles the player's visibility. | |
/compass hide on |
/compass hon |
Specifically hides the player. |
/compass hide off |
/compass hoff |
Specifically sets the player trackable. |
/compass hidden |
Show if the player is hidden right now. |
Info Commands
These commands show some information about your current compass target or a saved location if an ID is given.
An ID may be just an ID (your own private location), public followed by the ID (a public location) or a
player name and the ID (a private location of someone).
| Command | Alias | Description |
|---|---|---|
/compass info [ID] |
Show the coordinates of the location. | |
/compass distance [ID] |
/compass d [ID] |
Show the distance in blocks to the location. |
/compass height [ID] |
/compass h [ID] |
Show the height difference between you and the location. |
Installation
Just copy the jar file into your plugins folder, start your server so that the config gets generated and stop it. Then edit the config file at will. Now start your server again.
Permissions
Heads up! The rename commands use the respective compassex.remove, compassex.save and
compassex.publicize (if the location is public) permissions.
Extra: If you want to have players automatically hidden when they join, give
them the compassex.autohide permission.
| Permission node | Description |
|---|---|
compassex.help |
Allow users to display the help. |
compassex.reset |
Access to /compass spawn. |
compassex.here |
Access to /compass here. |
compassex.direction |
Access to /compass north/east/south/west. |
compassex.bed |
Access to /compass bed. |
compassex.live |
Access to /compass live. |
compassex.distance |
Access to /compass distance. |
compassex.height |
Access to /compass height. |
compassex.hide |
Access to /compass hide. |
compassex.deathpoint |
Access to /compass deathpoint. |
compassex.pos |
Access to /compass pos. |
compassex.player |
Access to /compass player. |
compassex.admin |
Allows to track even hidden users. |
compassex.save |
Allows access to the save command. |
compassex.save.free |
Users with this permission won't have to pay for saving a target. |
compassex.load.public |
Allows to access public locations via the load command or the info commands listed above. |
compassex.load.private |
Allows to access own private locations via the load command or the info commands listed above. |
compassex.load.private.any |
Allows to access any private locations via the load command or the info commands listed above. |
compassex.remove.private |
Allows you to remove your own private compass targets. |
compassex.remove.private.any |
Allows you to remove any private compass target. |
compassex.remove.public |
Allows you to remove your own public compass targets. |
compassex.remove.public.any |
Allows you to remove any public compass targets. |
compassex.list.public |
Allows you to list public compass targets. |
compassex.list.private |
Allows you to list private compass targets. |
compassex.list.private.any |
Allows you to list all private locations. |
compassex.nearest.private |
Access to /compass nearest. |
compassex.nearest.public |
Access to /compass nearest public. |
compassex.info |
Allows access to get info about public, and owned private compass targets. |
compassex.info.any |
Allows you to get info about all public and private compass target. |
compassex.privatize |
Allows you to convert owned compass targets to private. |
compassex.privatize.any |
Allows you to convert any compass target to private. |
compassex.privatize.free |
Users with this permission won't have to pay for making a target private. |
compassex.publicize |
Allows you to convert owned compass targets to public. |
compassex.publicize.any |
Allows you to convert any compass target to public. |
compassex.publicize.free |
Users with this permission won't have to pay for making a target public. |
Configuration
The configuration is really simple (you can find it in plugins/CompassEx/config.yml):
live-update-rate: Sets how fast the position of the live tracked player get refreshed. Setting it to a small number may result in poor server performance. Recommended value: 200 (2 seconds).help-page-num-commands: Number of commmands per page of /compassex helpsave-cost: How much a user withoutcompassex.save.freepermission has to pay to save a target.privatize-cost: How much a user withoutcompassex.privatize.freepermission has to pay to privatize a target.publicize-cost: How much a user withoutcompassex.publicize.freepermission has to pay to publicize a target.enable-dynmap: Whether to show public locations in dynmap.dynmap-icon: Set a dynmap icon for CompassEx markers.
More
This plugin uses mcstats.org's Plugin Metrics. That means it sends anonymous statistics to mcstats.org to help me develop the plugin. You can find more about it and how to disable it here.
Do you think you found any bugs? Submit one here.
You think you can help by adding a feature or fixing a bug? Go to the GitHub repository.
<small>Compass image from MinecraftWiki.</small>
Comments
-
Forge_User_17872030 Owner
-
F4HLM4N Tester
-
Forge_User_83064763 Contributor
-
View User Profile
-
Send Message
Posted Aug 15, 2014@JackzMc
agreed i use it with a quest plugin and people get confused
-
View User Profile
-
Send Message
Posted Jun 30, 2014This looks like a nice plugin. Could you make it so toggleable per worlds?
Also, make /compass pos <x> <y> <z> Relative too? (Like ~ 1 , sets the compass to the coords 1 block above your feet. aka eyes)
+ When the argument is wrong, it tells me the format and the period is on a new line, kinda annoying.
-
View User Profile
-
Send Message
Posted Apr 23, 2014CompassEx isn't able to detect Vault!
-
View User Profile
-
Send Message
Posted Mar 3, 2014compassex.direction is actually compassex.directions in case anyone else needs help with that
-
View User Profile
-
Send Message
Posted Jan 14, 2014permissions /compass and /compass pos dont work plz fix
-
View User Profile
-
Send Message
Posted Dec 22, 2013I have a feature request.
Could you add an option to give a compass to a player on death, with the compass target pre-set to their death location? This option could be enabled simply by a player having a permission node, such as compassex.giveondeath or something similar.
I am trying to find a suitable compromise to not allowing /back on death in my survivalworld. My players complain that it is too hard to find their death location to recover their equipment, but I feel having /back on death makes things too easy.
Thanks!
-
View User Profile
-
Send Message
Posted Nov 22, 2013@mw74126
I thought I was having the same problem, then I realized you have to do /compass load public <ID>, not /compass load <public ID>.
-
View User Profile
-
Send Message
Posted Aug 29, 2013This plugin WILL NOT load public locations! I set a public location as "breezeport". I do /compass load breezeport, and it says it can't find a private location by that name. It doesn't seem to be checking for public ones at all!
-
View User Profile
-
Send Message
Posted Aug 17, 2013I just wanted to point out a small informational "mistake" on this page. The permission node, "compassex.pos" has the description, "Access to /compass pos". However, there is no "/compass pos" command listed, but there is a "/compass X Y Z" command listed.
For clarification, it would be helpful to add "/compass pos X Y Z" as an alias to the command, "/compass X Y Z", so that people know this command corresponds with the "compassex.pos" permission node.
-
View User Profile
-
Send Message
Posted Aug 3, 2013Im having troubles letting anyone that is not opped use this plugin. If they are not opped looks like all the can use it the help, reset, and player. commands. I am using permissionbuckkit for permissions
groups:
default:
permissions:
permissions.build false
multiverse.core.list.who true
multiverse.core.spawn.self true
skychest.use true
compassex.help true
compassex.reset true
compassex.here true
compassex.direction true
compassex.bed true
compassex.live true
compassex.deathpoint true
compassex.pos true
compassex.player true
is how i have them set any idea what the issue could be
i have even tried using the same permission set in the user group and no luck.
-
View User Profile
-
Send Message
Posted Jul 25, 2013@Philipp15b
Is it possible to track a player that is "vanished" using one of the many vanish plugins, such as Vanish No Packet? According to Vanish No Packet's documentation you can call isVanished playername and receive a true or false response. If the response was true it would be nice if CompassEx would not track the vanished player.
-
View User Profile
-
Send Message
Posted Jul 25, 2013@MountaindewM
Thanks for making great suggestions. The first suggestion was actually already implemented, but due to a bug the watched and the watcher could be in different worlds. That is now fixed. (It should also send you a notification when the watched player changes the world or quits.)
The `/compass hon` and `/compass hoff` (`/compass hide on` and `/compass hide off` as the long forms) were also added. When you give guests (or all other players, depending how you want it) the permission `compassex.autohide` new players are automatically hidden when they join.
CompassEx 3.1.0 should be available here on BukkitDev soon. Have fun :)
-
View User Profile
-
Send Message
Posted Jul 25, 2013So I really like this plugin but unfortunately for what I want to use it for it won't quite work how I want it to. By that I mean I can see ways to bypass what I want to use the plugin for. So here is my suggestions.
Add a disabled/enabled function to the config so users MUST be in same world. Also have it automatically reset if a person changes to a different world. Since it updates every 2 seconds I imagine it pulls their world and their location to display their location. That is all I can think of for that suggestion.
Now for the last one this would make things TONS better. Have it so you can do /compass hide on and /compass hide off or even /compass hon and /compass hoff or something so the on and off command isn't the same command. This also would be nice as well if you can add it to the config to enable it so when a users joins the game they are automatically /compass hide on so they can't be tracked right away or even so it automatically does it a certain way based on the world they join.
I know I am throwing alot at you but these are just the tweaks I have seen that could make it go from being Good/Great to AWESOME!
-
View User Profile
-
Send Message
Posted Jul 17, 2013@CommodoreAlpha
Hmm, could you send me the deathpoints.db.yml when this error occurs? It seems something with that is wrong.
-
View User Profile
-
Send Message
Posted Jul 17, 2013@Philipp15b
Actually, you might be somewhat disappointed. I'm not sure if this has any consequences, but I (randomly) get this error. I do not believe it's related to the previous error I bugged you about.
-
View User Profile
-
Send Message
Posted Jul 17, 2013@CommodoreAlpha
Good, thanks for the feedback!
@giffordj
This is probably because you don't have an economy plugin installed. You need to install an economy plugin that is compatible with Vault too (unless of course you don't want to use any economy features of CompassEx, then you're good).
-
View User Profile
-
Send Message
Posted Jul 17, 2013Noticed this error in the logs. Any ideas?
2013-07-17 04:13:21 [INFO] [Vault] Loading Vault v1.2.25-b333 2013-07-17 04:13:21 [INFO] [Vault] Enabling Vault v1.2.25-b333 2013-07-17 04:13:21 [INFO] [Vault][Permission] GroupManager found: Waiting 2013-07-17 04:13:21 [INFO] [Vault][Permission] SuperPermissions loaded as backup permission system. 2013-07-17 04:13:21 [INFO] [Vault][Chat] GroupManager found: Waiting 2013-07-17 04:13:21 [INFO] [Vault] Enabled Version 1.2.25-b333 2013-07-17 04:13:21 [INFO] [Vault][Permission] GroupManager hooked. 2013-07-17 04:13:27 [INFO] [Vault][Chat] GroupManager - Chat hooked 2013-07-17 04:14:01 [INFO] [CompassEx] Vault was not found, all actions will be free!
-
View User Profile
-
Send Message
Posted Jul 11, 2013Oh, by the way, sorry for not reporting this earlier, but it appears CompassEx version 3.0.2 has fixed my issue. Thank you very much! :)
-
View User Profile
-
Send Message
Posted Jun 29, 2013@IamChaoz
I'm not sure I understand correctly. What do you mean by the nearest player? Should it search for the currently nearest player and then follow that one all the time OR always point to the currently nearest player at all times? How do you think showing the distance should work? Also, what do you mean by live updating without having to type a command?
Maybe you don't know the
/compassex livecommand: It points your compass to some player and updates it. With/compassex infoor/compassex distanceyou can see how far your target is away from you.-
View User Profile
-
Send Message
Posted Jun 29, 2013Could you add a feature so it tracks the nearest player and shows how far away the player is from him? And maybe a permission that automatically live updates the compass without having to type in a command