{"id":34269333,"url":"https://github.com/benbaptist/minecraft-wrapper","last_synced_at":"2025-12-16T18:48:02.788Z","repository":{"id":10381384,"uuid":"12528313","full_name":"benbaptist/minecraft-wrapper","owner":"benbaptist","description":"A simple \u0026 intuitive Minecraft Server wrapper. Supports IRC, backups, a plugin system, and more.","archived":false,"fork":false,"pushed_at":"2020-04-01T18:44:04.000Z","size":28724,"stargazers_count":73,"open_issues_count":18,"forks_count":20,"subscribers_count":12,"default_branch":"master","last_synced_at":"2023-03-11T05:48:09.101Z","etag":null,"topics":["backup","irc","minecraft-server-wrapper","minecraft-wrapper","python","wrapper"],"latest_commit_sha":null,"homepage":"http://wrapper.benbaptist.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benbaptist.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-09-01T23:06:52.000Z","updated_at":"2022-11-28T18:46:30.000Z","dependencies_parsed_at":"2022-09-02T05:50:49.038Z","dependency_job_id":null,"html_url":"https://github.com/benbaptist/minecraft-wrapper","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/benbaptist/minecraft-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbaptist%2Fminecraft-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbaptist%2Fminecraft-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbaptist%2Fminecraft-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbaptist%2Fminecraft-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benbaptist","download_url":"https://codeload.github.com/benbaptist/minecraft-wrapper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbaptist%2Fminecraft-wrapper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27769688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-16T02:00:10.477Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","irc","minecraft-server-wrapper","minecraft-wrapper","python","wrapper"],"created_at":"2025-12-16T18:48:01.923Z","updated_at":"2025-12-16T18:48:02.778Z","avatar_url":"https://github.com/benbaptist.png","language":"Python","readme":"# Outdated Repository #\nWrapper.py has moved to a [new repository](https://github.com/benbaptist/wrapper.py). It features a total re-write, with better performance, Python 2.x and 3.x compatibility from the ground up, a new, sleek dashboard interface, and more.\n\nThis will remain online as an archived repository only.\n\nAn extremely huge thank-you to @suresttexas00 for maintaining the Wrapper.py project for so long! Wrapper would've been dead in the road long ago if it weren't for you. \n\n# Overview #\n-------------------------------------------\nWrapper.py is an easy to use Minecraft server wrapper for adding extra functionality into the server without modifying \nthe server jar file.  It also comes with a relatively simple and straight-forward - yet powerful - plugin API that can be used\nto create Bukkit-like plugins with no server modding.  The API works best when operated in proxy mode.\n\nWe also have a gitter channel: [![Join the chat at https://gitter.im/benbaptist/minecraft-wrapper](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/benbaptist/minecraft-wrapper?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n###  **Wrapper.py Versions**\n\n - [Master branch \"stable\"](https://github.com/benbaptist/minecraft-wrapper/tree/master):  Stable branch that is only updated with serious bug fixes and major releases. \u003csup id=\"a1\"\u003e[1](#f1)\u003c/sup\u003e\n - [Development branch \"dev\"](https://github.com/benbaptist/minecraft-wrapper/tree/development):  Development branch with newer features.\n\nNOTICE: Wrapper will Accept the minecraft server EULA on your behalf. \u003csup id=\"a2\"\u003e[2](#f2)\u003c/sup\u003e\n\n\n# Features #\n-------------------------------------------\nWrapper.py supports the following features:\n- [Plugin system](/documentation/plugin_api.md) for adding extra features to a vanilla server.\n- Permissions system with group support.\n- Proxy mode operation allows you to add extra bukkit-like functionality to plugins:\n  - Real `/` command interface.\n  - Built in hub worlds / multi-server support!\n    - Use the built-in /hub functionality with world configurations set up in the wrapper config, __or__\n    - Implement your own customized version with the plugin API by calling the player.connect() method.\n  - Limit entity breeding / spawning with entity controls.\n  - Monitor, Modify, and change:\n    - player chat.\n    - player block /digging/placement.\n    - player inventory.\n    - .. and More!\n- Automatic Backups\n  - Automatically delete the oldest backups once you reach a specified number of backups\n  - Specify which folders and files get backed up\n- IRC bridge\n  - Controlling server from IRC\n  - Achievements, deaths, and whatnot appear on IRC\n  - Chat between Minecraft server and IRC channels\n- Scheduled reboots\n- Web remote for controlling the server and the wrapper through your web browser\n- Shell scripts that are called upon certain events (similar to plugin events, but quicker and easier)\n- Minecraft 1.7 and later support\n- Colorized console logging.\n\n\n# Installation #\n\n###  **Python Versions**\n\nPython 3.5 + is suggested,\n***[However...](/documentation/pyversions.md)***\n\n###  **Dependencies**\n\nWrapper.py requires the following packages: \u003c/br\u003e\n- Python packages: `pip, requests, cryptography, bcrypt, setuptools, pkg_resources`\n- Tar is required for backups.\n - ***[More...](/documentation/depends.md)***\n\n\n#### [**LINUX download and setup**](/documentation/linux.md)\n\n#### [**Windows Download and setup**](/documentation/windows.md)\n\n###  **Start Up**\n\nYou only need to download Wrapper.py.  The '\\wrapper' folder is the source code and is just the extracted version\n of Wrapper.py.  Wrapper.py is a Python-executable archive folder containing the sourcecode.\u003c/br\u003e\n\nTo start Wrapper, open a console where the `Wrapper.py` or `/wrapper` sourcecode are\nlocated and type the following into the console to start:\n\n `python Wrapper.py|/wrapper [--passphrase 'passphrase']` \u003csup\u003eThe passphrase must be 8 or more characters in length!\u003c/sup\u003e\n\n#### [Starting Wrapper.py for the first time...](/documentation/first_start.md)\n\nOnce wrapper has started:\n- Open the wrapper.properties.json file and tune the file to your remaining preferences.\n- Tune and setup your server and server.properties accordingly.\n- Restart wrapper.\n\n    ```\n    [15:28:08] [Server thread/INFO]: Starting minecraft server version 1.12.2\n    [15:28:08] [Server thread/INFO]: Loading properties\n     ...\n    [15:28:16] [Server thread/INFO]: Preparing spawn area: 94%\n    [15:28:17] [Server thread/INFO]: Done (7.956s)! For help, type \"help\" or \"?\"\n    [15:28:17] [Wrapper.py/INFO]: Server started\n    [15:28:17] [Wrapper.py/INFO]: Proxy listening on *:25566\n    ```\n\n### Operating wrapper ###\n\n- Any console command beginning with a slash (/) will be interpreted firstly as a Wrapper.py command.\u003cbr\u003e\n- Type /help to see a list of Wrapper.py commands.\u003cbr\u003e\n- To completely shutdown the wrapper, type /halt.\u003c/br\u003e\n\n- To enter passwords into the wrapper.properties.config file, use the `/password` console command to enter the applicable password:\n    `/password Web web-password \u003cnew password\u003e`\n\nPlease read our [Doc page](/documentation/readme.md) for additional information and review the issues page before submitting bug reports.\u003cbr\u003e\nIf you run into any bugs, please _do_ report them!\n\nIf you have questions, please use our [Gitter page](https://gitter.im/benbaptist/minecraft-wrapper) instead of creating an issue.\n\n\n# API #\nThe references for the wrapper plugin API are here:\n[Wrapper.py Plugin API](/documentation/plugin_api.md)\n\n#### New Permissions System ####\n\nA file in the wrapper root directory \"superOPs.txt\" now augments the \"Ops.json\" file.  Operators in the ops.json file can be assigned a higher (wrapper) OP level.  The contents of the file are laid out just like server.properties (lines of \\\u003csomething\\\u003e=\\\u003cvalue\\\u003e).\n\nSample `superops.txt`:\n```\nSuresttexas00=5\nBenBaptist=9\n```\n\nHigher op levels are required to run sensitive wrapper commands like `/perms`.\n\n#### Plugins ####\n\nThe modern event list is updated with each build: [Wrapper events](/documentation/events.rst) \u003csup id=\"a3\"\u003e[3](#f3)\u003c/sup\u003e\n\nCheck the 'example-plugins' and 'stable-plugins' folders to see some example plugins.  These are very useful for seeing how the API functions.\n\n- TEMPLATE.py and EXAMPLE.py are mostly just shells of a plugin to work off of.  They contain useful tutorial comments.\n- zombie.py is a fun test plugin that leaves behind undead versions of people when killed by undead mobs.\n- speedboost.py gives everyone a speedboost when someone dies - similar to survival games.\n- poll.py allows players to vote for certain things on the server. It isn't very up-to-date at the moment, however.\n- Essentials is a plugin loosely based off of Essentials for Bukkit.\n- WorldEdit - is a plugin loosely based on the WorldEdit for Bukkit by sk89q\n- SmallBrother is a lightweight logging plugin based on the old Bukkit plugin, BigBrother\n- Open.py is a plugin that opens a window with nothing.  This plugin was probably just a test plugin and may not work, but contains example code for accessing packets from the player api.\n\n__Tip__:\n\nIf you want to see more error messages and other useful messages while developing plugins or debugging wrapper,\nlook for the logging.json file and make changes to the \"console\" section:\n\n```json\n...\n        \"console\": {\n            \"stream\": \"ext://sys.stdout\",\n            \"formatter\": \"standard\",\n            \"class\": \"logging.StreamHandler\",\n            \"filters\": [\n                \"plugin\"\n            ],\n            \"level\": \"INFO\" \u003c-- Set to DEBUG for more detailed output\n        },\n...\n```\n\u003cbr\u003e\u003cbr\u003e\n\u003csup\u003e\u003cb id=\"f1\"\u003e1\u003c/b\u003e\u003c/sup\u003e - The old stable branch \"master\", version 0.7.6, build 83 has now been archived in the [\"Original\"](https://github.com/benbaptist/minecraft-wrapper/tree/Original) branch. The original\nversion only supports minecraft versions up to 1.8.    [↩](#a1)\n\n\u003csup\u003e\u003cb id=\"f2\"\u003e2\u003c/b\u003e\u003c/sup\u003e - Using wrapper means you also accept the EULA, which will be set to true in the eula.txt file in your server folder. [Mojang EULA](https://account.mojang.com/documents/minecraft_eula)   [↩](#a2)\n\n\u003csup\u003e\u003cb id=\"f3\"\u003e3\u003c/b\u003e\u003c/sup\u003e - The original Event list (Wrapper version 0.7.6) - [0.7.6 Wrapper list of events](https://docs.google.com/spreadsheet/ccc?key=0AoWx24EFSt80dDRiSGVxcW1xQkVLb2dWTUN4WE5aNmc\u0026usp=sharing)   [↩](#a3)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbaptist%2Fminecraft-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenbaptist%2Fminecraft-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbaptist%2Fminecraft-wrapper/lists"}