Skip to content

meltingscales/pyminecraftserver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

303 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

forthebadge

Build Status

Coverage Status

pyminecraftserver

This is a Python module to automate the process of setting up, configuring, and installing mods to minecraft servers.

Issues

This works on Windows 10, OSX, and Ubuntu Linux AFAIK. See build status (travis badge at top)/travis.yml for setup and logs.

Setup

Install Python 3.

Install pipenv by running pip install pipenv.

Then, run pipenv install in this directory to create a new virtualenv with all of the deps specified in ./Pipfile.

pipenv install --dev to install development packages as well like coverage.

You can also run pipenv install --system to install the dependencies globally.

Then, run pipenv shell to open a shell with the Python dependencies installed.

Running tests

Run python -m unittest discover to run the test cases.

Alternatively, use coverage run -m unittest discover to run with coverage.

Demos

cd into demo/.

Run simple_server_setup_demo.py, simple_json_server_setup_demo.py or interactive-server-starter.py for a taste of how this library can work.

I highly recommend interactive-server-starter.py.

Troubleshooting

Windows Path Length Limit

Because Windows™, you may need to enable paths longer than 260 characters.

Yes, I know. That's very short.

See https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file?redirectedfrom=MSDN#enable-long-paths-in-windows-10-version-1607-and-later for advice on doing this.

About

Automated Minecraft server setups using Python

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages