gj-boomlings-api 1.2.3 → 1.3.0

package/docs/getComments.md

@@ -1,113 +0,0 @@
-# getComments()
-
-Gets a list of comments from a specified level.
-
-## Parameters
-`level` - the level whose comments we want to check.
-
-`page` (optional) - the page of the comments. Defaults to 1.
-
-`mode` (optional) - the mode of fetching the comments. `1` is the most liked and `0` is the most recent. Defaults to 1.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getComments(42584142).then(console.log);
-```
-
-## Response
-```
-[
-  {
-    username: 'RobTop',
-    content: 'All demons default to hard when first rated, they get the real rating from votes later :)',
-    playerID: 16,
-    likes: 72069,
-    percent: 0,
-    id: 12967791,
-    age: '4 years'
-  },
-  {
-    username: 'Knobbelboy',
-    content: 'IT IS FINALLY OVER!!!!!!!!!!!!!! THIS IS IT!!! THANK YOU ALL!!!!',
-    playerID: 4214375,
-    likes: 71760,
-    percent: 0,
-    id: 12958654,
-    age: '4 years'
-  },
-  {
-    username: 'shaggy23',
-    content: 'Zobros: Easy Insane 9',
-    playerID: 1995959,
-    likes: 31953,
-    percent: 0,
-    id: 12968377,
-    age: '4 years'
-  },
-  {
-    username: 'IInfinityy',
-    content: "pro tip : don't play bloodlust on phone",
-    playerID: 15630652,
-    likes: 30194,
-    percent: 1,
-    id: 12960792,
-    age: '4 years'
-  },
-  {
-    username: 'RobTop',
-    content: '1% :O :O :O :O',
-    playerID: 16,
-    likes: 29497,
-    percent: 0,
-    id: 16183012,
-    age: '4 years'
-  },
-  {
-    username: 'AdvyStyles',
-    content: 'ok',
-    playerID: 2434963,
-    likes: 16910,
-    percent: 0,
-    id: 13190982,
-    age: '4 years'
-  },
-  {
-    username: 'SerSerpent',
-    content: 'Guess now Knobbelboy evolved to Knobbelman',
-    playerID: 19203596,
-    likes: 15362,
-    percent: 0,
-    id: 12962171,
-    age: '4 years'
-  },
-  {
-    username: 'GDWindex',
-    content: 'Pass is 121296, now like this comment so others can see',
-    playerID: 78434904,
-    likes: 14567,
-    percent: 0,
-    id: 13250862,
-    age: '4 years'
-  },
-  {
-    username: 'Juniper',
-    content: 'PRESS F TO RESPECT THE H*CK OUT OF KNOBBELBOY',
-    playerID: 2614903,
-    likes: 14115,
-    percent: 0,
-    id: 12970170,
-    age: '4 years'
-  },
-  {
-    username: 'lSunix',
-    content: 'aoc',
-    playerID: 14251090,
-    likes: 6437,
-    percent: 100,
-    id: 14252314,
-    age: '4 years'
-  }
-]
-```
-Returns an array of [comment objects](./objects/comment.md).

package/docs/getCreatorScores.md

@@ -1,60 +0,0 @@
-# getCreatorScores()
-
-Gets the top 100 creators leaderboard, sorted by creator points.
-
-## Parameters
-None!
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getCreatorScores().then(console.log);
-```
-
-## Response
-```
-[
-  {
-    username: 'YunHaSeu14',
-    playerID: 36314,
-    accountID: 1187377,
-    rank: 1,
-    stars: 33615,
-    diamonds: 68501,
-    secretCoins: 121,
-    userCoins: 9431,
-    demons: 123,
-    creatorPoints: 290
-  },
-  {
-    username: 'ViPriN',
-    playerID: 1078150,
-    accountID: 2795,
-    rank: 2,
-    stars: 29533,
-    diamonds: 28327,
-    secretCoins: 149,
-    userCoins: 3256,
-    demons: 1026,
-    creatorPoints: 281
-  },
-  {
-    username: 'Serponge',
-    playerID: 4170784,
-    accountID: 119741,
-    rank: 3,
-    stars: 85,
-    diamonds: 17,
-    secretCoins: 0,
-    userCoins: 5,
-    demons: 1,
-    creatorPoints: 234
-  }
-...and so on
-```
-
-This function returns an array of [user objects](./objects/user.md).
-
----
-
-**NOTE:** Here, the users' rank is their actual position on the leaderboard.

