Skip to main content
McDis-RCON is distributed as a Python package and can be easily installed using pip.

​
System Requirements

Python Version

Python 3.8 or higher required

Operating System

Linux (recommended) or Windows

Discord Bot

Discord bot token with admin permissions

Network

Internet connection for Discord API
While McDis-RCON can run on Windows, it is primarily designed for Linux systems. Some features like the File Manager may not work as expected on Windows if you don’t own the files in the directory.

​
Installation Methods

The simplest way to install McDis-RCON is via pip: 
pip install mcdis-rcon
On some systems, you may need to use pip3 instead of pip.

​
System-Specific Installation

# Using pip3 (recommended for Linux)
pip3 install mcdis-rcon

# Or using python3 module
python3 -m pip install mcdis-rcon

​
Verifying Installation

After installation, verify that McDis-RCON is correctly installed: 
mcdis --help
You should see the help output with available commands: 
usage: mcdis [-h] {init,run,po} ...

McDis RCON CLI

positional arguments:
  {init,run,po}
    init          Initialize the project
    run           Run the main function
    po            Update the .po file

​
Dependencies

McDis-RCON automatically installs the following dependencies:
  • discord.py - Discord API wrapper
  • psutil - Process and system utilities
  • flask - Web server for file downloads
  • requests - HTTP library
  • nbtlib - NBT file handling
  • ruamel.yaml - YAML configuration parser
  • polib - Localization support
The ruamel.yaml module occasionally fails to install properly. See the troubleshooting section below if you encounter issues.

​
Troubleshooting Installation

​
ruamel.yaml Installation Issues

If you encounter errors related to ruamel.yaml, try reinstalling it with the --force flag: 
python3 -m pip install --force ruamel.yaml
This usually resolves the issue in most cases.

​
Permission Denied Errors

If you get permission errors during installation: 
pip3 install --user mcdis-rcon

​
Python Version Issues

Check your Python version: 
python --version
# or
python3 --version
If you’re running Python < 3.8, you’ll need to upgrade: 
sudo apt update
sudo apt install python3.10

​
Virtual Environment Issues

If you’re using a virtual environment and commands aren’t found: 
# Make sure the virtual environment is activated
which python  # Should point to your venv
which mcdis   # Should point to your venv

# If not, reactivate:
source mcdis-env/bin/activate  # Linux/macOS
mcdis-env\Scripts\activate     # Windows

​
Upgrading McDis-RCON

To upgrade to the latest version: 
pip install --upgrade mcdis-rcon
Or with pip3: 
pip3 install --upgrade mcdis-rcon
Check the PyPI page for the latest version information.

​
Uninstalling

To remove McDis-RCON from your system: 
pip uninstall mcdis-rcon
Uninstalling McDis-RCON will not remove your configuration files (md_config.yml) or server files. You’ll need to delete those manually if desired.

​
Next Steps

After successful installation:
1

Create Discord Bot

If you haven’t already, create a Discord bot and get your bot token.
2

Follow Quickstart

Head to the Quickstart Guide to set up your first server.
3

Configure McDis

Learn about Configuration options to customize your setup.

​
Version Information

Current Version: 0.4.30aPython Compatibility: 3.8, 3.10, 3.12+License: View on GitHub

​
Additional Resources

PyPI Package

View package details and version history

GitHub Repository

Source code and issue tracker

Discord Community

Get help from the community

Example Implementations

See real-world configurations

Build docs developers (and LLMs) love

Get started for freeTalk to us