{"id":22164609,"url":"https://github.com/node-link/minecord","last_synced_at":"2025-07-26T11:31:28.225Z","repository":{"id":57297453,"uuid":"128094822","full_name":"node-link/minecord","owner":"node-link","description":"Connects Minecraft Server and Discord without any mods or plugins.","archived":false,"fork":false,"pushed_at":"2019-01-23T02:54:07.000Z","size":89,"stargazers_count":66,"open_issues_count":1,"forks_count":16,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-11T21:42:55.140Z","etag":null,"topics":["discord","minecraft","minecraft-server"],"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/node-link.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":"2018-04-04T17:12:08.000Z","updated_at":"2024-09-22T03:36:10.000Z","dependencies_parsed_at":"2022-09-02T05:42:02.119Z","dependency_job_id":null,"html_url":"https://github.com/node-link/minecord","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-link%2Fminecord","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-link%2Fminecord/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-link%2Fminecord/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/node-link%2Fminecord/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/node-link","download_url":"https://codeload.github.com/node-link/minecord/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227674020,"owners_count":17802303,"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":["discord","minecraft","minecraft-server"],"created_at":"2024-12-02T05:08:57.458Z","updated_at":"2024-12-02T05:09:02.014Z","avatar_url":"https://github.com/node-link.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Minecord\n===\n\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\u0026maxAge=86400)](LICENSE)\n[![npm](https://img.shields.io/npm/v/minecord.svg?style=flat-square\u0026maxAge=86400)](https://www.npmjs.com/package/minecord)\n[![npm](https://img.shields.io/npm/dt/minecord.svg?style=flat-square)](https://www.npmjs.com/package/minecord)\n\nConnects [Minecraft](https://minecraft.net) Server and [Discord](https://discordapp.com/) without any mods or plugins.\n\n![Minecord](https://raw.githubusercontent.com/wiki/node-link/minecord/images/minecord.gif)\n\n## Installation\n\n```\nnpm install -g minecord\n```\n\n## Usage\n\nIn your Minecraft `server.properties`, make sure you have and restart the server.\n\n```\nenable-rcon=true\nrcon.password=[minecraftRconPassword]\nrcon.port=[minecraftRconPort]\n```\n\nCreate a bot of Discord from [here](https://discordapp.com/developers/applications/me) and get bot token.\n\nThen let the created Bot participate in a specific channel from the OAuth 2 URL Generator.\n\nSet up the `config.json` file.\n\n```json\n{\n  \"pluginsDir\": null,\n  \"enable\": [\n    \"chat\",\n    \"login\",\n    \"death\",\n    \"whitelist\",\n    \"server\"\n  ],\n  \"disable\": [],\n  \"minecraftLog\": \"/var/minecraft/logs/latest.log\",\n  \"minecraftRconHost\": \"localhost\",\n  \"minecraftRconPort\": 25575,\n  \"minecraftRconPassword\": \"password\",\n  \"discordBotToken\": \"bot_token\",\n  \"discordChannel\": \"channel_id\"\n}\n```\n\nIn order to acquire the channel ID, enable developer mode in your Discord client, then right click channel and select \"Copy ID\".\n\nAnd run Minecord.\n\n```\nminecord --config /path/to/config.json\n```\n\nAlternatively, the setting can be given as an option.\n\n```\nminecord --help\n\n  Usage: minecord [options]\n\n  Options:\n\n    -V, --version                         output the version number\n    -c, --config \u003cfile\u003e                   set configuration file\n    -p, --plugins-dir \u003cdir\u003e               set local plugins directory\n    --enable \u003cplugins\u003e                    enable plugin by name, \"--enable PLUGIN1,PLUGIN2\" for multiple plugins\n    --disable \u003cplugins\u003e                   disable plugin by name, \"--disable PLUGIN1,PLUGIN2\" for multiple plugins\n    --minecraft-log \u003cpath\u003e                set the path to Minecraft log (It is recommended to specify them collectively in the configuration file)\n    --minecraft-rcon-host \u003chost\u003e          set the Minecraft Server rcon host (It is recommended to specify them collectively in the configuration file)\n    --minecraft-rcon-port \u003cport\u003e          set the Minecraft Server rcon port (It is recommended to specify them collectively in the configuration file)\n    --minecraft-rcon-password \u003cpassword\u003e  set the Minecraft Server rcon password (It is recommended to specify them collectively in the configuration file)\n    --discord-bot-token \u003ctoken\u003e           set Discord bot token (It is recommended to specify them collectively in the configuration file)\n    --discord-channel \u003cid\u003e                set Discord channel ID for for the discord bot (It is recommended to specify them collectively in the configuration file)\n    -h, --help                            output usage information\n```\n\nIf you are an administrator of the channel of Discord, you can use it more conveniently by unifying Discord's nickname and Minecraft's username.\n\n## Plugins\n\nBy default, the following plugins are included.\n\n* chat : Sharing messages entered by users with Minecraft and Discord on their respective screens. (Default: enable)\n* login : Transfer login notification in Minecraft to Discord. (Default: disable)\n* death : Transfer the dead player notification in Minecraft to Discord. (Default: disable)\n* whitelist : Transfer whitelist operation notification in Minecraft to Discord. (Default: disable)\n* server : Transfer notification of start and stop of Minecraft server to Discord. (Default: disable)\n\n## How to make a plugin\n\nTo load the local plugin, please put the plugin in the directory specified by the `--plugins-dir` option and specify it in the configuration file.\n\nWhen publishing the global plugin, please publish it as `minecord-plugin-[PLUGIN]`.\n\n```js\nexport default Plugin =\u003e new Plugin({\n  discord ({message, channel, user, sendToDiscord, sendToMinecraft}) {\n    // Processing when receiving a message from Discord.\n  },\n  minecraft ({log, time, causedAt, level, message, channel, user, sendToDiscord, sendToMinecraft}) {\n    // Processing when receiving a message from Minecraft.\n  }\n})\n```\n\n### `discord()` method\n\nIt is executed when a message is received from the Discord channel.\n\nArgument `message` is [`Message`](https://discord.js.org/#/docs/main/stable/class/Message) object of [discord.js](https://discord.js.org).\n\nArgument `channel` is [`TextChannel`](https://discord.js.org/#/docs/main/stable/class/TextChannel) object of [discord.js](https://discord.js.org).\n\nArgument `user` is [`User`](https://discord.js.org/#/docs/main/stable/class/User) object of [discord.js](https://discord.js.org).\n\nArgument `sendToDiscord` is [`send`](https://discord.js.org/#/docs/main/stable/class/TextChannel?scrollTo=send) function of [discord.js](https://discord.js.org).\n\nArgument `sendToMinecraft` is `send` function of [node-modern-rcon](https://github.com/levrik/node-modern-rcon).\n\n### `minecraft()` method\n\nIt is executed when new Minecraft log is detected.\n\nArgument `log` is one Minecraft log line.\n\nArgument `time`, `causedAt`, `level` and `message` is the value obtained by parsing the Minecraft log.\n\nFor example, it becomes as follows.\n\n```\n[01:23:45] [Server thread/INFO]: player joined the game\n```\n\n```js\nexport default Plugin =\u003e new Plugin({\n  minecraft ({log, time, causedAt, level, message, channel, user, sendToDiscord, sendToMinecraft}) {\n    console.log(log === '[01:23:45] [Server thread/INFO]: player joined the game')\n    console.log(time === '01:23:45')\n    console.log(causedAt === 'Server thread')\n    console.log(level === 'INFO')\n    console.log(message === 'player joined the game')\n    // All true\n  }\n})\n```\n\nArgument `channel` is [`TextChannel`](https://discord.js.org/#/docs/main/stable/class/TextChannel) object of [discord.js](https://discord.js.org).\n\nArgument `user` is [`User`](https://discord.js.org/#/docs/main/stable/class/User) object of [discord.js](https://discord.js.org).\n\nArgument `sendToDiscord` is [`send`](https://discord.js.org/#/docs/main/stable/class/TextChannel?scrollTo=send) function of [discord.js](https://discord.js.org).\n\nArgument `sendToMinecraft` is `send` function of [node-modern-rcon](https://github.com/levrik/node-modern-rcon).\n\n## Author\n\n[@n0f](https://github.com/n0f)\n\n[![Follow](https://img.shields.io/twitter/follow/n0f.svg?style=social\u0026label=Follow)](https://twitter.com/n0f)\n\n## Contribution\n\nI would be delighted if you rewrite `README.md` in native English!!\n\nOf course, I would be delighted if you point out any problems or improvements related to the program.\n\nOr, I would appreciate it if you increase the number of plugins included by default.\n\nhttps://github.com/node-link/minecord/issues\n\n## Licence\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnode-link%2Fminecord","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnode-link%2Fminecord","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnode-link%2Fminecord/lists"}