package/docs/getDailyLevel.md

@@ -1,17 +0,0 @@
-# getDailyLevel()
-
-Downloads a daily level and decodes it.
-
-## Parameters
-No parameters!
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getDailyLevel().then(console.log);
-```
-
-## Response
-Returns a [level object](./objects/level.md). 
-
-Basically it's same thing as `dlLevel()`, but for daily levels.

package/docs/getGauntlets.md

@@ -1,81 +0,0 @@
-# getGauntlets()
-
-Gets the list of gauntlets and decodes it.
-
-## Parameters
-None!
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getGauntlets().then(console.log);
-```
-
-## Response
-```
-[
-  {
-    name: 'Fire Gauntlet',
-    levels: [ '27732941', '28200611', '27483789', '28225110', '27448202' ]
-  },
-  {
-    name: 'Ice Gauntlet',
-    levels: [ '20635816', '28151870', '25969464', '24302376', '27399722' ]
-  },
-  {
-    name: 'Poison Gauntlet',
-    levels: [ '28179535', '29094196', '29071134', '26317634', '12107595' ]
-  },
-  {
-    name: 'Shadow Gauntlet',
-    levels: [ '26949498', '26095850', '27973097', '27694897', '26070995' ]
-  },
-  {
-    name: 'Lava Gauntlet',
-    levels: [ '18533341', '28794068', '28127292', '4243988', '28677296' ]
-  },
-  {
-    name: 'Bonus Gauntlet',
-    levels: [ '28255647', '27929950', '16437345', '28270854', '29394058' ]
-  },
-  {
-    name: 'Chaos Gauntlet',
-    levels: [ '25886024', '4259126', '26897899', '7485599', '19862531' ]
-  },
-  {
-    name: 'Demon Gauntlet',
-    levels: [ '18025697', '23189196', '27786218', '27728679', '25706351' ]
-  },
-  {
-    name: 'Time Gauntlet',
-    levels: [ '40638411', '32614529', '31037168', '40937291', '35165900' ]
-  },
-  {
-    name: 'Crystal Gauntlet',
-    levels: [ '37188385', '35280911', '37187779', '36301959', '36792656' ]
-  },
-  {
-    name: 'Magic Gauntlet',
-    levels: [ '37269362', '29416734', '36997718', '39853981', '39853458' ]
-  },
-  {
-  {
-    name: 'Monster Gauntlet',
-    levels: [ '43908596', '41736289', '42843431', '44063088', '44131636' ]
-  },
-  {
-    name: 'Doom Gauntlet',
-    levels: [ '38427291', '38514054', '36966088', '38398923', '36745142' ]
-  },
-  {
-    name: 'Death Gauntlet',
-    levels: [ '44121158', '43923301', '43537990', '33244195', '35418014' ]
-  }
-]
-```
-This function returns an array of gauntlet objects.
-
-### Properties
-`name` - the gauntlet name.
-
-`levels` - the array of levels in a gauntlet.

package/docs/getLevelByID.md

