Upstream/dynmap
1
0
Fork 0
mirror of https://github.com/webbukkit/dynmap.git synced 2024-11-28 05:05:16 +01:00
Code Issues Projects Releases Wiki Activity

Link to compile-page.

FrozenCow 2012-01-23 06:22:04 -08:00
parent 805145e253
commit 93965db346
1 changed files with 15 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Home.md

@ -11,22 +11,7 @@ A somewhat modified version of the original Dynmap for hMod is still available i
* [BukkitDev project page](http://dev.bukkit.org/server-mods/dynmap/)
* IRC: irc://irc.esper.net/#dynmap ([via web](http://webchat.esper.net/?nick=Webuser&channels=dynmap&prompt=0))
# Compiling #
Use maven to compile the code, just like Bukkit/CraftBukkit. For this, first 'install' Bukkit with maven (`mvn install` inside the Bukkit repo).
The dynmap project consists of multiple components that have been divided to allow for support of multiple server platforms, as well as allowing our 'published API' to be more clearly expressed. The components needed to build 'dynmap' (the Dynmap plugin for Bukkit) are the following (in the order they need to be built):
* [DynmapCoreAPI](https://github.com/webbukkit/DynmapCoreAPI) - this is the platform neutral API for Dynmap: plugin writers can use this to interface with Dynmap on any platform (by casting the Plugin instance for the dynmap plugin to 'org.dynmap.DynmapCoreAPI').
* [DynmapCore](https://github.com/webbukkit/DynmapCore) - this is the server-neutral core of Dynmap: nearly all the web and rendering logic for Dynmap is here (as much of it as we can put in). The build results here are not runnable - they're input to the 'dynmap' component build and others (e.g. 'DynmapSpout', which is for the Spout server).
* [dynmap-api](https://github.com/webbukkit/dynmap-api) - this is the Bukkit-specific API library for Dynmap - it defines the org.dynmap.DynmapAPI interface, which includes Bukkit-specific calls. As with the DynmapCoreAPI (which DynmapAPI extends), take the Plugin instance for 'dynmap' and cast it to org.dynmap.DynmapAPI to access the published interfaces.
* [dynmap](https://github.com/webbukkit/dynmap) - this component builds the actual dynmap-for-Bukkit deliverable, and only includes code which cannot be made server-neutral.
Each of the dependencies can be built using `mvn install`, and then 'dynmap' itself can be built using `mvn install` or `mvn package`.
# Setup #
# For users #
* [[Setting up without the Internal Web Server]]
* [[Setting up the Dynamic Map plugin under Linux]]
@ -41,3 +26,16 @@ Each of the dependencies can be built using `mvn install`, and then 'dynmap' its
* [[Web UI Parameters]]
* [[Using Markers]]
* [[Advanced Block Definitions]]
# For developers #
The dynmap project consists of multiple components that have been divided to allow for support of multiple server platforms, as well as allowing our 'published API' to be more clearly expressed. The components needed to build 'dynmap' (the Dynmap plugin for Bukkit) are the following (in the order they need to be built):
* [DynmapCoreAPI](https://github.com/webbukkit/DynmapCoreAPI) - this is the platform neutral API for Dynmap: plugin writers can use this to interface with Dynmap on any platform (by casting the Plugin instance for the dynmap plugin to 'org.dynmap.DynmapCoreAPI').
* [DynmapCore](https://github.com/webbukkit/DynmapCore) - this is the server-neutral core of Dynmap: nearly all the web and rendering logic for Dynmap is here (as much of it as we can put in). The build results here are not runnable - they're input to the 'dynmap' component build and others (e.g. 'DynmapSpout', which is for the Spout server).
* [dynmap-api](https://github.com/webbukkit/dynmap-api) - this is the Bukkit-specific API library for Dynmap - it defines the org.dynmap.DynmapAPI interface, which includes Bukkit-specific calls. As with the DynmapCoreAPI (which DynmapAPI extends), take the Plugin instance for 'dynmap' and cast it to org.dynmap.DynmapAPI to access the published interfaces.
* [dynmap](https://github.com/webbukkit/dynmap) - this component builds the actual dynmap-for-Bukkit deliverable, and only includes code which cannot be made server-neutral.
[[How to compile Dynmap]]