mcdr-singleplayer

简体中文 | 繁體中文 | English

Issues | MCDReforged | Prime Backup | Chunk Backup

MCDR is a Python tool for controlling Minecraft servers. See MCDReforged.

This mod is in early testing. Before using backup plugins, make a complete backup of your save using another method!!!!!
This mod is in early testing. Before using backup plugins, make a complete backup of your save using another method!!!!!
This mod is in early testing. Before using backup plugins, make a complete backup of your save using another method!!!!!

Requirements and Version Support

Supports Fabric and NeoForge on Minecraft 1.21–26.3.

The mod does not download or install Python. If Python is not detected, an installation prompt appears after you enter a singleplayer world. Once Python is installed and detected, the mod continues setting up MCDR.

Installation and First Launch

Place the JAR for your loader and Minecraft version series in the mods/ folder of your client game instance, then launch the game and enter a singleplayer world. Fabric also requires Fabric API.

• Automatic startup, save profiles, and configuration import
• Manual installation
• Prime Backup compatibility
• Chunk Backup compatibility

After MCDR starts, chat explains that the main player has MCDR permission level 4 and offers optional backup plugins. Follow the prompts to install Prime Backup or Chunk Backup. After installing Prime Backup, you can choose whether to enable backups, schedule one every 4 hours, and apply the recommended automatic cleanup settings.

If MCDR is still being prepared when you enter a world, a progress screen identifies the mod. Close it with the button or Esc while installation continues in the background. Chat reports installation stages, download source changes, readiness, or failure, with a reminder every 20 seconds during long waits.

Features

• Forward in-game chat, player join and leave events, and world start and stop events to MCDR plugins; relay commands and their responses
• Register loaded MCDR plugin root commands, aliases, subcommands, arguments, and suggestions as client-side /!! commands; update them when plugins are loaded, unloaded, or reloaded
• Isolate plugin configuration, plugin data, and backups by save-folder name, and start the matching MCDR environment when switching saves
• Adapt Prime Backup and Chunk Backup for singleplayer; show restore progress and prevent opening the target save until restoration is complete
• Support Simplified Chinese, Traditional Chinese, and English, following the client language

Data Directory

Shared mod and MCDR files are stored in the game instance's mcdr-singleplayer/ directory. Each save's data is stored under plugindata/<save folder name>/. When upgrading, the old date/ directory is migrated automatically.

mcdr-singleplayer/
├─ mcdr-singleplayer-config.yml  Mod configuration with field comments
├─ config.yml                    Shared MCDR configuration
├─ permission.yml                Shared player permissions
├─ plugins/                      Shared MCDR plugins
├─ plugindata/
│  └─ <save folder name>/
│     ├─ config/<plugin ID>/     Plugin configuration and some plugin data
│     ├─ pb_files/               Prime Backup data and backups
│     └─ cb_files/               Chunk Backup region backups
├─ log/                          Installer, controller, and MCDR logs
└─ runtime/                      Python, MCDR, and bridge runtime

After permanently deleting a save, you can remove its mcdr-singleplayer/plugindata/<save folder name>/ directory to delete its plugin data as well. Third-party plugins that use fixed absolute paths may need their configuration adjusted.

License

This project is licensed under the GNU Lesser General Public License v3.0.