{"id":13846173,"url":"https://github.com/MCSManager/MCSManager","last_synced_at":"2025-07-12T05:32:19.307Z","repository":{"id":37041566,"uuid":"110395561","full_name":"MCSManager/MCSManager","owner":"MCSManager","description":"Free, Secure, Distributed, Modern Control Panel for Minecraft and most Steam Game Servers.","archived":false,"fork":false,"pushed_at":"2024-11-04T05:19:45.000Z","size":48440,"stargazers_count":3289,"open_issues_count":112,"forks_count":368,"subscribers_count":27,"default_branch":"master","last_synced_at":"2024-11-06T00:47:06.159Z","etag":null,"topics":["docker","mcsmanager","minecraft","minecraft-server-software","nodejs","server-web-panel","steam-game-server-manager","webshell"],"latest_commit_sha":null,"homepage":"https://mcsmanager.com","language":"TypeScript","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/MCSManager.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":"MCSManager","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"polar":null,"custom":null}},"created_at":"2017-11-12T01:41:58.000Z","updated_at":"2024-11-05T15:19:05.000Z","dependencies_parsed_at":"2023-11-15T05:31:38.304Z","dependency_job_id":"2dd0a71b-2b3b-4e32-b0e9-e6aa0c1ee0c9","html_url":"https://github.com/MCSManager/MCSManager","commit_stats":null,"previous_names":["suwings/mcsmanager"],"tags_count":74,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MCSManager%2FMCSManager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MCSManager","download_url":"https://codeload.github.com/MCSManager/MCSManager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225720420,"owners_count":17513597,"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","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":["docker","mcsmanager","minecraft","minecraft-server-software","nodejs","server-web-panel","steam-game-server-manager","webshell"],"created_at":"2024-08-04T17:04:33.271Z","updated_at":"2025-07-12T05:32:19.286Z","avatar_url":"https://github.com/MCSManager.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://mcsmanager.com/\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://public-link.oss-cn-shenzhen.aliyuncs.com/mcsm_picture/logo.png\" alt=\"MCSManagerLogo.png\" width=\"510px\" /\u003e    \n  \u003c/a\u003e\n\n  \u003cbr /\u003e\n  \n  \u003ch1 id=\"mcsmanager\"\u003e\n    \u003ca href=\"https://mcsmanager.com/\" target=\"_blank\"\u003eMCSManager Panel\u003c/a\u003e\n  \u003c/h1\u003e\n\n[![--](https://img.shields.io/badge/Support-Windows/Linux-green.svg)](https://github.com/MCSManager)\n[![Status](https://img.shields.io/badge/npm-v8.9.14-blue.svg)](https://www.npmjs.com/)\n[![Status](https://img.shields.io/badge/node-v16.20.2-blue.svg)](https://nodejs.org/en/download/)\n[![Status](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/MCSManager)\n\n[Official Website](http://mcsmanager.com/) | [Docs](https://docs.mcsmanager.com/) | [Discord](https://discord.gg/BNpYMVX7Cd)\n\n[简体中文](README_ZH.md) | [繁體中文](README_TW.md) | [Deutsch](README_DE.md) | [Português BR](README_PTBR.md) |\n[日本語](README_JP.md) | [Spanish](README_ES.md) | [Thai](README_TH.md)\n\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n## What is MCSManager?\n\n**MCSManager Panel** (MCSM) is a **modern, secure, and distributed control panel** designed for managing Minecraft and Steam game servers.\n\nMCSManager has already gained a certain level of popularity within the community, specifically because of Minecraft. MCSManager excels in offering a centralized management solution for multiple server instances and provides a secure and reliable multi-user permission system. In addition, we are committed to support server administrators, not only for Minecraft but also for Terraria and various Steam games. Our goal is to foster a thriving and supportive community for game server management.\n\nMCSManager **supports English, French, German, Italian, Japanese, Portuguese, Simplified Chinese, and Traditional Chinese**, with plans to add support for more languages in the future!\n\n**Terminal**\n\n![failed_to_load_screenshot.png](/.github/panel-image.png)\n\n**Instance List**\n\n![failed_to_load_screenshot.png](/.github/panel-instances.png)\n\n**Custom Layout**\n\n![failed_to_load_screenshot.png](/.github/panel-custom-layout.gif)\n\n## Features\n\n1. One-click deployment of `Minecraft` Java/Bedrock Server\n2. Compatible with most `Steam` game servers. (e.g. `Palworld`, `Squad`, `Project Zomboid`, `Terraria`, etc.)\n3. Customizable UI, create your own layout\n4. Supports all images on `Docker Hub`, supports multiple users and supports commercial services!\n5. Manage multiple servers with a single web interface\n6. The technology stack is simple, and you only need to be good at Typescript to complete the entire MCSManager development.\n7. And More!\n\n\u003cbr /\u003e\n\n## Runtime Environment\n\nMCSM supports both `Windows` and `Linux`. The only requirement is `Node.js` and some libraries **for decompression**.\n\nRequires [Node.js 16.20.2](https://nodejs.org/en) or above.\n\n\u003cbr /\u003e\n\n## Installation\n\n### Windows\n\nFor Windows, we provide packaged executable files:\n\nGo to: [https://mcsmanager.com/](https://mcsmanager.com/)\n\n\u003cbr /\u003e\n\n### Linux\n\n**One-Command Deployment**\n\n\u003e The script needs to register system services and requires root permissions because of that.\n\n```bash\nsudo su -c \"wget -qO- https://script.mcsmanager.com/setup.sh | bash\"\n```\n\n**Usage**\n\n```bash\nsystemctl start mcsm-{web,daemon}\nsystemctl stop mcsm-{web,daemon}\n```\n\n- Only supports Ubuntu/Centos/Debian/Archlinux.\n- Installation directory: `/opt/mcsmanager/`.\n\n\u003cbr /\u003e\n\n**Linux Manual Installation**\n\n- If the installation script fails to execute correctly, you can try to install it manually.\n\n```bash\n# Create /opt directory if not already\nmkdir /opt\n# Switch to /opt\ncd /opt/\n# Download Node.js 20.11. If you already have Node.js 16+ installed, ignore this step.\nwget https://nodejs.org/dist/v20.11.0/node-v20.11.0-linux-x64.tar.xz\n# Decompress Node.js source\ntar -xvf node-v20.11.0-linux-x64.tar.xz\n# Add Node.js to system PATH\nln -s /opt/node-v20.11.0-linux-x64/bin/node /usr/bin/node\nln -s /opt/node-v20.11.0-linux-x64/bin/npm /usr/bin/npm\n\n# Prepare MCSM's installation directory\nmkdir /opt/mcsmanager/\ncd /opt/mcsmanager/\n\n# Download MCSManager\nwget https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz\ntar -zxf mcsmanager_linux_release.tar.gz\n\n# Install dependencies\n./install.sh\n\n# Please open two terminals or screens.\n\n# Start the daemon first.\n./start-daemon.sh\n\n# Start the web interface at the second terminal or screen.\n./start-web.sh\n\n# For web access, go to http://localhost:23333/\n# In general, the web interface will automatically scan and add the local daemon.\n```\n\nThis installation approach does not automatically set up MCSManager as a system service. Therefore, it is necessary to use `screen` for management. For those interested in managing MCSManager through a system service, please refer to our wiki/documentation.\n\n\u003cbr /\u003e\n\n## Development\n\nThis section is specifically designed for developers. General users may disregard this portion without concern.\n\n### Plugins\n\nWe use \"VS Code\" to develop MCSManager. You may need to install these plugins:\n\n- i18n display support (I18n Ally)\n- Code formatter (Prettier)\n- Vue - Offcial\n- ESLint\n\n### MacOS\n\n```bash\ngit clone https://github.com/MCSManager/MCSManager.git\n./install-dependents.sh\n./npm-dev-macos.sh\n```\n\n### Windows\n\n```bash\ngit clone https://github.com/MCSManager/MCSManager.git\n./install-dependents.bat\n./npm-dev-windows.bat\n```\n\n### Dependency Files\n\nYou'll need to go to the [PTY](https://github.com/MCSManager/PTY) and [Zip-Tools](https://github.com/MCSManager/Zip-Tools) projects to download the corresponding binary files and place them in the `daemon/lib` directory to ensure the proper functioning of the `Emulation Terminal` and `File Decompression`.\n\n### Build Production Version\n\n```bash\n./build.bat # Windows\n./build.sh  # MacOS\n```\n\nOutput Directory: \"production-code\"\n\n\u003cbr /\u003e\n\n## Code Contributing\n\nIf you experience any problems while using MCSManager, you are welcome to [submit an Issue](https://github.com/MCSManager/MCSManager/issues/new/choose). Alternatively, you can fork the project and contribute directly by submitting a Pull Request.\n\nPlease ensure that any submitted code adheres to our existing coding style. For more details, refer to the guidelines provided in [this issue](https://github.com/MCSManager/MCSManager/issues/544).\n\n\u003cbr /\u003e\n\n## Browser Compatibility\n\n- Supported on modern browsers including `Chrome`, `Firefox`, and `Safari`.\n- Support for `IE` has been discontinued.\n\n\u003cbr /\u003e\n\n## BUG Reporting\n\n**Open Issue:** [Click here](https://github.com/MCSManager/MCSManager/issues/new/choose)\n\n**Security Vulnerability Report:** [SECURITY.md](SECURITY.md)\n\n\u003cbr /\u003e\n\n## Internationalization\n\nThanks to these contributors for providing a substantial amount of translation:\n\n- [KevinLu2000](https://github.com/KevinLu2000)\n- [Yumao](https://github.com/yumao233)\n- [JHL-HK](https://github.com/jhl-hk)\n- [IceBrick](https://github.com/IceBrick01)\n\n\u003cbr /\u003e\n\n## License\n\nThe source code of MCSManager is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) License.\n\nCopyright ©2025 MCSManager.\n","funding_links":["https://patreon.com/MCSManager"],"categories":["docker","TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMCSManager%2FMCSManager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMCSManager%2FMCSManager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMCSManager%2FMCSManager/lists"}