Update version based on new schema

We are moving to time-based releases, as a project such as Glowstone will not have a good place to release a new version, since there is a lot to fix and develop. 

The new versioning scheme is `YEAR.release.major.minor`.

Our previous schema didn't have much of a point to the year part of the version besides to set ourselves apart from the Minecraft version to prevent confusion. Now, development cycles will be determined by the year version. Every year, we will release a version of Glowstone labeled as stable in January of that year. That stable release will be worked on in December of the previous year with a complete feature freeze, so only bug fixes and stability improvements may be worked on during that time frame. The stable release will be released as year.0.major.minor, so the release version will always stay at 0. 

Once the stable version has been released, the freeze will be lifted and development will start on version year.1.major.minor, with the release version incrementing on Minecraft major version updates and other huge changes to Glowstone. As for the major version, that will increment every month and will coincide with a release announcement on the blog at the beginning of each month. The minor version will remain the same as the previous schema's trivial version, incrementing on every change (commit or commit series). This requires commits or commit series to have a well defined scope, as defined by the commit message. We can only provide support for the latest development version.

The versioning scheme is slightly different for stable releases. A new branch will be made for every stable release, and while the release version will not change from 0, the major version (backport version) will increment when fixes from master are backported to the stable branch. These will come usually every month. The minor version (hotfix version) will increment when we need to immediately patch a crucial bug that is discovered or one that came about from a backport. We will be supporting these stable releases with fixes and technical assistance for the entire year. (For example, the 2018 stable release, 2018.0.x.y will be supported during 2018 only.)

I hope this new versioning scheme will help us develop features and fixes better for you. If you have any questions, comments or concerns, feel free to comment on this commit or contact me on Discord.
1 file changed
tree: 55b7b4147b2c6606da49a204c2d92d563a62b2e4
  1. .gitattributes
  2. .github/
  3. .gitignore
  4. CODE_OF_CONDUCT.md
  5. LICENSE
  6. README.md
  7. circle.yml
  8. deprecation-mappings.at
  9. deprecation-mappings.csrg
  10. dev.sh
  11. etc/
  12. mixins.txt
  13. pom.xml
  14. setup.sh
  15. src/
  16. start.sh
README.md

Built with Love Join the Discord chat Build Status

Glowstone

A fast, customizable and compatible open source Minecraft server.

Introduction

Glowstone is a lightweight, from scratch, open source Minecraft server written in Java that supports plugins written for the Spigot (and Bukkit) API.

The main goals of the project are to provide a lightweight implementation of the Spigot 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 Spigot 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 and Spigot 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 Bukkit 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.
  • Bukkit plugins which expect the presence of CraftBukkit-specific code (that are 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.

For a current list of features, check the wiki.

Downloads

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

  • Direct gserv.me download - recommended, direct link to latest build

  • gserv.me - all builds, no login required

  • Build Status CircleCI - click the latest build and then open the “Artifacts” tab (you must be logged in for this to show)

Building

1. Setup

After installing Oracle JDK (recommended) or OpenJDK, and Maven, checkout the source:

git clone https://github.com/GlowstoneMC/Glowstone
cd Glowstone

2. Build

./setup.sh

The final jar will be placed in target/ named glowstone-X.XX-SNAPSHOT.jar.

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.

Playing

For those of you who just want to play on a Glowstone server, we have one available for testing at mc.glowstone.net. Have fun!

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 for Glowstone can be found here.

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.