|
1 |
| -# mc-cli |
2 |
| -todo write more here |
| 1 | +# Minecraft CLI (mc) |
| 2 | +A simple command line interface for managing and launching Minecraft instances, friendly to both users and automation/tooling. |
3 | 3 |
|
| 4 | +(insert fancy image here) |
4 | 5 |
|
5 |
| -## Command Spec |
6 |
| -`<>` indicates required arg |
7 |
| -`[]` indicates optional arg |
8 |
| -otherwise it is a literal string |
| 6 | +## Features |
| 7 | +todo |
9 | 8 |
|
10 |
| -### Account management |
| 9 | +Planned: |
| 10 | +- Mod management/auto update |
| 11 | +- Modpack installation |
| 12 | +- MultiMC/Prism integration (either autodetecting installations and using them, or importing instances) |
| 13 | +- Vanilla launcher integration (either autodetecting installations and using them, or importing instances) |
| 14 | +- Java installation based on requested version in manifest |
| 15 | +- Support for legacy launcher metadata formats (eg the ability to launch older Minecraft versions) |
| 16 | +- Forge support |
| 17 | +- Automatic synchronization of saves/resource packs/configs/servers between instances |
11 | 18 |
|
12 |
| -- `mc account default|use` - Show the current default account |
13 |
| -- `mc account default|use <username|uuid>` - Set the default account |
14 |
| -- `mc account login` - Login to a new account with Microsoft |
15 |
| -- `mc account token (username|uuid)` - Get an access token for the given account |
16 |
| -- `mc account list` - Show a list of all known accounts |
| 19 | +## Installation |
17 | 20 |
|
18 |
| -### Java management |
| 21 | +> ![WARNING] |
| 22 | +> Windows is not officially supported yet, but it may work. If you encounter any issues, please report them as an issue. |
19 | 23 |
|
20 |
| -- `mc java default|use` - Show the current default java installation to be used |
21 |
| -- `mc java default|use <name>` - Set the default installation |
22 |
| -- `mc java list` - List all discovered java installations |
23 |
| -- `mc java discover <path-to-exe> [--set-default]` - Discover a preinstalled java version |
24 |
| -- !! `mc java install <version> [name]` - Install a new java dedicated to Minecraft |
| 24 | +A prebuilt binary is available for macOS and Linux in the [releases](https://github.com/mworzala/mc/releases) tab. |
25 | 25 |
|
26 |
| -### Profile management |
27 |
| - |
28 |
| -- `mc install <mc-version> [name]` - Install vanilla minecraft (profile will be named as version if unspecified) |
29 |
| -- `mc install <mc-version> [name] --fabric [--loader loader-version]` - Install fabric |
30 |
| -- `mc run <profile>` - Launch a profile immediately |
31 |
| -- `mc profile list` |
32 |
| -- |
33 |
| -- ! `mc profile delete <name>` |
34 |
| -- ! `mc profile config <name> [key] [value]` |
35 |
| - |
36 |
| -### Mod management (todo) |
37 |
| -All commands would have a `--profile`, `-p` arg to specify which profile is being edited. |
38 |
| - |
39 |
| -- `mc mod install` |
| 26 | +### Go Install |
| 27 | +It is possible to install the latest version of `mc` using `go install`: |
| 28 | +```shell |
| 29 | +go install github.com/mworzala/mc@latest |
| 30 | +``` |
40 | 31 |
|
41 |
| -### Config management |
42 |
| -maybe |
| 32 | +### Building From Source |
| 33 | +It is possible to build `mc` from source as long as you have Make and Go installed. |
43 | 34 |
|
44 |
| -## Configuration |
| 35 | +```shell |
| 36 | +make build |
| 37 | +``` |
45 | 38 |
|
46 |
| -All subject to change, none of it is implemented |
| 39 | +## Usage |
| 40 | +todo |
47 | 41 |
|
48 |
| -``` |
49 |
| -# Autolink options describe whether to symlink those resources between different instances |
50 |
| -# todo is this really viable? |
51 |
| -autolink.config = bool |
52 |
| -autolink.servers = bool |
53 |
| -autolink.saves = bool |
54 |
| -autolink.resourcepacks = bool |
55 |
| -``` |
| 42 | +## Automation |
56 | 43 |
|
57 |
| -## Building from source |
| 44 | +## Contributing |
| 45 | +todo |
58 | 46 |
|
59 |
| -`make build` |
| 47 | +## License |
| 48 | +This project is licensed under the [MIT](../LICENSE). |
0 commit comments