Skip to content

Commit 79728f6

Browse files
committed
Readme update for new config format
1 parent cc0706b commit 79728f6

File tree

1 file changed

+36
-20
lines changed

1 file changed

+36
-20
lines changed

README.md

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# makemcserver
22

3-
makemcserver is a CLI tool which can be used to easily set up a Minecraft server, useful if you need to quickly set up a server to run on your local PC without having to go into a web browser and manually download lots of files. It lets you choose any Minecraft version, and also installs the [Fabric mod loader](https://fabricmc.net/) when possible. Additionally, it allows you to install mods from [Modrinth](https://modrinth.com/) of your choice which you can specify in a config file.
3+
makemcserver is a CLI tool which can be used to easily set up a Minecraft server, useful if you need to quickly set up a server to run on your local PC without having to go into a web browser and manually download lots of files. It lets you choose any Minecraft version, and also optionally installs a custom server software of your choice (either [Fabric](https://fabricmc.net/), [Paper](https://papermc.io/), [NeoForge](https://neoforged.net/), or [Forge](https://files.minecraftforge.net/net/minecraftforge/forge/)). Additionally, it allows you to install mods from [Modrinth](https://modrinth.com/) of your choice which you can specify in a config file.
44

55
## Usage
66

@@ -18,27 +18,43 @@ The configuration is stored as a YAML file which can be in the following locatio
1818
It can be formatted like this (all three major sections are optional):
1919
```yml
2020
defaultMods:
21-
# A list of the mods which should always be installed on the server when possible, as their Modrinth IDs.
22-
# Example:
23-
- "P7dR8mSH" # Fabric API
21+
fabric:
22+
- "P7dR8mSH" # Fabric API
2423

2524
modPresets:
26-
# A list of Modrinth mod IDs which you can choose to install each time you create a new server. This can be structured in a variety of ways.
27-
# Examples:
28-
"Optimization":
29-
default: true
30-
mods:
31-
- "gvQqBUqZ" # Lithium
32-
- "uXXizFIs" # FerriteCore
33-
- "NRjRiSSD" # Memory Leak Fix
34-
- "fQEb0iXm" # Krypton
35-
- "VSNURh3q" # C2ME
36-
- "KuNKN7d2" # Noisium
37-
"spark":
38-
default: true
39-
mods: "l6YH9Als"
40-
"No Chat Reports": "qQyHxfxd"
41-
"Simple Voice Chat": "9eGKb6K1"
25+
fabric:
26+
"Optimization":
27+
default: true
28+
mods:
29+
- "gvQqBUqZ" # Lithium
30+
- "uXXizFIs" # FerriteCore
31+
- "NRjRiSSD" # Memory Leak Fix
32+
- "fQEb0iXm" # Krypton
33+
- "VSNURh3q" # C2ME
34+
- "KuNKN7d2" # Noisium
35+
"spark":
36+
default: true
37+
mods: "l6YH9Als"
38+
"No Chat Reports": "qQyHxfxd"
39+
"Simple Voice Chat": "9eGKb6K1"
40+
paper:
41+
"FreedomChat": "MubyTbnA"
42+
"Simple Voice Chat": "9eGKb6K1"
43+
"WorldEdit": "1u6JkXh5"
44+
"ViaVersion": "P1OZGk5p"
45+
"LuckPerms": "Vebnzrzj"
46+
neoforge:
47+
"spark":
48+
default: true
49+
mods: "l6YH9Als"
50+
"No Chat Reports": "qQyHxfxd"
51+
"Simple Voice Chat": "9eGKb6K1"
52+
forge:
53+
"spark":
54+
default: true
55+
mods: "l6YH9Als"
56+
"No Chat Reports": "qQyHxfxd"
57+
"Simple Voice Chat": "9eGKb6K1"
4258

4359
javaPaths:
4460
# Paths to the Java runtime for different Java versions, as well as a fallback "default" option. makemcserver will automatically select the correct Java version from this list.

0 commit comments

Comments
 (0)