2014-01-09 00:09:06 +01:00
|
|
|
SKCraft Launcher
|
|
|
|
|
================
|
|
|
|
|
|
2014-02-22 22:30:26 +01:00
|
|
|
This project provides an open-source Minecraft launcher platform for downloading,
|
|
|
|
|
installing, and updating modpacks.
|
|
|
|
|
|
|
|
|
|
Introduction
|
|
|
|
|
------------
|
|
|
|
|
|
2014-03-22 00:54:39 +01:00
|
|
|
This launcher is maintained by sk89q, who writes WorldEdit, WorldGuard, and so on. It has
|
|
|
|
|
been primarily developed for his server, but you can use it for your own modpack or
|
|
|
|
|
server.
|
|
|
|
|
|
|
|
|
|
* One of Minecraft's oldest launchers -- since Minecraft Alpha
|
|
|
|
|
* Requires almost no configuration files to make a modpack
|
|
|
|
|
* Add a new mod by dropping in the .jar (and its configuration)
|
|
|
|
|
* Remove a mod by deleting its .jar (and configuration).
|
|
|
|
|
* Builds **server** modpacks with no extra configuration
|
|
|
|
|
* Advanced download system: incremental, file removal detection, optional feature/mod selection, etc.
|
|
|
|
|
* Very easy for users to use and install modpacks
|
|
|
|
|
* Pretty well-documented with easy-to-understand, well-organized code*
|
|
|
|
|
* Open source!
|
|
|
|
|
|
|
|
|
|
*Except for the Launcher frame class. That one is pretty bad.
|
|
|
|
|
|
|
|
|
|
### Previous Versions
|
|
|
|
|
|
|
|
|
|
This repository only contains code for the launcher versions 4.x and newer.
|
|
|
|
|
|
|
|
|
|
You can find [the 3.x version on GitHub](https://github.com/sk89q/skmclauncher).
|
|
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
First off, be aware that the launcher in this directory has been branded for sk89q's
|
|
|
|
|
server, so you will have to replace that with your own. There's only a few places that
|
|
|
|
|
you need to do that, and it's all documented on our documentation page.
|
|
|
|
|
|
|
|
|
|
**You can fork the project on GitHub** and make modifications.
|
2014-01-29 23:28:43 +01:00
|
|
|
|
|
|
|
|
* [Home page](http://opensource.skcraft.com/)
|
|
|
|
|
* [Documentation](http://confluence.skcraft.com/display/LAUN/Launcher)
|
|
|
|
|
* [Issue tracker](http://issues.skcraft.com/browse/LAUN)
|
|
|
|
|
|
2014-02-22 22:30:26 +01:00
|
|
|
Note that documentation may be lacking in some places. If you run into problems,
|
2014-03-22 00:54:39 +01:00
|
|
|
**do not hesitate to ask**.
|
|
|
|
|
|
|
|
|
|
If you want to contact me about some sort of partnership, want to make the launcher
|
|
|
|
|
the official launcher for something, please email me (see
|
|
|
|
|
[my website](http://www.sk89q.com/contact/)). While you do not have to do this, we
|
|
|
|
|
can make future decisions with awareness of what the needs of other users may be.
|
2014-01-29 23:28:43 +01:00
|
|
|
|
|
|
|
|
Compiling
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
The launcher can be compiled using [Maven](http://maven.apache.org/).
|
|
|
|
|
|
|
|
|
|
mvn clean package
|
|
|
|
|
|
|
|
|
|
If you wish to import the project into an IDE, you must add support for
|
|
|
|
|
Project Lombok.
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Pull requests can be submitted on GitHub, but we will accept them
|
|
|
|
|
at our discretion. Please note that your code must follow
|
|
|
|
|
Oracle's Java Code Conventions.
|
2014-01-09 00:09:06 +01:00
|
|
|
|
|
|
|
|
Contributions by third parties must be dual licensed under the two licenses
|
|
|
|
|
described within LICENSE.txt (GNU General Public License, version 3, and the
|
|
|
|
|
3-clause BSD license).
|
2014-01-29 23:28:43 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
The launcher is licensed under the GNU General Public License, version 3.
|
