Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MajickTek authored Mar 29, 2022
1 parent da2985e commit 1dbfd8b
Showing 1 changed file with 3 additions and 16 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,13 @@ Everything that the launcher downloads is in `<user folder>/Documents/MajickTek/

On \*NIX systems including macOS (probably) you should be able to find the right folder by navigating to `~\Documents\MajickTek`. On Windows this would be `C:/Users/%username%/Documents/MajickTek`.

As of now, the current minimum version of the launcher you should use is `Release 1.0`. This version's minimum JRE version is 1.8 (JRE 8) to make it more accessible (this may change in the future if necessary). Earlier versions require JRE 16 or newer and likely don't support the generally backwards-compatible [XML format](https://github.com/MajickTek/MiniCraftLauncherIndex).
As of now, the current minimum version of the launcher you can (and should) use is `Release 1.0`. This version's minimum JRE version is 1.8 (JRE 8) to make it more accessible (this may change in the future if necessary). Earlier versions require JRE 16 or newer and likely don't support the generally backwards-compatible [XML format](https://github.com/MajickTek/MiniCraftLauncherIndex).

## Current functionality:
- Load versions from https://github.com/MajickTek/MiniCraftLauncherIndex/
- Double-click to download a version
- Double-click already downloaded version to launch it
- The launcher keeps track of downloaded versions on restart
- Under the Edit menu, go into the Select Channel submenu to switch between Release, Pre-Release, and Mod channels.
- Insert/Add version profiles. These cannot be saved at the moment. GUI Options accessible via the Edit menu.
- See download progress
- Supports basic hotkeys
See the [wiki](https://github.com/MajickTek/MiniCraftLauncher/wiki).
## How does it work?
When a channel is selected, it downloads a `.xml` file from https://github.com/MajickTek/MiniCraftLauncherIndex.

This file describes the information to display as well as the various needed download links.

The format of this file is described over there.

Ditto.
## Roadmap
- Add config file to load the indexes (so they aren't hardcoded and the user can make their own)
- (Future) Allow self-updating via GitHub Releases
- I have an easy solution for this but it would be Windows-only unless I find a way to make it cross platform
- Fabric Support (with help from PseudoDistant on the various discords)
Expand Down

0 comments on commit 1dbfd8b

Please sign in to comment.