Rivoreo Source Code Repositories
src.rivoreo.one / glowstone / 8f911c2d791db62171c20a7a84e987b6499377ed
commit8f911c2d791db62171c20a7a84e987b6499377ed[log] [download]
authormastercoms <circuitsoft@openmailbox.org>Mon Jun 22 12:58:05 2015 -0400
committermastercoms <circuitsoft@openmailbox.org>Mon Jun 22 12:58:05 2015 -0400
tree0f0fd68dc667312a3538f15e06b919a9ba026649
parentedad640f2f362de29054bbfa77fdbaafe4b5753b [diff]
Fix a typo, getWeigth -> getWeight
1 file changed
tree: 0f0fd68dc667312a3538f15e06b919a9ba026649
  1. .gitattributes
  2. .gitignore
  3. .gitmodules
  4. .travis.yml
  5. CONTRIBUTING.md
  6. Glowkit
  7. LICENSE
  8. README.md
  9. circle.yml
  10. deprecation-mappings.at
  11. deprecation-mappings.csrg
  12. etc/
  13. mixins.txt
  14. pom.xml
  15. setup.sh
  16. src/
README.md

#Glowstone++

The enhanced Glowstone fork with an emphasis on performance, control and compatibility.

Build Status

Join the chat at https://gitter.im/GlowstonePlusPlus/GlowstonePlusPlus

(Warning: may be unstable, this is only an experiment, use at your own risk)

Currently the major changes from Glowstone include:

##Building

###1. Setup After installing Oracle JDK or OpenJDK, and Maven, checkout the source:

git clone --recursive https://github.com/GlowstonePlusPlus/GlowstonePlusPlus
cd GlowstonePlusPlus

###2. Build

setup.sh

The final jar will be placed in target/ named glowstone++-1.8.7-SNAPSHOT.jar.

##Downloads

If you don't want to build from source, prebuilt jar files are available to download from:

  • CircleCI downloads - click the latest build then expand “Artifacts” (if it does not show, try logging in with GitHub) Build Status

##Running

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. A variety of command-line options are also available - run java -jar glowstone++.jar --help for more information.

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.

##Introduction

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.

##Features

Glowstone has a few key advantages over CraftBukkit:

  • It is 100% open source. While CraftBukkit and most other mods are open source, they rely on decompiled Minecraft source code. Glowstone's code is completely original.
  • Because of this, it is easy to contribute to Glowstone's development. The barrier of entry to contributions is lower because there is no need to work around decompiled source or maintain a minimal diff.
  • Glowstone supports all plugins written for the Bukkit API natively. In practice, some plugins may try to make use of parts of the API which are not yet implemented, but in a completed state Glowstone would support all plugins.
  • Glowstone's simplicity affords it a performance improvement over CraftBukkit and other servers, making it especially suited for situations where a large amount of players must be supported but Vanilla game features are not needed.

However, there are several drawbacks:

  • Glowstone is not finished. Nothing is guaranteed to work, though many things are likely to. If in doubt, file an issue.
  • Vanilla survival features are entirely absent (mobs, hunger, health, so on). Glowstone cannot yet replicate a vanilla survival environment. These will be added over time.
  • Bukkit plugins which expect the presence of CraftBukkit-specific code (that in the org.bukkit.craftbukkit or net.minecraft.server packages) will not work on Glowstone unless they are designed to fail gracefully.
  • Glowstone is not produced by the Bukkit team, and while we do make an effort to produce quality work, Glowstone does not undergo the same rigorious testing as the Bukkit project.

Some of the key features that have been implemented are:

  • World loading, saving, and streaming to players.
  • Player interaction with the world (building, digging).
  • Somewhat-complete inventory support.
  • World weather (rain, thunder/lightning).
  • Op, ban, IP ban, and whitelist support.
  • Many of the advanced API features of Bukkit.
  • Sophisticated overworld generation (support for others through Bukkit).
  • Structure spawning and saving.
  • Biome grid generation and decoration.
  • Crop growth, bone meal, and flower pots.
  • Noteblocks and jukeboxes.
  • Double chests and item frames.
  • Enchantments, beds, cauldrons.
  • Liquid physics (water and lava).
  • Particle effects Spigot API.

##Docs and Support

The best place to receive support is on GitHub issues. When reporting bugs, please retest and include whether the problem reproduces on:

Javadocs can be generated by using the mvn javadoc:javadoc command and are placed in the target/site/apidocs/ directory, but these are incomplete -in some places and in general the code is the best reference.

For documentation on the Glowkit API (an updated Bukkit which is used to write plugins), see the Glowkit Javadocs or visit Spigot's Bukkit Javadocs.

##Credits

##Copyright

Glowstone is open-source software released under the MIT license. Please see the LICENSE file for details.

Glowkit is open-source software released under the GPL license. Please see the LICENSE.txt file in the Glowkit repository for details.