{"id":18186466,"url":"https://github.com/PrismarineJS/node-minecraft-protocol-forge","last_synced_at":"2025-04-02T01:32:19.025Z","repository":{"id":3641974,"uuid":"50305451","full_name":"PrismarineJS/node-minecraft-protocol-forge","owner":"PrismarineJS","description":"Plugin to add FML/Forge client support (including auto-versioning) to node-minecraft-protocol","archived":false,"fork":false,"pushed_at":"2024-03-17T15:14:52.000Z","size":881,"stargazers_count":53,"open_issues_count":16,"forks_count":18,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-30T00:35:37.848Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PrismarineJS.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2016-01-24T20:01:54.000Z","updated_at":"2024-10-12T23:55:27.000Z","dependencies_parsed_at":"2024-01-03T14:14:14.742Z","dependency_job_id":"61912ce7-3670-4cea-8cbe-12750c37eb92","html_url":"https://github.com/PrismarineJS/node-minecraft-protocol-forge","commit_stats":{"total_commits":66,"total_committers":9,"mean_commits":7.333333333333333,"dds":"0.18181818181818177","last_synced_commit":"3a7f0ea49c903ec042ec95f0b60289e096145075"},"previous_names":["deathcap/node-minecraft-protocol-forge"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismarineJS%2Fnode-minecraft-protocol-forge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismarineJS%2Fnode-minecraft-protocol-forge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismarineJS%2Fnode-minecraft-protocol-forge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrismarineJS%2Fnode-minecraft-protocol-forge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrismarineJS","download_url":"https://codeload.github.com/PrismarineJS/node-minecraft-protocol-forge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222295771,"owners_count":16962566,"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-11-03T00:03:03.615Z","updated_at":"2024-11-03T00:03:04.820Z","avatar_url":"https://github.com/PrismarineJS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# minecraft-protocol-forge\n[![NPM version](https://img.shields.io/npm/v/minecraft-protocol-forge.svg)](http://npmjs.com/package/minecraft-protocol-forge)\n[![Join the chat at https://gitter.im/PrismarineJS/node-minecraft-protocol](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg)](https://gitter.im/PrismarineJS/node-minecraft-protocol)\n\nAdds FML/Forge support to [node-minecraft-protocol](https://github.com/PrismarineJS/node-minecraft-protocol) (requires 0.17+)\n\n## Features\n\n* Supports the `FML|HS` client handshake\n* Adds automatic Forge mod detection to node-minecraft-protocol's auto-versioning\n\n## Usage\n\nInstallable as a plugin for use with node-minecraft-protocol:\n\n```javascript\nvar mc = require('minecraft-protocol');\nvar forgeHandshake = require('minecraft-protocol-forge').forgeHandshake;\nvar client = mc.createClient({\n    host: host,\n    port: port,\n    username: username,\n    password: password\n});\n\nforgeHandshake(client, {forgeMods: [\n  { modid: 'mcp', version: '9.18' },\n  { modid: 'FML', version: '8.0.99.99' },\n  { modid: 'Forge', version: '11.15.0.1715' },\n  { modid: 'IronChest', version: '6.0.121.768' }\n]});\n```\n\nThe `forgeMods` option is an array of modification identifiers and versions to present\nto the server. Servers will kick the client if they do not have the required mods.\n\nTo automatically present the list of mods offered by the server, the `autoVersionForge`\nplugin for node-minecraft-protocol's `autoVersion` (activated by `version: false`) can\nbe used:\n\n```javascript\nvar mc = require('minecraft-protocol');\nvar autoVersionForge = require('minecraft-protocol-forge').autoVersionForge;\nvar client = mc.createClient({\n    version: false,\n    host: host,\n    port: port,\n    username: username,\n    password: password\n});\n\nautoVersionForge(client);\n```\n\nThis will automatically install the `forgeHandshake` plugin, with the appropriate mods,\nif the server advertises itself as Forge/FML. Useful for connecting to servers you don't\nknow if they are Forge or not, or what mods they are using.\n\n## Installation\n\n`npm install minecraft-protocol-forge`\n\n## Debugging\n\nYou can enable some protocol debugging output using `NODE_DEBUG` environment variable:\n\n```bash\nNODE_DEBUG=\"minecraft-protocol-forge\" node [...]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPrismarineJS%2Fnode-minecraft-protocol-forge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPrismarineJS%2Fnode-minecraft-protocol-forge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPrismarineJS%2Fnode-minecraft-protocol-forge/lists"}