@@ -1,51 +0,0 @@
-# getLevelByID()
-
-Gets the basic info about the level by its ID.
-
-## Parameters
-`level` - the level ID.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getLevelByID(11940).then(console.log);
-```
-
-## Response
-```
-{
-  id: 11940,
-  name: 'Level Easy',
-  description: 'Cody',
-  creator: '-',
-  level_version: 1,
-  difficulty: 'Normal',
-  stars: 3,
-  downloads: 66447749,
-  likes: 3781481,
-  disliked: false,
-  length: 'Long',
-  demon: false,
-  featured: true,
-  epic: false,
-  objects: 0,
-  stars_requested: 0,
-  game_version: 'Pre-1.7',
-  copied: 0,
-  two_p: false,
-  coins: 0,
-  verified_coins: false,
-  song: {
-    name: 'Stereo Madness',
-    id: 'Level 1',
-    artist: 'ForeverBound',
-    link: 'https://www.youtube.com/watch?v=JhKyKEDxo8Q'
-  }
-}
-```
-
-Returns a [level object](./objects/level.md).
-
----
-
-**NOTE:** This is pretty much the same thing as `dlLevel()`, but `getLevelByID()` doesn't provide the password, update and upload date and the LDM checkbox. On the other hand, it's much faster (especially for object-heavy levels).

package/docs/getMapPacks.md

@@ -1,88 +0,0 @@
-# getMapPacks()
-
-Gets the list of map packs and decodes it.
-
-## Parameters
-`page` (optional) - the page of the map packs list. Defaults to 1.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getMapPacks(2).then(console.log);
-```
-
-## Response
-```
-[
-  {
-    name: 'Ruby Pack',
-    levels: [ 1446958, 1063115, 1734354 ],
-    stars: 4,
-    coins: 1
-  },
-  {
-    name: 'Electro Pack',
-    levels: [ 5131543, 8157377, 8571598 ],
-    stars: 4,
-    coins: 1
-  },
-  {
-    name: 'Laser Pack',
-    levels: [ 12178580, 11357573, 11591917 ],
-    stars: 4,
-    coins: 1
-  },
-  {
-    name: 'Glow Pack',
-    levels: [ 4449079, 6979485, 10110092 ],
-    stars: 4,
-    coins: 1
-  },
-  {
-    name: 'Spirit Pack',
-    levels: [ 13766381, 13242284, 13963465 ],
-    stars: 4,
-    coins: 1
-  },
-  {
-    name: 'Hard Pack',
-    levels: [ 217631, 3785, 281148 ],
-    stars: 5,
-    coins: 1
-  },
-  {
-    name: 'Morph Pack',
-    levels: [ 364445, 411459, 509393 ],
-    stars: 5,
-    coins: 1
-  },
-  {
-    name: 'Phoenix Pack',
-    levels: [ 674454, 750434, 835854 ],
-    stars: 5,
-    coins: 1
-  },
-  {
-    name: 'Power Pack',
-    levels: [ 809579, 741941, 577710 ],
-    stars: 5,
-    coins: 1
-  },
-  {
-    name: 'Shiny Pack',
-    levels: [ 980341, 1541962, 1160937 ],
-    stars: 5,
-    coins: 1
-  }
-]
-```
-This function returns an array of map pack objects.
-
-### Properties
-`name` - the map pack name.
-
-`levels` - the array of levels in a map pack.
-
-`stars` - the amount of stars you get from beating the map pack.
-
-`coins` - the amount of coins you get from beating the map pack.

package/docs/getOfficialSongInfo.md

@@ -1,25 +0,0 @@
-# getOfficialSongInfo()
-
-Gets an info about an official song by its ID.
-
-## Parameters
-`song` - the official song ID.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-const song = gd.getOfficialSongInfo(14);
-console.log(song);
-```
-
-## Response
-```
-{
-  name: 'Clubstep',
-  id: 'Level 14',
-  artist: 'DJ-Nate',
-  link: 'https://www.newgrounds.com/audio/listen/396093'
-}
-```
-
-Returns a [song object](./objects/song.md), except for the `artistId` and `fileSize` properties.

package/docs/getProfile.md

@@ -1,36 +0,0 @@
-# getProfile()
-
-Gets someone's profile and decodes it.
-
-## Parameters
-`user` - the player's username or a player ID.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getProfile("robtop").then(console.log);
-```
-
-## Response
-```
-{
-  username: 'RobTop',
-  playerID: 16,
-  accountID: 71,
-  rank: 219796,
-  stars: 2375,
-  diamonds: 2170,
-  secretCoins: 3,
-  userCoins: 140,
-  demons: 5,
-  creatorPoints: 0,
-  messages: 'none',
-  friendRequests: 'none',
-  commentHistory: 'all',
-  mod: 'elder',
-  youtube: 'https://youtube.com/channel/UCz_yk8mDSAnxJq0ar66L4sw',
-  twitter: 'https://twitter.com/RobTopGames',
-  twitch: 'https://twitch.tv/robtopgames'
-}
-```
-Returns a [user object](./objects/user.md).

package/docs/getSongInfo.md

