Skip to main content

A minecraft server installer!

Project description

Minecraft-Server-Installer

Description

This Tool is made for an easy Minecraft Server Setup! You can easily install a Minecraft Server with over 10 different packages and nearly all Versions out there!

Getting started

  • Installation

Run this command in your command prompt!

pip install mc-server-tool

To update:

pip install -U mc-server-tool
  • Documentation

mc-server-tool --help
usage: mc-server-tool [-h] [--install] [--start] [--settings] [--install_java_21] [--version VERSION]
                      [--package {Forge,Fabric,Paper,Vanilla,Spigot,Pufferfish,Bukkit,Purpur,Neoforge,Quilt,Folia,Mohist,Arclight,Sponge}] [--path PATH] [--port PORT]
                      [--ram RAM]

Minecraft Server Tool Arguments

options:
  -h, --help            show this help message and exit
  --install             To install a new Server!
  --start               To start a Server in your path!
  --settings            To open the settings of the Server in your path!
  --install_java_21     To install java version 21 to run the server!
  --version VERSION     Choose a minecraft version e.x 1.20.1, 1.21...
  --package {Forge,Fabric,Paper,Vanilla,Spigot,Pufferfish,Bukkit,Purpur,Neoforge,
             Quilt,Folia,Mohist,Arclight,Sponge}
                        Choose a Modloader-Package e.x Forge, Vanilla...
  --path PATH           Pick a folder were to save/edit the server!
                        It is creating a new folder in it! 
                        e.x C:Users/User/Server (Default is User Directory!)
  --port PORT           Choose a Port for the Server! Default is 25565
  --ram RAM             Choose how many RAM the server may use! Default is 2 Gigabyte!
  • Examples

Installs a server with version 1.20.4:

mc-server-tool --install --version 1.20.4 

Installs a server with version 1.20.4 on Paper:

mc-server-tool --install --version 1.20.4 --package Paper

Installs and starts the server with 5G max ram usage:

mc-server-tool --install --version 1.20.4 --ram 5

Installs with the port 27767:

mc-server-tool --install --version 1.20.4 --port 27767

Starts your server again:

mc-server-tool --start

Starts your Forge server if you have multiple servers in one folder:

mc-server-tool --start --package Forge

You can also specify the path on start and installation:

mc-server-tool --start --path /home/user/downloads

You also let install java 21:

mc-server-tool --install_java_21

Package Support

Supported Packages Status Supported Packages Status Supported Packages Status
Vanilla ✔️ Forge ➖ (installing is fine but
starting and configuring
may not work)
Folia ✔️
Paper ✔️ Neoforge ✔️ Mohist ✔️
Spigot ✔️ Fabric ✔️ Arclight ✔️
Bukkit ✔️ Pufferfish ✔️ Sponge ✔️
Quilt ✔️ Purpur ✔️ BungeeCord ✔️

Note: Not all versions are tested and there may occur problems with some versions!

Upcoming Tasks

  • Make Forge work
  • Make Neoforge work
  • Make starting easier with package and version
  • Implement more different error messages
  • Add support for more packages
  • Add support for MCPE Server

Support

If you see any issues you can open one in github or contact me on discord with the UsernameTmaster055!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mc_server_tool-0.0.8.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mc_server_tool-0.0.8-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file mc_server_tool-0.0.8.tar.gz.

File metadata

  • Download URL: mc_server_tool-0.0.8.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.10

File hashes

Hashes for mc_server_tool-0.0.8.tar.gz
Algorithm Hash digest
SHA256 dada33b1b70fee8f92a04e878a1c1f90828a05a33b4d75c2fca5e3a313e97393
MD5 4d331f30825b6a9ed2d211139f865eab
BLAKE2b-256 8056a3e70cef12d44720f01de70bb84294b9c57a576d180f0e6ace9c724b08ee

See more details on using hashes here.

File details

Details for the file mc_server_tool-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: mc_server_tool-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.10

File hashes

Hashes for mc_server_tool-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7c50a51625818ec94a7800f785c5bb73213d3df9f4c55771b7b35771caa03aa3
MD5 fcd5801699dd0ef648c46db26b9b86ec
BLAKE2b-256 7c30b54aa44d42988c24770d5e5c818a69084062569acb08d1ae0816e3ef33d3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page