PartyDistrib 1.0.0

Party manager and logger

This program is a simple party manager and logger.

It is designed to be used in a mini browser game server.

Features

• Create a party which will be saved in a text file with all users ids
• Delete a party
• Add a user to a party
• Remove a user from a party
• Get all users of a party
• Get all parties

How to use

Import the library

First, install it

    npm install partydistrib

Then, import it in you server.js file

const PartyDistrib = require("partydistrib");
let myPartyDistrib = new PartyDistrib();

Create a party

const PartyDistrib = require("partydistrib");
let myPartyDistrib = new PartyDistrib();
let generateId = myPartyDistrib.utils.generateId;

let party = myPartyDistrib.createParty(generateId());

Delete a party

const PartyDistrib = require("partydistrib");
let myPartyDistrib = new PartyDistrib();

myPartyDistrib.deleteParty("partyId");

Add a user to a party

// let party = myPartyDistrib.createParty(generateId());

let user1 = myPartyDistrib.createUser("user1");
let user2 = myPartyDistrib.createUser("user2");

user1.joinParty(party);
user2.joinParty(party);

Remove a user from a party

// let party = myPartyDistrib.createParty(generateId());
// let user1 = myPartyDistrib.createUser("user1");

party.leave(user);

Party is automatically deleted when there is no user in it

Get all users of a party

// let party = myPartyDistrib.createParty(generateId());

let users = party.getUsers(); // returns an array of string with all users ids

console.log(users);

Get all parties

let parties = myPartyDistrib.getParties(); // returns an array of string with all parties ids

console.log(parties);

Get a party

let party = myPartyDistrib.getParty("partyId");

Utils

Generate an id

let generateId = myPartyDistrib.utils.generateId;
let id = generateId();
console.log(id);

Authors

Author: