Upstream/SKCraft-Launcher
1
0
Fork 0
mirror of https://github.com/SKCraft/Launcher.git synced 2024-11-24 12:16:28 +01:00
Code Issues Projects Releases Wiki Activity
bcd90cfec9
SKCraft-Launcher/README.md

60 lines
2.1 KiB
Markdown
Raw Normal View History

Initial commit.
2014-01-09 00:09:06 +01:00
SKCraft Launcher
================
Updated README with a better description of the project
2014-02-22 22:30:26 +01:00
This project provides an open-source Minecraft launcher platform for downloading,
installing, and updating modpacks.
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
The launcher has its roots in MC Alpha as a launcher for sk89q's server.
Updated README with a better description of the project
2014-02-22 22:30:26 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
**Note:** "SKMCLauncher" is the *older* version of this launcher. This project is called "SKCraft Launcher."
## Introduction
Made README.md shorter.
2014-03-22 00:54:39 +01:00
* 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
* Open source!
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
## Usage
Made README.md shorter.
2014-03-22 00:54:39 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
1. Download the code.
2. See if you can compile it (see instructions below).
3. Read the documentation to (1) learn how to change the launcher to use your own website and (2) create modpacks in the right format for the launcher.
Made README.md shorter.
2014-03-22 00:54:39 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
* [Documentation](http://wiki.sk89q.com/wiki/Launcher)
* [Forum to ask for help](http://forum.enginehub.org/forums/launcher.25/)
Made README.md shorter.
2014-03-22 00:54:39 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
You can also [contact sk89q](http://www.sk89q.com/contact/).
Made README.md shorter.
2014-03-22 00:54:39 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
## Compiling
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
First, make sure to install the Java Development Kit (JDK).
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
In your command prompt or terminal, run:
Made README.md shorter.
2014-03-22 00:54:39 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
./gradlew clean build
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
If you are on Windows:
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
gradlew clean build
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
Once compiled, look for the "-all" .jar files in the following folders:
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
* `launcher/build/libs/` - The main launcher
* `launcher-builder/build/libs/` - Command line app to build modpacks
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
If you wish to import the project into an IDE, you must add support for Project Lombok (IntelliJ IDEA users: also enable annotation processing in compiler settings).
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
## Contributing
Initial commit.
2014-01-09 00:09:06 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
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.
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +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).
Updated README.md.
2014-01-29 23:28:43 +01:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history.
2015-02-19 06:29:39 +01:00
## License
Updated README.md.
2014-01-29 23:28:43 +01:00
The launcher is licensed under the GNU General Public License, version 3.
Reference in New Issue Copy Permalink