Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nothub committed Sep 7, 2022
1 parent d623376 commit 733b974
Showing 1 changed file with 46 additions and 19 deletions.
65 changes: 46 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,61 @@

[![Go Reference](https://pkg.go.dev/badge/github.com/nothub/mrpack-install.svg)](https://pkg.go.dev/github.com/nothub/mrpack-install)

A cli application for installing Minecraft servers
and [Modrinth](https://modrinth.com/) [modpacks](https://docs.modrinth.com/docs/modpacks/format_definition/).
A cli application for installing Minecraft servers and [Modrinth](https://modrinth.com/) [modpacks](https://docs.modrinth.com/docs/modpacks/format_definition/).

---

### Usage

#### modpack deployment
```
mrpack-install (<filepath> | <url> | <slug> [<version>] | <id> [<version>])
mrpack-install server (vanilla | fabric | quilt | forge | paper | spigot)
mrpack-install ping
Deploys a Modrinth modpack including Minecraft server.
Usage Examples:
mrpack-install downloads/cool-pack.mrpack
mrpack-install https://example.org/data/cool-pack.mrpack
mrpack-install hexmc-modpack --server-file server.jar
mrpack-install yK0ISmKn 1.0.0-1.18 --server-dir mcserver
mrpack-install communitypack9000 --host api.labrinth.example.org
Usage:
mrpack-install (<filepath> | <url> | <slug> [<version>] | <id> [<version>]) [flags]
mrpack-install [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
ping Ping a Labrinth instance
server Prepare a plain server environment
version Print version infos
Flags:
--download-threads int Download threads (default 8)
-h, --help help for mrpack-install
--host string Labrinth host (default "api.modrinth.com")
--proxy string Use a proxy to download
--retry-times int Number of retries when a download fails (default 3)
--server-dir string Server directory path (default "mc")
--server-file string Server jar file name
Use "mrpack-install [command] --help" for more information about a command.
```

### Examples
---

#### server deployment
```
# install from file
mrpack-install downloads/cool-pack.mrpack
Download and configure one of several Minecraft server flavors.
# install from url
mrpack-install https://example.org/data/cool-pack.mrpack
Usage Examples:
mrpack-install server fabric --server-dir fabric-srv
mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar
# install from api
mrpack-install hexmc-modpack --server-file server.jar
mrpack-install yK0ISmKn 1.0.0-1.18 --server-dir mcserver
mrpack-install communitypack9000 --host api.labrinth.example.org
Usage:
mrpack-install server (vanilla | fabric | quilt | forge | paper | spigot) [flags]
# install bare server
mrpack-install server fabric --server-dir fabricsrv
mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar
Flags:
--flavor-version string Flavor version (default "latest")
-h, --help help for server
--minecraft-version string Minecraft version (default "latest")
--server-dir string Server directory path (default "mc")
--server-file string Server jar file name
```

0 comments on commit 733b974

Please sign in to comment.