Skip to content

Latest commit

 

History

History
373 lines (269 loc) · 9.43 KB

Documention.md

File metadata and controls

373 lines (269 loc) · 9.43 KB
Raw

blooket

Documentation for the node.js Blooket library

Documentation

Usage

const Blooket = require('blooket')

const client = new Blooket();

client.joinGame('342865', 'twst', 'Dog')

client.on('Joined', data => {
    console.log(`Joined game with name: ${data.name} \nJoined game with blook: ${data.blook}`)
});

Functions

  • addTokens(tokenAmount, xpAmount, blooketName, blooketAuthToken) - Adds tokens and XP to your account

Parameters:

name description
tokenAmount Amount of tokens you want (max 500 allowed) - Number
xpAmount Amount of XP you want (max 300 allowed) - Number
blooketName Your Blooket account name - String
blooketAuthToken Your auth token is like your login info - String

Example:

const Blooket = require('blooket');

const client = new Blooket();

(async () => {
    const login = await client.login('myEmail@gmail.com', 'myPassword123');
    const authToken = login.token;

    const account = await client.getAccountData(authToken);
    const name = account.name;

    const tokenAmount = 500;
    const xpAmount = 300;

    const addTokens = await client.addTokens(tokenAmount, xpAmount, name, authToken);

    console.log(addTokens);
    console.log('Added ' + tokenAmount + ' tokens and ' + xpAmount + ' XP to your account.');
})();
  • createGame(hostName, isPlus, gameSetId, t_a, gameMode, blooketAuthToken)

Parameters:

name description
hostName Your Blooket Name - String
isPlus Does your Blooket account have plus? - true or false
gameSetId game set Id used to create a game - String
t_a t = Time or a = Amount - Time or Amount
blooketAuthToken Your auth token is like your login info - String

Example:

const Blooket = require('blooket');

const client = new Blooket();

(async () => {
    const login = await client.login('myemail@gmail.com', 'mypasssowrd123');
    const authToken = login.token;

    const account = await client.getAccountData(authToken);

    const hostName = account.name;
    const isPlus = account.plus == "Starter" ? false : true;
    const gameSetId = "600b1491d42a140004d5215a"; //https://www.blooket.com/set/600b1491d42a140004d5215a

    client.createGame(hostName, isPlus, gameSetId, 'Time', 'Gold', authToken);

    client.on('gameCreated', data => {
        console.log('Game created: ' + data.gamePin);
    });
})();
  • createSet(authorName, description, isPrivate, title, blooketAuthToken)

Parameters:

name description
authorName Your Blooket name - String
description Write description about the game set - String
isPrivate Set your game to private - true or false
title Set a title for your game set - String
blooketAuthToken Your auth token is like your login info - String

Example:

const Blooket = require('blooket')

const client = new Blooket();

(async () => {
    const login = await client.login('email', 'passwod');
    const authToken = login.token;

    const account = await client.getAccountData(authToken);

    const author = account.name;
    const desc = 'created from nodejs';
    const isPrivate = false;
    const title = 'created from nodejs';

    const set = await client.createSet(author, desc, isPrivate, title, authToken);

    console.log(set);    
})();
  • favoriteSet(setId, blooketName, blooketAuthToken)

Parameters:

name description
setId Game set Id - String
blooketName Your Blooket account name - String
blooketAuthToken Your auth token is like your login info - String

Example:

const Blooket = require('blooket')

const client = new Blooket();

(async () => {
    const login = await client.login('email', 'password');
    const authToken = login.token;

    const account = await client.getAccountData(authToken);
    
    const name = account.name;

    const setId = "619ffa8f76a076b181439489";
    
    const favorite = await client.favoriteSet(setId, name, authToken);
    
    console.log(favorite);
})();
  • floodGames(gamePin, amount)

Parameters:

name description
gamePin Game pin to join a game - String
amount Amount of bots you want to send - Number

Example:

const Blooket = require('blooket')

const client = new Blooket();

client.floodGames('972506', 100);

client.on('flood', data => {
    console.log('Joined game with name: ' + data.player);
});
  • getAnswers(setId)

Parameters:

name description
setId Game set Id - String

Example:

const Blooket = require('blooket')

const client = new Blooket();

(async () => {
    const gamePin = "198804";

    const game = await client.getGameData(gamePin)

    const set = game.host.set;

    const answers = await client.getAnswers(set);
    
    answers.forEach(answer => {
        console.log(answer);
    });
})();
  • joinGame(gamePin, botName, blook)

Parameters:

name description
gamePin Game pin used to join a game - String
botName Bot name used to join a game - String
blook Blook used to play a game - String

Example:

const Blooket = require('blooket')

const client = new Blooket();

client.joinGame('342865', 'twst', 'Dog')

client.on('Joined', data => {
    console.log(`Joined game with name: ${data.name} \nJoined game with blook: ${data.blook}`)
});
  • login(email, password)

Parameters:

name description
email you can either put your blooket email or username to login - String
password password used to logging into your blooket account - String

Example:

const Blooket = require('blooket')

const client = new Blooket();

(async () => {
    const login = await client.login('myemail@gmail.com', 'MyPassword123');

    console.log(login.token);
})();
  • spamPlayGame(setId, blooketName, blooketAuthToken, amount)

Parameters:

name description
setId Game set Id - String
blooketName Your Blooket account name - String
blooketAuthToken Your auth token is like your login info - String
amount Amount of bots you want to send - Number

Example:

const Blooket = require('blooket')

const client = new Blooket();

(async () => {
    const login = await client.login('email', 'password');
    const authToken = login.token;

    const account = await client.getAccountData(authToken);
    
    const setId = "619ffd8626263900c33b3db8";
    const name = account.name;


    client.spamPlayGame(setId, name, authToken, 100);

    client.on('spamPlays', data => {
        console.log('Played game: ' + data.setId);
    });
})();
  • giveGold(gamePin, playerName)

Parameters:

name description
gamePin Game pin used to join a game with - String
playName Player name to give gold to - String

Note: This function only works for gold quest game mode!

Example:

const Blooket = require('blooket');

const client = new Blooket();

client.giveGold('189789', 'glizzy');

client.on('goldGiven', data => {
    console.log('Gold given to player: ' + data.player);
});
  • stealGold(gamePin, playerName)

Parameters:

name description
gamePin Game pin used to join a game with - String
playName Player name to steal gold from - String

Note: This function only works for gold quest game mode!

Example:

const Blooket = require('blooket');

const client = new Blooket();

client.stealGold('773710', 'glixzzy');

client.on('goldStolen', data => {
    console.log('Gold stolen from player: ' + data.player);
});
  • endGame(gamePin)

Parameters:

name description
gamePin Game pin used to join a game with - String

Note: This function only works for racing game mode!

Example:

const Blooket = require('blooket');

const client = new Blooket();

client.endGame('861432');

client.on('gameEnded', data => {
    console.log('Ended game: ' + data.pin);
});

Events

gameCreated - createGame()

  • Emitted when the client creates a live game.
    • Returns an Object

flood - floodGames()

  • Emitted when the client flood a game.
    • Returns an Object

Joined - joinGame()

  • Emitted when the client joins a game.
    • Returns an Object

spamPlays - spamPlayGame()

  • Emitted when the client spam plays a game.

goldGiven - giveGold()

  • Emitted when the client gives gold to a user.
    • Returns an Object

goldStolen - stealGold()

  • Emitted when the client steal gold from a player.
    • Returns an Object

gameEnded - endGame()

  • Emitted when the client ends a game.
    • Returns an Object