{"id":18460172,"url":"https://github.com/cldfire/mc-server-wrapper","last_synced_at":"2025-08-07T01:32:57.415Z","repository":{"id":40236458,"uuid":"162338287","full_name":"Cldfire/mc-server-wrapper","owner":"Cldfire","description":"Lightweight Minecraft server wrapper binary for Discord chat bridge + enhanced management tools","archived":false,"fork":false,"pushed_at":"2023-10-10T19:24:16.000Z","size":1102,"stargazers_count":21,"open_issues_count":7,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-29T00:56:26.510Z","etag":null,"topics":["cli","discord","discord-bridge","minecraft","minecraft-server","paperspigot","spigot","vanilla-minecraft-server"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cldfire.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-18T19:50:41.000Z","updated_at":"2025-06-26T03:49:15.000Z","dependencies_parsed_at":"2023-10-10T22:43:02.207Z","dependency_job_id":null,"html_url":"https://github.com/Cldfire/mc-server-wrapper","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Cldfire/mc-server-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cldfire%2Fmc-server-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cldfire%2Fmc-server-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cldfire%2Fmc-server-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cldfire%2Fmc-server-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cldfire","download_url":"https://codeload.github.com/Cldfire/mc-server-wrapper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cldfire%2Fmc-server-wrapper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269185585,"owners_count":24374619,"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-08-06T02:00:09.910Z","response_time":99,"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":["cli","discord","discord-bridge","minecraft","minecraft-server","paperspigot","spigot","vanilla-minecraft-server"],"created_at":"2024-11-06T08:25:49.699Z","updated_at":"2025-08-07T01:32:57.363Z","avatar_url":"https://github.com/Cldfire.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mc-server-wrapper\n\n![CI](https://github.com/Cldfire/mc-server-wrapper/workflows/CI/badge.svg)\n[![dependency status](https://deps.rs/repo/github/cldfire/mc-server-wrapper/status.svg)](https://deps.rs/repo/github/cldfire/mc-server-wrapper)\n\nLightweight Rust program to manage a Java Minecraft server process (vanilla, Spigot, or PaperSpigot), providing niceties such as a Discord chat bridge, server restart-on-crash, and improved console output.\n\nThis has been running over top of a small server of mine 24/7 since March 2020 with zero crashes / major issues of any kind. I'd consider it ready for small-scale production usage.\n\n## Features\n\n* Runs on Linux, macOS, and Windows\n* Optionally enabled bi-directional Discord chat bridge (see [Discord Bridge Setup](#discord-bridge-setup))\n    * Commands (prefixed by `!mc`):\n        * `list`: replies with a list of people playing Minecraft\n    * Embeds, mentions, and attachments in Discord messages are neatly formatted in Minecraft\n    * Bot status message displays server info (such as the names of online players)\n* Run server with configurable memory allocation\n    * Also allows passing custom JVM flags if desired\n* Restart server on crash\n* Auto-agree to EULA\n* Improved console output formatting\n\n## Installation\n\n### Downloading\n\nYou can download prebuilt binaries in the [releases section](https://github.com/Cldfire/mc-server-wrapper/releases).\n\n### Building\n\nYou can also build and install from source (requires an up-to-date [Rust](https://www.rust-lang.org) install):\n\n```\ncargo install --git https://github.com/Cldfire/mc-server-wrapper.git --locked\n```\n\n## Usage\n\nGenerate a default config (customize the config path with the `-c` flag if desired):\n\n```\nmc-server-wrapper -g\n```\n\nEdit the config as required, explanation of options below. You can then start the server with the following (if you used the `-c` flag above use it again here):\n\n```\nmc-server-wrapper\n```\n\nRun `mc-server-wrapper --help` for some CLI args to quickly override the config with.\n\n### Config\n\n```toml\n[minecraft]\n# The path to the server jar\nserver_path = \"./server.jar\"\n# The memory in megabytes to allocate for the server\nmemory = 1024\n# If you would like to pass custom flags to the JVM you can do so here\njvm_flags = \"-XX:MaxGCPauseMillis=200\"\n\n# The Discord section is optional\n[discord]\n# Enable or disable the Discord bridge\nenable_bridge = true\n# The Discord bot token\ntoken = \"...\"\n# The Discord channel ID to bridge to\nchannel_id = 123\n# Enable or disable bot status message updates\nupdate_status = true\n\n# Valid log levels: error, warn, info, debug, trace\n#\n# Logging levels set here only affect file logging\n[logging]\n# The log level for general mc-server-wrapper dependencies\nall = \"Warn\"\n# The log level for mc-server-wrapper\nself = \"Debug\"\n# The log level for Discord-related dependencies\ndiscord = \"Info\"\n```\n\n### Discord bridge setup\n\n* Register an application and a bot with [Discord](https://discordapp.com/developers/applications)\n* Enable some things in the `Privileged Gateway Intents` section of the bot's admin portal\n    * Toggle `Server Members Intent` on\n        * This is used to receive member updates from your guild (such as when someone changes their nickname so we can change the name we display in-game)\n    * Toggle `Message Content Intent` on\n        * This is used to receive messsage content from the channel for the chat bridge in Discord so we can relay chat there into Minecraft\n* Add the bot to the guild you want to bridge to\n* Get the ID of the channel you want to bridge to (Google this for instructions)\n* Provide the bot token and channel ID in the config file\n* Enable the Discord bridge in the config file or with the `-b` flag\n\n## Future plans\n\n* Simple web and CLI interface to administrate server\n    * Change most common settings\n    * View online players\n    * Chat from the web\n    * Different levels of accounts (user, admin)\n* _further ideas here_\n\n## Library\n\nThe binary for this project is built on top of a library; if you want to implement a different feature set than the one I've chosen to, or implement the features in a different way, you can easily do so. See the [`mc-server-wrapper-lib` README](mc-server-wrapper-lib/README.md) and its [basic example](mc-server-wrapper-lib/examples/basic.rs) for more.\n\n```\ncargo run --example basic -- path/to/server.jar\n```\n\n## Screenshot\n\nEarly screenshot, subject to change:\n\n![demo screenshot showing off the TUI](tui-demo.png)\n\n#### License\n\n\u003csup\u003e\nLicensed under either of \u003ca href=\"LICENSE-APACHE\"\u003eApache License, Version\n2.0\u003c/a\u003e or \u003ca href=\"LICENSE-MIT\"\u003eMIT license\u003c/a\u003e at your option.\n\u003c/sup\u003e\n\n\u003cbr\u003e\n\n\u003csub\u003e\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in this crate by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n\u003c/sub\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcldfire%2Fmc-server-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcldfire%2Fmc-server-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcldfire%2Fmc-server-wrapper/lists"}