diff --git a/README.md b/README.md index fe2117a..91475d4 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,70 @@ SKCraft Launcher ================ -SKCraft Launcher provides a platform for creating, testing, and distributing modpacks for groups of all sizes. It is 100% open source and works on Windows, Mac OS X and Linux/BSD. +Need to make it easy for people to install and play your modpack? The SKCraft Launcher platform may be for you if: -With this platform, you have **full control** of the modpacks that you choose to release. +:heavy_check_mark: You want your own logo and branding on the launcher, with your own news feed +:heavy_check_mark: You want to be able to update the modpack whenever you want +:heavy_check_mark: You don't want to depend on anyone else +:heavy_check_mark: There's several modpacks you want to provide as a set +:heavy_check_mark: You want to provide 'hidden' modpacks that are only accessible by a secret code -Every other launcher platform either requires you to maintain cryptic JSON/XML files (error prone and a lot of extra work), requires distributing a .zip of your modpack (therefore not supporting delta downloads and wasting disk space), or requires a complicated server setup where you have to install certain software on your server. In our case, we **(1)** threw away any need for JSON/XML files when making modpacks, **(2)** don't require a .zip and yet still can support delta downloads and **(3)** require absolutely zero server setup (if you only know FTP, that's enough). +It may not be for you if: -What to be aware of? You'll probably need a few hours to get everything working. Fortunately, we have a [detailed wiki](https://github.com/SKCraft/Launcher/wiki) with screenshots for every step, intended for someone with minimal technical experience. +:small_orange_diamond: You made a cool modpack and you just want it out there +:small_orange_diamond: You don't have a website or place for people to download files from +:small_orange_diamond: You don't want anything to do with distributing the launcher -### Features +## What We Do Right -* No XML/JSON files involved to create or update a modpack -* Create a modpack by dragging and dropping mod .jars into a mods/ folder -* Support for LiteLoader, Forge, and JAR mods -* Support for resource packs -* Support for all and any modpack files -* Test modpacks without even needing a separate launcher -* Multiple modpacks in the launcher -* Deduplication of files (only upload a mod once for all modpacks) -* Delta downloads when updating (only changed files) -* Download resume -* No need to host old versions; users can update from any previous version -* No PHP or complex server setup necessary -* Compatible with all standard website hosting and CDNs -* Optional mods/files support -* Support for default configuration files -* Modpack-specific Java flags -* "Hidden" modpacks that require a special access key (this *does* require PHP support) +Creating modpacks with this launcher is super easy: :one: only drag & drop of configs and mods into a folder, :two: ZERO! scary XML/JSON files to edit, and :three: there's a nice interface for creating modpacks (command-line is also available). -The wiki provides a detailed tutorial for configuring the launcher. You will need a website or an older Dropbox account to host your modpack's files, but there are several free website hosting options (with PHP support) listed on the wiki (with tutorials). +The launcher has all standard features that you'd expect like :one: resume of incomplete downloads, :two: incremental updates, and :three: file deduplication (saves disk space when you have files duplicated between updates or modpacks). -### Making Modpacks +LiteLoader, Forge, and .jar mods are supported. You can put resource packs in, or really even random mod files that don't go in the configs or mods folder. -Making modpacks is extremely easy: you can use our modpack creator tools: +You do need some sort of website, but it does **not** need anything complicated like PHP. + +For those technically inclined, you can generate modpacks from Git (or any VCS) using your favorite continuous integration server, and then dynamically create modpacks even down to one per branch or tag. + +## Getting Started + +You'll probably need a few hours to get everything working. Fortunately, we have a [detailed wiki](https://github.com/SKCraft/Launcher/wiki) with screenshots for every step, intended for someone with minimal technical experience. + +For your evaluation, there are sample files provided that you will be able to upload to your site to see if it even works for you. + +### Pretty Pictures + +If you are going to create modpacks with our GUI tool, you'll be seeing this beaut: ![Modpack Creator](readme/pack_manager.png) -If installing mods for your own game only requires putting a .jar file into a mods folder, why should making a modpack be any harder? +![Modpack Creator](readme/modpack_creator.png) -To get started, you just make a folder that looks like your Minecraft installation folder: +![Build Modpacks](readme/packages_generator.png) + +Making a modpack is just drag and dropping into a folder like this: * src/**config**/ * src/**mods**/ * src/**resourcepacks**/ * loaders/ -Support for Minecraft Forge and LiteLoader merely involves putting their installer .jars into the loaders folder. +You'd put LiteLoader and Forge into the *loaders* folder. :ok_hand: -### Great Client +### More Pictures -The launcher has a beautiful dark UI that's elegant and easy to use (although a native UI is also available). Display your own webpages so users always know what's up when they start the game. +There's a dark version of the launcher (personally not the creator's cup of tea) that you can use: ![Skinned](readme/launcher_skinned.png) -When it comes to launching your modpacks, users can start, abort, and resume updates at any time. Files are downloaded in parallel, and the launcher knows how to handle the removal of files from the modpack. - -Users can select those optional features that you have added: +Users can select optional mods/features: ![Optional Features](readme/features.png) -The launcher can **even update itself**. +The launcher can update itself and you can use it in portable mode too. -...and you can use it in portable mode too. - -### More Features - -All of the modpack tools can be used to create a server modpack alongside the client modpack! - -You can optionally use **command line tools** only, without the GUI entirely. Combine the launcher with Git and Jenkins (or whatever you prefer) to automatically build modpack releases when you push a new version. - -### History - -The launcher has been in development since the early days of Minecraft Alpha. It has powered and always has powered sk89q's own server, SKCraft. - -[The older 3.x version was can be found elsewhere](https://github.com/sk89q/SKMCLauncher). - -## Additional Screenshots - -You can also use the "plain" version of the launcher: +## The Light Theme ![Main Launcher](readme/launcher.png) @@ -86,34 +72,6 @@ ![Console](readme/log.png) -More of the Modpack Creator: - -![Modpack Creator](readme/modpack_creator.png) - -![Build Modpacks](readme/packages_generator.png) - -## Getting Started - -* [Read the wiki](https://github.com/SKCraft/Launcher/wiki) -* [Forum to ask for help](http://forum.enginehub.org/forums/launcher.25/) -* [Join us on IRC: #sklauncher on EsperNet (irc.esper.net)](https://webchat.esper.net/?channels=sklauncher) - -If you find the launcher useful, you can [support me on Patreon](https://www.patreon.com/sk89q). - -[![Support Me on Patreon](https://i.imgur.com/Sg03Bzc.png)](https://www.patreon.com/sk89q) - -## Compiling - -In your command prompt or terminal, run: - - ./gradlew clean build - -If you are on Windows: - - gradlew clean build - -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). - ## 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.