| commit | 06c64d5aa0970e13c4e37d4faed306e78e6511a5 | [log] [download] |
|---|---|---|
| author | Steven Downer <grinch@outlook.com> | Thu Jan 09 21:08:24 2014 -0600 |
| committer | Tad Hardesty <tad@platymuus.com> | Sun Jan 12 19:01:51 2014 -0600 |
| tree | ccfff1395350032a0e332106903fa09964ca9775 | |
| parent | 60a165187aa940f7a2395d5509fd14c10bb92575 [diff] |
Update README.md for Gradle Signed-off-by: Steven Downer <grinch@outlook.com>
Glowstone is an open-source implementation of the Minecraft server software written in Java, originally forked from Graham Edgecombe's now-defunct Lightstone project.
The official server software has some shortcomings such as the use of threaded, synchronous I/O along with high CPU and RAM usage. Glowstone aims to be a lightweight and high-performance alternative.
Glowstone's main aim as a project independent from Lightstone is to offer a higher-performance server while maintaining compatability with the multitude of plugins available for the popular Bukkit server plugin development interface. It does this through implementing Bukkit classes and loading Bukkit plugins which interface with these classes.
Glowstone can be built with the Java Development Kit and Gradle. Gradle is also used for dependency management.
The command gradle will build Glowstone and will put the compiled JAR in ~/build/distributions, and gradle install will copy it to your local Maven repository. Additionally, if you prefer not to install Gradle you can simply use the provided gradlew and gradlew.bat files in place of gradle for commands.
Running Glowstone is simple because all dependencies, including Bukkit, are shaded into the output jar at compile time thanks to a nifty Gradle plugin. Simply execute java -jar glowstone-0.0.1-SNAPSHOT.jar along with whatever memory-related options to Java you desire, and the server should start.
By default, configuration is stored in the config/ subdirectory and logs are stored in the logs/ subdirectory. The main configuration file is config/glowstone.yml, which replaces CraftBukkit‘s server.properties and bukkit.yml. Settings from these two files will be copied over to Glowstone’s configuration during the default configuration generation process.
Glowstone uses a JLine-based server console for command input. On non-Windows systems, console output can also be colored.
Javadocs can be generated by using the gradle javadoc command in the terminal. To view the javadocs simply go to ~/build/docs/javadoc/ and open index.html in a web browser.
For documentation on the Bukkit API, see the Bukkit Javadocs.
Glowstone is open-source software released under the MIT license. Please see the LICENSE file for details.