ServerMinimap
This plugin is not in active development anymore. I might update it for a new Minecraft version from time to time, but don't expect feature updates. The source code is available on GitHub, though. ;)
ServerMinimap
This plugin allows you to provide a minimap to your users, without any client mod by using the vanilla maps.
You can configure the scale, updatetime and colors at which blocks are rendered. There is also a option to show other players on the minimap.
It also features a simple waypoint system and custom events to display own cursors on the map. (E.g. for more advanced waypoint systems)
The plugin is based on a idea from toxictroop and the team at: http://www.crossfiregaming.net. Request Thread
This plugin will break with every Minecraft update. It currently supports 1.5.2 to 1.10
Beta Notice
This plugin is in beta state. If you find bugs, please report them.
Also, this plugin can use big amounts of CPU, Bandwidth and RAM, depending on your settings.
Usage
Installing is, as every Bukkit plugin, just downloading and moving into the plugins folder.
After the first run, the plugin should create a default config with default values.
When you start up the server, it'll tell you which mapID the plugin uses together with a command to obtain the map a OP.
Configuration
scale
Defines the scale of the map. 1 map pixel is scale*scale blocks. Biggers scales need more CPU to render the map in the first run, while using less RAM to cache the values.
runPerTicks
After how much ticks (1/20 sec) the plugin should calculate the current renderer queue. Higher values give the server more time to recover from lag, lower values allow the server to distribute the load more evenly. (I recommend lower values)
chunksPerRun
This value determins who much 16x16 pixelblocks (map chunks) and block changes are rendered per run. Higher values will speed up the rendering of new areas, while using more CPU resources in a shorter timespan (if there is enough to render). Every map chunk is only rendered once after a server start. Make sure this value is not too low, otherwise the renderer may be slower than the queue is filled.
fastTicks
This value allows you to set the time in ticks (1/20 sec) after which users with the permission "minimap.fastupdate" get a complete update of the map. The additional bandwidth usage of every complete send is about 16KiB per Update, per player.
canSeeOthers
When activated, every player can see other player's on their minimap. This may be changed when plugins modify the MinimapPlayerCursorEvent.
mapID
This is the id of the map, the plugin uses. It will be shown every server startup in log. It is no recommended to change this id unless you know that a map with the new id already exists.
showDistantWaypoints
Sets whether waypoints, that are out of range, shall be displayed on the cornor of the map.
mysql
Under this section you need to put all needed information to connect to your MySQL server and if you want to use it. The host, port, username, password and the target database are needed.
worlds
This section allows you to set several things per world. It follows the format: <worldname>: <key>: <value>
possible keys are: enabled
Allows you to disable the map renderer in certain worlds. The renderer is enabled by default.
scale
Same as above but overrides the default value.
drawHeight
Allows you to set the upper border of the rendering algorythm. (Default the worlds max height - 255)
Use this for things like cave mapping. (e.g. Nether)
Default Configuration
scale: 1 chunksPerRun: 4 runPerTicks: 5 fastTicks: 20 canSeeOthers: true showDistantWaypoints: false mysql: enabled: false host: localhost port: 3306 user: user pass: password database: database worlds: world_nether: enabled: true drawHeight: 75 scale: 2
Commands
Permissions for the commands can be found below
/minimap - gives you the minimap item
/waypoint help [command] - gives you information about this command
/waypoint add [x] [z] - adds a waypoint either on your current location, or to the specified x and z coordinates.
/waypoint list - lists all your waypoints together with their index
/waypoint remove <index> - removes the waypoint with the index <index>. Note: indcies change, when removing waypoints.
/waypoint hide <index> [true|false] - either toggles visibility of a waypoint, or sets it to the given boolean.
Permissions
minimap.fastupdate
Makes a full update of the player's minimap every defined amount of ticks. Uses big amounts of Bandwidth. Player's without this node may need to stand still for about 5 seconds to have a clear map.
minimap.command.minimap
Allows you to use the /minimap command.
minimap.command.waypoint.help
Allows you to use the /waypoint help command
minimap.command.waypoint.list
Allows you to use the /waypoint list command
minimap.command.waypoint.add
Allows you to use the /waypoint add command
minimap.command.waypoint.remove
Allows you to use the /waypoint remove command
minimap.command.waypoint.hide
Allows you to use the /waypoint hidecommand
Metrics
This plugin utilises Hidendra's plugin metrics system. You can opt-out under <yourPluginFolder>/PluginMetrics/config.yml
The following informations will be collected:
- A unique identifier
- The server's version of Java
- Whether the server is in offline or online mode
- The plugin's version
- The server's implementation and game version
- The OS version/name and architecture
- The core count for the CPU
- The number of players online
- The Metrics version
- Your online-mode
- Your server location
- Your config values for scale, runPerTicks, fastTicks, and chunksPerRun
@J0schlZ
Sorry, this is my bad. Something went wrong when compiling the plugin causing the 1.8 code not to be included. I just uploaded a fixed version that should be approved soon.
Hey.. i really like the Idea of this Plugin but it doesn't seems to be work on my server. http://pastebin.com/PLjQ2VP8 Is this because of PerWorldPlugins?
nice, update!
@SydMontague
Sorry, I should have been more specific. The world specific value doesn't change anything, the scale will always be that of the main scale value even when the world specific value is changed.
@todicus
Either the global scale value or the scale value of the world, when you use world specific settings.
What values can you use to increase the specific world scale, everything seems to keep it at 1 block to 1 pixel
@SydMontague
Thanks for fixing it so promptly; it works fantastically now.
@todicus
Are you using 1.7.10? If yes, I found the bug and will upload a fixed version now.
@SydMontague
I am trying to create a minimap for a world that is not the overworld, created using multiverse.
@todicus
The plugin always creates the map in the first world, which is usually the overworld. This setting always worked for me in test enviroments as well as in productive enviroments.
Is there some special condition, that could cause this error?
The plugin seems to generate the map files in the wrong world, even when a specific world name is specified in the config. As a result the maps appear blank when held. Is this a known issue or is there a problem with my server?
The bukkit staffs are back and many plugins are getting update approved. You can always link the fix in comment here. :)
@madtomic
I'll look into it, however, releasing builds is currently very hard, as the BukkitDev staff seems to stoped working as well.
@SydMontague
Thank you for continue of this plugin. I was wondering if a custom name can be added to the waypoint? via /waypoint add <name>
Thanks
@tobysmurf
There is, but I'm not ready to open it to public, yet. If you just want the new version, you can use this link. However, as with Jenkins Servers, this build has not been approved/checked by the Bukkit Dev staff.
Is there a jenkins style build server up where we can download the latest build from? Thank you for this addon, I can't imagine living without it!
@madtomic
Thank you for the reminder, I totally forgot about that... I just uploaded a compatible build, but it might take a few days until it is approved.
However, as you ask for 1.7.9-R0.2: This should be supported with 0.7.3. The last change that required me to update this plugin was, when they updated to 1.7.10.
please update to cb1.7.9-r0.2
@Moni32
Change the value while the server is shut off. Using /reload is generally a bad idea as it can cause memory leaks and other bugs.
Is the fasttick setting the one you are talking about? Every time i changed that and reload the plugin it just changed it right back.