Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kmcsr/server-installer
A minecraft server installer, support multiple type of server and modpack
https://github.com/kmcsr/server-installer
fabric fabric-server fabricmc forge forge-server minecraft minecraft-fabric minecraft-installer minecraft-server minecraft-server-installer minecraftserver-installer modrinth-modpack mrpack quilt-server quiltmc server-installer spigot spigot-server
Last synced: 2 months ago
JSON representation
A minecraft server installer, support multiple type of server and modpack
- Host: GitHub
- URL: https://github.com/kmcsr/server-installer
- Owner: kmcsr
- License: gpl-3.0
- Created: 2023-04-04T02:11:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-03T04:24:05.000Z (9 months ago)
- Last Synced: 2024-09-28T12:03:20.710Z (3 months ago)
- Topics: fabric, fabric-server, fabricmc, forge, forge-server, minecraft, minecraft-fabric, minecraft-installer, minecraft-server, minecraft-server-installer, minecraftserver-installer, modrinth-modpack, mrpack, quilt-server, quiltmc, server-installer, spigot, spigot-server
- Language: Go
- Homepage:
- Size: 71.3 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- Changelog: changelogs/v1.2.0.MD
- License: LICENSE
Awesome Lists containing this project
README
- English
- [简体中文](./README_zh.MD)
Minecraft Server Installer
[](https://github.com/kmcsr/server-installer/blob/main/LICENSE)
[](https://github.com/kmcsr/server-installer/actions)
[](https://github.com/kmcsr/server-installer/releases)
========
*If this project is useful, please give a star :)*
[Releases Page](https://github.com/kmcsr/server-installer/releases/)
## Introduction
This is a minecraft server online installer
You can use this cli to easily install minecraft server.
We also support some types of servers and modpacks
| Server Type | Support |
|-------------|---------|
| Vanilla | true |
| Fabric | true |
| Forge | true |
| Quilt | true |
| Spigot | true |
| PaperMC | TODO |
| ArcLight | TODO |
| Modpack Type | Support |
|--------------|---------|
| Modrinth | true |
| Curseforge | plan/no |
> Warn: For spigot server, you **must install suitable openjdk** (not only jre) and git.
> See
## Flags
```
Flags:
-h, -help
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 ".")
-version string
the version of the server need to be installed, default is the latest (default "latest")
Args:
string
type of the server [fabric forge quilt spigot vanilla] (default "vanilla" )
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
```
```sh
# Install minecraft 1.19.2 forge server into current directory and the executable is minecraft_server.sh or minecraft_server.bat for windows
minecraft_installer -name minecraft_server -version 1.19.2 -server forge
# Hint: forge installer will make run scripts for the minecraft version that higher or equal than 1.17
# for version that less than 1.17, you still need to use 'java -jar' to run the server
# Install minecraft 1.16.5 forge server into minecraft_server.jar
minecraft_installer -name minecraft_server -version 1.16.5 -server forge
```
```sh
# Install minecraft 1.19.2 fabric server into server/minecraft_server.jar
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/modrinth-modpack.mrpack
# Hint: Only support modrinth 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://]
```
### List server avaliable versions
```sh
minecraft_installer versions
```
```sh
minecraft_installer -version snapshot versions
```
## TODO
- [ ] PaperMC
- [ ] Search modpacks from modrinth
- [ ] Configurable proxy