Skip to content

Commit

Permalink
update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
zyxkad committed May 24, 2023
1 parent 020a022 commit 3711b89
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 7 deletions.
30 changes: 26 additions & 4 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Minecraft Server Installer
This is a minecraft server online installer

You can use this cli to easily install minecraft server.
We also support fabric,forge,spigot
We also support fabric,forge,spigot and some type of modpacks

> Warn: For spigot server, you **must install suitable openjdk** (not only jre) and git.
> See <https://www.spigotmc.org/wiki/buildtools/#prerequisites>
Expand All @@ -27,19 +27,24 @@ We also support fabric,forge,spigot
```
Flags:
-h, -help
show this help message
Show this help page
-name string
the executable name, without suffix such as '.sh' or '.jar' (default "minecraft")
-output string
the path need to be installed (default ".")
-server string
type of the server [fabric,forge,spigot,vanilla] (default "vanilla")
-version string
the version of the server need to be installed, default is the latest (default "latest")
Args:
<server_type> string
type of the server [fabric forge spigot vanilla] (default "vanilla" )
<modpack_file> filepath | URL
the modpack's local path or an URL. If it's an URL, installer will download the modpack first
```

## Examples

### Install pure servers

```sh
# Install minecraft 1.7.10 vanilla server into minecraft.jar
minecraft_installer -name minecraft -version 1.7.10
Expand All @@ -60,8 +65,25 @@ minecraft_installer -name minecraft_server -version 1.16.5 -server forge
minecraft_installer -name minecraft_server -version 1.19.2 -server fabric -path server
```

### Install modpacks

```sh
# Install the modpack from local to the current directory
minecraft_installer -name modpack_server modpack /path/to/modrinch-modpack.mrpack
# Hint: Only support modrinch modpack for now, curseforge is in progress
```

```sh
# Install the modpack from internet to the current directory
minecraft_installer -name modpack_server modpack 'https://cdn-raw.modrinth.com/data/sl6XzkCP/versions/i4agaPF2/Automation%20v3.3.mrpack'
# Hint: if you want to install modpack from the internet,
# you must add the prefixs [https://, http://]
```

## TODO

- [ ] PaperMC
- [ ] Quilt
- [ ] Search modpacks from modrinth
- [ ] List server versions
- [ ] Configurable proxy
26 changes: 23 additions & 3 deletions README_zh.MD
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
这是一个需要联网的minecraft服务端下载器

你可以使用本程序简单的安装minecraft及其附属服务端.
我们目前支持 vanilla,fabric,forge,spigot
我们目前支持 vanilla,fabric,forge,spigot 以及一些格式的模组包

> 警告: 对于spigot服务端, 您**必须预先安装合适的openjdk**(不仅仅是jre)以及git.
> <https://www.spigotmc.org/wiki/buildtools/#prerequisites>
Expand All @@ -28,14 +28,19 @@ Flags:
可执行文件名称, 不包含可能的后缀例如'.sh'或'.jar' (默认 "minecraft")
-output string
服务端目标安装位置 (默认 ".")
-server string
服务端类型 [fabric,forge,spigot,vanilla] (默认 "vanilla")
-version string
将要安装的minecraft版本, latest或留空为可用的最新版 (默认 "latest")
Args:
<server_type> string
服务端类型 [fabric forge spigot vanilla] (默认 "vanilla")
<modpack_file> filepath | URL
模组包的本地路径或URL. 如果为URL则会先将模组包下载到临时路径
```

## 使用示例

### 安装纯服务端

```sh
# 将原版 minecraft 1.7.10 服务端下载到 minecraft.jar
minecraft_installer -name minecraft -version 1.7.10
Expand All @@ -55,3 +60,18 @@ minecraft_installer -name minecraft_server -version 1.16.5 -server forge
# 将 minecraft 1.7.10 fabric服务端下载到 server/minecraft_server.jar
minecraft_installer -name minecraft_server -version 1.19.2 -server fabric -path server
```

### 安装模组包

```sh
# Install the modpack from local to the current directory
minecraft_installer -name modpack_server modpack /path/to/modrinch-modpack.mrpack
# Hint: Only support modrinch modpack for now, curseforge is in progress
```

```sh
# Install the modpack from internet to the current directory
minecraft_installer -name modpack_server modpack 'https://cdn-raw.modrinth.com/data/sl6XzkCP/versions/i4agaPF2/Automation%20v3.3.mrpack'
# Hint: if you want to install modpack from the internet,
# you must add the prefixs [https://, http://]
```

0 comments on commit 3711b89

Please sign in to comment.