| commit | 561b0be1133f13fc1a8c56bd0c1879c98cf57b29 | [log] [download] |
|---|---|---|
| author | Tad Hardesty <tad@platymuus.com> | Mon Feb 17 17:06:01 2014 -0600 |
| committer | Tad Hardesty <tad@platymuus.com> | Mon Feb 17 18:08:57 2014 -0600 |
| tree | e1df5474175d665122dc88f678cc06a6cd4eb95e | |
| parent | a8fbcc96f4d9163ee62da9fe9cc7564fd61319b5 [diff] |
Updated readme, license, and logo and removed outdated documentation. Closes #85.
Glowstone is a lightweight, from scratch, open source Minecraft server written in Java that supports plugins written for the Bukkit API.
The main goals of the project are to provide a lightweight implementation of the Bukkit API and Minecraft server where exact vanilla functionality is not needed or higher performance is desired than the official software can deliver. Glowstone makes use of a thread-per-world model and performs synchronization only when necessitated by the Bukkit API.
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 or gradlew.bat scripts instead of gradle.
Running Glowstone is simple because its dependencies are shaded into the output jar at compile time. Simply execute java -jar glowstone.jar along with any extra JVM options desired.
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 JLine for console input and colored console output. The JLine console can be disabled in the configuration if a flat console is desired.
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.
