Upstream/SKCraft-Launcher
1
0
Fork 0
mirror of https://github.com/SKCraft/Launcher.git synced 2024-11-27 12:46:22 +01:00
Code Issues Projects Releases Wiki Activity
994175c5b7
SKCraft-Launcher/README.md
sk89q 43f38614b0 Update documentation link.
2014-08-10 14:54:08 -07:00

2.6 KiB
Raw Blame History

SKCraft Launcher

This project provides an open-source Minecraft launcher platform for downloading, installing, and updating modpacks.

Introduction

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.

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.

Note that documentation may be lacking in some places. If you run into problems, 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). While you do not have to do this, we can make future decisions with awareness of what the needs of other users may be.

Compiling

The launcher can be compiled using Maven.

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.

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).

License

The launcher is licensed under the GNU General Public License, version 3.