{"id":17111024,"url":"https://github.com/yariplus/nodebb-plugin-minecraft-integration","last_synced_at":"2025-07-01T09:05:38.733Z","repository":{"id":25267319,"uuid":"28692692","full_name":"yariplus/nodebb-plugin-minecraft-integration","owner":"yariplus","description":"NodeBB plugin to integrate your forum with your Minecraft Server.","archived":false,"fork":false,"pushed_at":"2018-08-06T00:22:14.000Z","size":1488,"stargazers_count":14,"open_issues_count":28,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-01T09:05:28.404Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/yariplus.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2015-01-01T18:37:13.000Z","updated_at":"2024-11-11T21:15:59.000Z","dependencies_parsed_at":"2022-07-10T12:00:28.586Z","dependency_job_id":null,"html_url":"https://github.com/yariplus/nodebb-plugin-minecraft-integration","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yariplus/nodebb-plugin-minecraft-integration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yariplus%2Fnodebb-plugin-minecraft-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yariplus%2Fnodebb-plugin-minecraft-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yariplus%2Fnodebb-plugin-minecraft-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yariplus%2Fnodebb-plugin-minecraft-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yariplus","download_url":"https://codeload.github.com/yariplus/nodebb-plugin-minecraft-integration/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yariplus%2Fnodebb-plugin-minecraft-integration/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262933261,"owners_count":23386778,"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":[],"created_at":"2024-10-14T16:48:20.411Z","updated_at":"2025-07-01T09:05:38.695Z","avatar_url":"https://github.com/yariplus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NodeBB Minecraft Integration\n\n[![license](https://img.shields.io/github/license/yariplus/nodebb-plugin-minecraft-integration.svg)](https://opensource.org/licenses/MIT)\n[![npm](https://img.shields.io/npm/v/nodebb-plugin-minecraft-integration.svg)](https://www.npmjs.com/package/nodebb-plugin-minecraft-integration)\n[![npm](https://img.shields.io/npm/dm/nodebb-plugin-minecraft-integration.svg)](https://www.npmjs.com/package/nodebb-plugin-minecraft-integration)\n[![Travis](https://img.shields.io/travis/yariplus/nodebb-plugin-minecraft-integration.svg)](https://travis-ci.org/yariplus/nodebb-plugin-minecraft-integration)\n[![Codecov](https://img.shields.io/codecov/c/github/yariplus/nodebb-plugin-minecraft-integration.svg)](https://codecov.io/gh/yariplus/nodebb-plugin-minecraft-integration)\n\n**For support, visit the project's topic on the NodeBB Forums.**\n\n**[https://community.nodebb.org/topic/3559](https://community.nodebb.org/topic/3559 \"NodeBB Forums - Minecraft Integration\")**\n\nThe Minecraft Integration project aims to reproduce and enhance widgets and features found on sites such as Enjin for use on a NodeBB forum.\n\n## Requirements\n\n - A NodeBB forum v0.9.0 or greater.\n - A Minecraft server with the [NodeBB Integration plugin](https://github.com/yariplus/bukkit-plugin-nodebb-integration/releases/ \"Download page for nodebb-integration\") installed.\n\n## Installation\n\nInstall the plugin by using the Install Plugins page on the NodeBB Admin Control Panel.\n\n## Setup\n\n1. After installing the plugin and reloading your NodeBB, go to the **Plugins-\u003eMinecraft Integration** page in the Admin control panel and add a new server, fill out the required info, and save.\n2. Copy the server's API key.\n3. On your Minecraft server console, enter the command `/nodebb key {APIkey}`\n\nThe server will now connect to your forum and send it information every minute or when an event occurs.\n\n### Server Configuration\n\n#### Server Name\nThis name is used by the plugin to identify the server.\n\n#### Server Address\nThis is the address users use in game to connect to the server.\n\n#### API Key\n\nThis key is used to connect your Minecraft server to the forum.\n\n## Widgets\n\n### Server Status Widget\n\nShows MOTD, min/max players, version, online player avatars, and other information about the Minecraft server. Displays everything in a pretty table. Custom rows can be added for things such as Mod Pack downloads, donation links, or any other html you wish to add.\n\n![Server Status Widget Sample Image](http://relm.radiofreederp.com/images/widgetServerStatus.png \"Server Status Widget Sample Image\")\n\n### Mini Map Widget\n\nDisplays a Dynmap or Overviewer mini-map with configurable start location. (World/MapType/Coordinate).\n\n![Dynmap Mini Map Sample Image](http://relm.radiofreederp.com/images/widgetDynmapMiniMap.png \"Dynmap Mini Map Sample Image\")\n\n### Online Players Graph Widget\n\nA graph showing the number of player on the server recently. (Last 30 pings)\n\n![Online Players Graph Sample Image](http://relm.radiofreederp.com/images/widgetOnlinePlayersGraph.png \"Online Players Graph Sample Image\")\n\n### Online Players Grid Widget\n\nA grid of avatars of players currently on the server.\n\n![Online Players Grid Sample Image](http://relm.radiofreederp.com/images/widgetOnlinePlayersGrid.png \"Online Players Grid Sample Image\")\n\n### Top Players List Widget\n\nDisplays user avatars in a list representing the top players' approximate play time.\n\n![Top Players List Sample Image](http://relm.radiofreederp.com/images/widgetTopPlayersList.png \"Top Players List Sample Image\")\n\n### Top Players Graph Widget\n\nA graphic chart (Pie) representing the top players' approximate play time.\n\n![Top Players Graph Sample Image](http://relm.radiofreederp.com/images/widgetTopPlayersGraph.png \"Top Players Graph Sample Image\")\n\n### TPS Graph Widget\n\nA graph showing the servers' recent Ticks per Second.\n\n### Chat Widget\n\nShow the in-game chat in a shoutbox-like widget. Send messages if your forum user is registered.\n\n## Plugin API\n\nOther apps can read data the plugin has collected via it's [API](https://github.com/yariplus/nodebb-plugin-minecraft-integration/wiki/API).\n\n## Features in Development\n\n* Character Profiles - A mini profile for your character.\n* Gallery Widget - A selection of user-uploaded screen-shots.\n* Server Page - A page just for server data.\n* Directory Widget - Display notable character profiles.\n* Ping Graph Widget - Display recent server pings.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyariplus%2Fnodebb-plugin-minecraft-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyariplus%2Fnodebb-plugin-minecraft-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyariplus%2Fnodebb-plugin-minecraft-integration/lists"}