1 | [![npm](https://img.shields.io/npm/v/blocksmc.svg)](https://www.npmjs.com/package/blocksmc)
|
2 | [![install size](https://packagephobia.now.sh/badge?p=blocksmc)](https://packagephobia.now.sh/result?p=blocksmc)
|
3 | ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/blocksmc.svg)
|
4 |
|
5 |
|
6 | [![NPM](https://nodei.co/npm/blocksmc.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/blocksmc/)
|
7 |
|
8 |
|
9 | # BlocksMC
|
10 | A simple scraper & wrapper for BlocksMC!
|
11 |
|
12 | ## Instalation
|
13 | ```js
|
14 | npm i blocksmc
|
15 | // or
|
16 | yarn add blocksmc
|
17 | ```
|
18 |
|
19 | ## Example Usage
|
20 | ```js
|
21 | const { Blocks } = require('blocksmc');
|
22 | const blocks = new Blocks();
|
23 |
|
24 | blocks.player('iAbady').then(player => {
|
25 | console.log(player.games.map(g => `${g.game} ${g.stats.Deaths}`))
|
26 | console.log(player.rank)
|
27 | console.log(player.timePlayed)
|
28 | });
|
29 |
|
30 | blocks.top('sky-wars').then(leader => {
|
31 | console.log(leader);
|
32 | })
|
33 | ```
|
34 |
|
35 | ## Response Example
|
36 |
|
37 | ### `Player`
|
38 | ```js
|
39 | player(username) -->
|
40 | rank: String,
|
41 | timePlayed: String,
|
42 | games: [
|
43 | {
|
44 | game: String,
|
45 | stats: {
|
46 | Points: Number,
|
47 | Wins: Number,
|
48 | Played: Number,
|
49 | Eggs?: Number,
|
50 | Blocks?: Number,
|
51 | Kills?: Number,
|
52 | FireWorks?: Number,
|
53 | Crates?: Number,
|
54 | DMs?: Number,
|
55 | Sponges?: Number,
|
56 | Beds?: Number,
|
57 | Rounds?: Number,
|
58 | Goals?: Number,
|
59 | }
|
60 | }
|
61 | ]
|
62 | ```
|
63 |
|
64 | ### `TOP`
|
65 | ```js
|
66 | top(game) --> Array
|
67 | ```
|