Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grahamedgecombe/lightstone

An open-source implementation of the Minecraft server software.
https://github.com/grahamedgecombe/lightstone

java minecraft

Last synced: about 2 months ago
JSON representation

An open-source implementation of the Minecraft server software.

Awesome Lists containing this project

README

        

Lightstone
==========

![Lightstone Logo](https://github.com/grahamedgecombe/lightstone/raw/master/etc/logo/logo-small.png)

Introduction
------------

Lightstone is an open-source implementation of the
[Minecraft](http://minecraft.net) server software written in Java.

The official server software has some shortcomings such as the use of threaded,
synchronous I/O along with high CPU and RAM usage. Lightstone aims to be a
lightweight and high-performance alternative.

Building
--------

Lightstone can be built with the
[Java Development Kit](http://oracle.com/technetwork/java/javase/downloads) and
[Apache Ant](http://ant.apache.org). [Apache Ivy](http://ant.apache.org/ivy) is
also used for dependency management.

If you have not yet done so, you will need to download the project's
dependencies which can be done with the `ant resolve` command. This only needs
to be done once initially and when the dependencies are updated.

Typing the command `ant` in the terminal will build the project.

Running
-------

Although not recommended, the server can be started via Ant. This is useful
for certain IDEs e.g. NetBeans which require an Ant target to run the project.

Typing the command `ant run` in the terminal will do this. It will also build
the project if the binaries are out of date.

Testing
-------

The unit tests can be executed using the `ant test` command in the terminal.

Documentation
-------------

Javadocs can be generated by using the `ant doc` command in the terminal.

Credits
-------

### Contributors

* [Graham Edgecombe](https://github.com/grahamedgecombe)
* [Jonathan Edgecombe](http://jonathanedgecombe.com)
* [Zhuowei Zhang](https://github.com/zhuowei)

### Miscellaneous Credits

* [The Minecraft Coalition](http://wiki.vg/wiki) - protocol and formats
research.
* [Jonathan Edgecombe](http://jonathanedgecombe.com) - designed the logo.
* [Scaevolus](http://minecraftforum.net/memberlist.php?mode=viewprofile&u=60394) - author
of the original McRegion code, upon which the Lightstone implementation is
based.
* [Trustin Lee](http://gleamynode.net) - author of the
[Netty](http://jboss.org/netty) and
[APIviz](http://code.google.com/p/apiviz) libraries.
* All the people behind [JRuby](http://jruby.org), [JUnit](http://junit.org),
[Ant](http://ant.apache.org), [Ivy](http://ant.apache.org/ivy),
[Graphviz](http://graphviz.org) and [Java](http://java.oracle.com).
* [Notch](http://mojang.com/notch) and all the other people at
[Mojang](http://mojang.com) - for making such an awesome game in the first
place!

Source Code
-----------

The original Lightstone source code can be found on
[GitHub](https://github.com/grahamedgecombe/lightstone). Feedback and patches
are welcome!

IRC
---

There is an IRC channel on `irc.freenode.net` - `#lightstone` - for discussing
development. Feel free to drop by some time.

Copyright
---------

Lightstone is open-source software released under the MIT license, please see
the `LICENSE` file for details.