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.
gradle will build Glowstone and will put the compiled JAR in
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.bat scripts instead of
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
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
index.html in a web browser.
For documentation on the Bukkit API, see the Bukkit Javadocs.
- The Minecraft Coalition - protocol and file formats research.
- Trustin Lee - author of the Netty library.
- Graham Edgecombe - author of the original Lightstone - and everyone else who has contributed to Lightstone.
- All the people behind Gradle and Java.
- The Bukkit team for their outstandingly well-designed plugin API.
- Notch and all the other people at Mojang - for making such an awesome game in the first place!
Glowstone is open-source software released under the MIT license. Please see
LICENSE file for details.