{"id":25438879,"url":"https://github.com/obstudio/mc-repeater","last_synced_at":"2025-11-01T08:30:37.046Z","repository":{"id":36432826,"uuid":"223341004","full_name":"obstudio/MC-Repeater","owner":"obstudio","description":"A chat relay between Minecraft server and IRC with no mods.","archived":false,"fork":false,"pushed_at":"2023-01-06T13:21:59.000Z","size":145,"stargazers_count":8,"open_issues_count":6,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-16T18:38:05.938Z","etag":null,"topics":["bot","bot-server","bridge","chat","chatbot","docker","docker-image","koishi","minecraft","minecraft-server","qq","qqbot","zulip","zulip-bot"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/obstudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-22T06:44:48.000Z","updated_at":"2021-12-16T07:14:59.000Z","dependencies_parsed_at":"2023-01-17T01:25:46.680Z","dependency_job_id":null,"html_url":"https://github.com/obstudio/MC-Repeater","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obstudio%2FMC-Repeater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obstudio%2FMC-Repeater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obstudio%2FMC-Repeater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obstudio%2FMC-Repeater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/obstudio","download_url":"https://codeload.github.com/obstudio/MC-Repeater/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239269808,"owners_count":19610870,"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":["bot","bot-server","bridge","chat","chatbot","docker","docker-image","koishi","minecraft","minecraft-server","qq","qqbot","zulip","zulip-bot"],"created_at":"2025-02-17T10:16:29.473Z","updated_at":"2025-11-01T08:30:36.961Z","avatar_url":"https://github.com/obstudio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MC-Repeater\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/20534082/69478424-119c6200-0e2d-11ea-979b-cafd2d1daf49.png\"/\u003e\u003c/p\u003e\n\nA chat relay between Minecraft server and IRC with no mods.\n\n## Features\n\n+ No mods needed\n+ Support Java and Bedrock servers, vanilla and modded servers\n+ Can be run on Windows, Linux and macOS\n\n### Minecraft server support\n\nJava Edition:\n+ [Vanilla Server](https://www.minecraft.net/download/server)\n+ [Paper](https://papermc.io/)\n\nBedrock Edition:\n+ [Bedrock Dedicated Server](https://www.minecraft.net/download/server/bedrock) (Only server start up / shutdown and player join / leave messages)\n\n### Chat bot support\n\n+ [Zulip](https://zulipchat.com/)\n+ [Koishi](https://koishi.js.org/) (for QQ)\n\n### Messages can be forwarded\n\n+ Chat\n+ `/say` message\n+ Server start up / shutdown\n+ Player join / leave\n+ Player death\n+ Achievement\n\n## Usage\n\n1. Install [NodeJS](https://nodejs.org/).\n2. Install MC-Repeater globally using `npm install -g mcrepeater`.\n3. In your Minecraft server directory, create a bash / batch file (e.g. `start.sh` or `start.bat`), then write your Minecraft start command in it. For Java servers, it looks like:\n    ```\n    java -Xmx1024M -Xms1024M -jar server.jar nogui\n    ```\n    For Bedrock servers, it's usually:\n    ```\n    LD_LIBRARY_PATH=. ./bedrock_server\n    ```\n4. Create `config.json` in the same directory and write [configurations](#configurations) in it.\n5. Run MC-Repeater using the command `mcrepeater`. You don't need to start Minecraft server manually because it's automatically started by MC-Repeater.\n\n## Configurations\n\n### Examples\n\nHere's some simple `config.json` examples:\n\n#### Zulip\n\n```json\n{\n  \"serverStart\": \"start.sh\",\n  \"serverType\": \"java\",\n  \"bots\": [\n    {\n      \"botType\": \"zulip\",\n      \"botHost\": \"example-org.example.com\",\n      \"botName\": \"your-bot@example.com\",\n      \"channel\": \"example-stream/example-topic\",\n      \"key\": \"your-bot-api-key\"\n    }\n  ],\n  \"language\": \"en-us\"\n}\n```\n\n#### Koishi\n\n```json\n{\n  \"serverStart\": \"start.sh\",\n  \"serverType\": \"java\",\n  \"bots\": [\n    {\n      \"botType\": \"koishi\",\n      \"botHost\": \"bot.your-host.com\",\n      \"channel\": \"your-channel\",\n      \"key\": \"your-secret-key\"\n    }\n  ],\n  \"language\": \"en-us\"\n}\n```\n\n### Parameters\n\n#### Minecraft server configurations:\n\n+ **serverStart:** Path to your Minecraft server starting bash / batch file.\n+ **serverType:** Type of your server. Can be `java`, `paper` or `bedrock`.\n+ **autoRestart (optional):** A boolean value which determine whether the MC-Repeater will auto restart your server after your server crashed (default: `false`).\n\n#### Chat bot configurations:\n\nAn array for bot configurations:\n+ **botType:** Your bot type which determines how the message will be sent. Can be `zulip` or `koishi` or `local` (for debugging).\n+ **botHost:** Hostname of your bot server.\n+ **botName:** User name of your bot. For Zulip, it's your bot e-mail address. It is not needed for Koishi.\n+ **channel:** The channel you want to send information to. For Zulip, it's `\"example-stream/example-topic\"`.\n+ **key:** The API key or secret key for your bot. Usually provided by your bot server.\n+ **language:** Your language. Currently support `en-us` and `zh-cn`.\n\n#### Network optimization:\n\n+ **throttleInterval (optional):** The minimum interval at which messages are sent (default: `0`).\n+ **offlineTimeout (optional):** The minimum time to determine a player is offline (default: `0`).\n\n#### Custom messages:\n\n+ **customMessage (optional):** Custom messages to override original messages\n\n  Example of `customMessage`:\n\n  ```json\n  \"customMessage\": {\n    \"join\": \"Ob $1 joined the game.\",\n    \"leave\": \"Ob $1 left the game.\",\n    \"advancements\": {\n      \"Diamonds!\": \"Diorites!\"\n    },\n    \"deathReasons\": {\n      \"magic\": \"$1 was killed by mogic!\",\n    },\n    \"mobs\": {\n      \"Ender Dragon\": \"Dragon Bro\"\n    }\n  }\n  ```\n\n#### Message mask:\n\n+ **messageMask (optional):** Block certain type of messages. \n\n  | Message Type | Description                                     |\n  |--------------|-------------------------------------------------|\n  | join         | The message of a player joined the game         |\n  | leave        | The message of a player left the game           |\n  | start        | Server start message                            |\n  | stop         | Server stop message                             |\n  | chat         | Chat message from players                       |\n  | server       | Chat message from the server                    |\n  | advancement  | The message of a player achieved an advancement |\n  | death        | Player death message                            |\n\n  Example of `messageMask`:\n\n  ```json\n  messageMask: [\"join\", \"leave\", \"death\"]\n  ```\n\n## License\n\nLicensed under the [MIT](https://github.com/obstudio/MC-Repeater/blob/master/LICENSE) License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobstudio%2Fmc-repeater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobstudio%2Fmc-repeater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobstudio%2Fmc-repeater/lists"}