@@ -1,26 +0,0 @@
-# getSongInfo()
-
-Gets a song on Newgrounds by its ID and returns info about it.
-
-## Parameters
-`song` - the song ID.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getSongInfo(1099128).then(console.log);
-```
-
-## Response
-```
-{
-  name: 'Dynamics',
-  id: 1099128,
-  artist: 'shikoshib',
-  artistId: 10001037,
-  fileSize: '5.74 MB',
-  link: 'https://audio.ngfiles.com/1099000/1099128_Dynamics.mp3?f1640426773'
-}
-```
-
-Returns a [song object](./objects/song.md).

package/docs/getTop100.md

@@ -1,56 +0,0 @@
-# getTop100()
-
-Gets the top 100 players leaderboard, sorted by stars.
-
-## Parameters
-None!
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getTop100().then(console.log);
-```
-
-## Response
-```
-[
-  {
-    username: 'Smiffy777',
-    playerID: 7708568,
-    accountID: 1413859,
-    rank: 1,
-    stars: 227040,
-    diamonds: 156320,
-    secretCoins: 149,
-    userCoins: 45920,
-    demons: 5581,
-    creatorPoints: 0
-  },
-  {
-    username: 'Gormuck',
-    playerID: 8247386,
-    accountID: 1775477,
-    rank: 2,
-    stars: 222121,
-    diamonds: 166422,
-    secretCoins: 149,
-    userCoins: 28509,
-    demons: 5050,
-    creatorPoints: 2
-  },
-  {
-    username: 'volplay',
-    playerID: 14188128,
-    accountID: 5189757,
-    rank: 3,
-    stars: 221320,
-    diamonds: 121349,
-    secretCoins: 149,
-    userCoins: 25076,
-    demons: 5291,
-    creatorPoints: 2
-  }
-...and so on
-```
-
-This function returns an array of [user objects](./objects/user.md).

package/docs/getUserLevels.md

@@ -1,84 +0,0 @@
-# getUserLevels()
-
-Gets the list of levels made by a specified user.
-
-## Parameters
-`user` - the user's username or a player ID.
-
-`page` (optional) - the page. Defaults to 1.
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getUserLevels("shikoshib", 2).then(console.log);
-```
-
-## Response
-```
-[
-  {
-    id: 79650761,
-    name: 'Lost or Not',
-    description: "I'm going to make a level trilogy with my own song. Part 2 soon!",
-    creator: 'shikoshib',
-    level_version: 1,
-    difficulty: 'Harder',
-    stars: 0,
-    downloads: 139,
-    likes: 13,
-    disliked: false,
-    length: 'Long',
-    demon: false,
-    featured: false,
-    epic: false,
-    objects: 12020,
-    stars_requested: 6,
-    game_version: '2.1',
-    copied: 0,
-    two_p: false,
-    coins: 3,
-    verified_coins: false,
-    song: {
-      name: 'Not Lost',
-      id: 1107430,
-      artist: 'shikoshib',
-      artistId: 10001037,
-      fileSize: '8.5 MB',
-      link: 'https://audio.ngfiles.com/1107000/1107430_Not-Lost.mp3?f1643365615'
-    }
-  },
-  {
-    id: 76643578,
-    name: 'Ok Just Get It',
-    description: 'pass 2305',
-    creator: 'shikoshib',
-    level_version: 1,
-    difficulty: 'Harder',
-    stars: 0,
-    downloads: 96,
-    likes: 13,
-    disliked: false,
-    length: 'Long',
-    demon: false,
-    featured: false,
-    epic: false,
-    objects: 4568,
-    stars_requested: 2,
-    game_version: '2.1',
-    copied: 0,
-    two_p: false,
-    coins: 0,
-    verified_coins: false,
-    song: {
-      name: 'F-777 - Medusa',
-      id: 798747,
-      artist: 'F-777',
-      artistId: 286,
-      fileSize: '7.39 MB',
-      link: 'https://audio.ngfiles.com/798000/798747_F-777---Medusa.mp3?f1522612006'
-    }
-  }
-]
-```
-
-Returns an array of [level objects](./objects/level.md).

package/docs/getWeeklyDemon.md

@@ -1,17 +0,0 @@
-# getWeeklyDemon()
-
-Downloads a weekly demon and decodes it.
-
-## Parameters
-No parameters!
-
-## Example
-```js
-const gd = require("gj-boomlings-api");
-gd.getWeeklyDemon().then(console.log);
-```
-
-## Response
-Returns a [level object](./objects/level.md). 
-
-Basically it's same thing as `dlLevel()`, but for weekly demons.

package/docs/objects/acc_comment.md

@@ -1,19 +0,0 @@
-# Account comment object
-
-Used by `getAccountPosts()`.
-
-## Example
-```
-{
-    content: "Thank you everyone for the birthday wishes. You're the best! :)",
-    likes: 97911,
-    age: '10 months'
-}
-```
-
-## Properties
-```content``` - the actual content of a comment.
-
-```likes``` - the amount of likes on a comment.
-
-```age``` - the age of a comment.