https://github.com/shock59/makemcserver
CLI tool to easily set up a Minecraft server, made with TypeScript
https://github.com/shock59/makemcserver
cli fabricmc forgemc minecraft minecraft-server minecraftforge neoforge neoforged node node-cli nodejs papermc typescript
Last synced: 5 months ago
JSON representation
CLI tool to easily set up a Minecraft server, made with TypeScript
- Host: GitHub
- URL: https://github.com/shock59/makemcserver
- Owner: shock59
- Created: 2025-08-31T02:03:31.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-10-18T07:15:09.000Z (5 months ago)
- Last Synced: 2025-10-19T04:45:46.565Z (5 months ago)
- Topics: cli, fabricmc, forgemc, minecraft, minecraft-server, minecraftforge, neoforge, neoforged, node, node-cli, nodejs, papermc, typescript
- Language: TypeScript
- Homepage:
- Size: 63.5 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# makemcserver
 
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.
## Usage
You need [Node.js](https://nodejs.org/) installed to use the tool. To set up a NeoForge or Forge server, you will also need Java installed, which you can get from [Adoptium](https://adoptium.net/) or other providers.
Once you have everything installed, simply run `npx makemcserver` in the terminal/command prompt.
## Configuration
The configuration is stored as a YAML file which can be in the following locations:
* `makemcserver.yml` in the current working directory
* On Linux: `XDG_CONFIG_HOME/makemcserver/makemcserver.yml` (usually this is `~/.config/makemcserver/makemcserver.yml`)
* On Windows: `%AppData%\makemcserver\Config\makemcserver.yml`
* On Mac: `~/Library/Preferences/makemcserver/makemcserver.yml`
* `.makemcserver.yml` in your home directory
It can be formatted like this (all three major sections are optional):
```yml
defaultMods:
fabric:
- "P7dR8mSH" # Fabric API
modPresets:
fabric:
"Optimization":
default: true
mods:
- "gvQqBUqZ" # Lithium
- "uXXizFIs" # FerriteCore
- "NRjRiSSD" # Memory Leak Fix
- "fQEb0iXm" # Krypton
- "VSNURh3q" # C2ME
- "KuNKN7d2" # Noisium
"spark":
default: true
mods: "l6YH9Als"
"No Chat Reports": "qQyHxfxd"
"Simple Voice Chat": "9eGKb6K1"
paper:
"FreedomChat": "MubyTbnA"
"Simple Voice Chat": "9eGKb6K1"
"WorldEdit": "1u6JkXh5"
"ViaVersion": "P1OZGk5p"
"LuckPerms": "Vebnzrzj"
neoforge:
"spark":
default: true
mods: "l6YH9Als"
"No Chat Reports": "qQyHxfxd"
"Simple Voice Chat": "9eGKb6K1"
forge:
"spark":
default: true
mods: "l6YH9Als"
"No Chat Reports": "qQyHxfxd"
"Simple Voice Chat": "9eGKb6K1"
javaPaths:
# 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.
# Examples:
default: "java"
8: "/usr/lib/jvm/java-8-openjdk/jre/bin/java"
```
To get the Modrinth ID for a mod, go to its page on the Modrinth website, click the three dots in the top right and click on "Copy ID".