Git Product home page Git Product logo

mcserverstatus's Introduction

mcserverstatus

A javascript function for checking changes in a minecraft server's list of players without using query or a custom plugin.

Usage

mcstatus(options,callback)

Options can be an object:

var options = {
  name: 'name',
  ip: 'ip'
}

Or an array of objects:

var options = [
  {
    name: 'name1',
    ip: 'ip1'
  },
  {
    name: 'name2',
    ip: 'ip2'
  }
]

Example:

var mcstatus = require('mcserverstatus').mcstatus; // only include if using npm

mcstatus({
  name: 'senious survival', // can be anything
  ip: 'senious.mcph.co' // the IP of the server
}, function response(response) {
  console.log(response);
});

If used in an interval, it will return the current players only once and then return consecutive join and leave messages.

setInterval(function(){
  mcstatus({
    name: 'name',
    ip: 'ip'
  },function(response){
    console.log(response);
  });
},1000);

Response:

When first ran it returns:

Currently [list of players] are playing on [server name].

Then if a player joins the server and the function is run again:

[playername] joined [server name]. Now there are [current players]/[max players] on the server, including [list of players].

Install

With npm:

npm install mcserverstatus

Without npm:

<script src="https://rawgit.com/arcusdevteam/mcserverstatus/master/mcstatus.min.js"></script>

mcserverstatus's People

Contributors

jdtzmn avatar

Watchers

James Cloos avatar Sam Daitzman 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.