Code Monkey home page Code Monkey logo

node-minecraft-protocol-forge's Introduction

minecraft-protocol-forge

NPM version Join the chat at https://gitter.im/PrismarineJS/node-minecraft-protocol

Adds FML/Forge support to node-minecraft-protocol (requires 0.17+)

Features

  • Supports the FML|HS client handshake
  • Adds automatic Forge mod detection to node-minecraft-protocol's auto-versioning

Usage

Installable as a plugin for use with node-minecraft-protocol:

var mc = require('minecraft-protocol');
var forgeHandshake = require('minecraft-protocol-forge').forgeHandshake;
var client = mc.createClient({
    host: host,
    port: port,
    username: username,
    password: password
});

forgeHandshake(client, {forgeMods: [
  { modid: 'mcp', version: '9.18' },
  { modid: 'FML', version: '8.0.99.99' },
  { modid: 'Forge', version: '11.15.0.1715' },
  { modid: 'IronChest', version: '6.0.121.768' }
]});

The forgeMods option is an array of modification identifiers and versions to present to the server. Servers will kick the client if they do not have the required mods.

To automatically present the list of mods offered by the server, the autoVersionForge plugin for node-minecraft-protocol's autoVersion (activated by version: false) can be used:

var mc = require('minecraft-protocol');
var autoVersionForge = require('minecraft-protocol-forge').autoVersionForge;
var client = mc.createClient({
    version: false,
    host: host,
    port: port,
    username: username,
    password: password
});

autoVersionForge(client);

This will automatically install the forgeHandshake plugin, with the appropriate mods, if the server advertises itself as Forge/FML. Useful for connecting to servers you don't know if they are Forge or not, or what mods they are using.

Installation

npm install minecraft-protocol-forge

Debugging

You can enable some protocol debugging output using NODE_DEBUG environment variable:

NODE_DEBUG="minecraft-protocol-forge" node [...]

node-minecraft-protocol-forge's People

Contributors

danielpmc avatar deathcap avatar dependabot-preview[bot] avatar murilopereirame avatar mykola1453 avatar rob9315 avatar rom1504 avatar rom1504bot avatar wondermine avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.