gj-boomlings-api 0.2.0 → 0.3.0

package/README.md

@@ -10,7 +10,7 @@ So basically this function downloads the entire level and converts the response
 
 ```js
 const gd = require("gj-boomlings-api");
-gd.dlLevel(58825144).then(console.log);
+gd.dlLevel(58825144).then(console.log); // returns "xo"
 ```
 
 Returns:
@@ -59,7 +59,7 @@ With this function, you can get somebody's profile info. You can use a player ID
 
 ```js
 const gd = require("gj-boomlings-api");
-gd.getProfile(16).then(console.log);
+gd.getProfile(16).then(console.log); // returns RobTop's info
 ```
 
 Returns:
@@ -86,48 +86,8 @@ Returns:
 }
 ```
 
-### getSongInfo(song)
+Check out [docs](./docs/) for more info.
 
-With this function, you can get an info about a custom song by its ID (but only if it's on Newgrounds).
-
-```js
-const gd = require("gj-boomlings-api");
-gd.getSongInfo(1099128).then(console.log);
-```
-
-Returns:
-
-```
-{
-  name: 'Dynamics',
-  id: 1099128,
-  artist: 'shikoshib',
-  artistId: 10001037,
-  fileSize: '5.74 MB',
-  link: 'https://audio.ngfiles.com/1099000/1099128_Dynamics.mp3?f1640426773'
-}
-```
-
-### getOfficialSongInfo(song)
-
-Basically the same thing as ```getSongInfo()```, but for official songs.
-
-```js
-const gd = require("gj-boomlings-api");
-const song = gd.getOfficialSongInfo(14);
-console.log(song);
-```
-
-Returns:
-
-```
-{
-  name: 'Clubstep',
-  id: 'Level 14',
-  artist: 'DJ-Nate',
-  fileSize: '0 MB',
-  link: 'https://www.newgrounds.com/audio/listen/396093'
-}
-```
+---
 
 Inspired by [GDBrowser](https://github.com/GDColon/GDBrowser/). Thanks to [Wireshark](https://www.wireshark.org/) and [GDDocs](https://github.com/gd-programming/gd.docs/) for helping me in creating this package.

package/config.json

@@ -1 +1 @@
-{"headers":{"Content-Type":"application/x-www-form-urlencoded","user-agent":""}}
+{"headers":{"Content-Type":"application/x-www-form-urlencoded","user-agent":"","Accept-Encoding":"*","Accept":"*/*"},"server":"http://www.boomlings.com/database/"}

package/docs/dlLevel.md

@@ -0,0 +1,52 @@
+# dlLevel()
+
+Downloads a level and decodes it.
+
+## Parameters
+`level` - the level ID.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.dlLevel(58825144).then(console.log);
+```
+
+## Response
+```
+{
+  id: 58825144,
+  name: 'xo',
+  description: 'stream vertigo',
+  creator: 'KrmaL',
+  level_version: 2,
+  difficulty: 'Extreme Demon',
+  stars: 10,
+  downloads: 2587512,
+  likes: 106611,
+  disliked: false,
+  length: 'XL',
+  password: '000007',
+  demon: true,
+  featured: false,
+  epic: false,
+  objects: 37838,
+  uploaded: '2 years',
+  updated: '2 years',
+  stars_requested: 10,
+  game_version: '2.1',
+  ldm: false,
+  copied: 0,
+  two_p: false,
+  coins: 0,
+  verified_coins: false,
+  song: {
+    name: 'XO (Eden Cover & Remake)',
+    id: 766165,
+    artist: 'aaronmusslewhite',
+    artistId: 2130,
+    fileSize: '6.1 MB',
+    link: 'http://audio.ngfiles.com/766000/766165_XO-Eden-Cover-amp-Remake.mp3'
+  }
+}
+```
+Returns a [level object](./objects/level.md).

package/docs/getCommentHistory.md

@@ -0,0 +1,121 @@
+# getCommentHistory()
+
+Gets a comment history from a specified player.
+
+## Parameters
+`user` - the player's username or a player ID.
+`page` (optional) - the page of the comment history. Defaults to 1.
+`mode` (optional) - the mode of fetching the comment history. `1` is the most liked and `0` is the most recent. Defaults to 1.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.getCommentHistory("robtop").then(console.log);
+```
+
+## Response
+```
+[
+  {
+    username: 'RobTop',
+    content: 'Like or dislike this comment, it will add 10 likes either way. Check. Mate.',
+    levelID: 66715392,
+    playerID: 16,
+    likes: 733980,
+    percent: 0,
+    id: 11005139,
+    age: '1 year'
+  },
+  {
+    username: 'RobTop',
+    content: 'Can you handle the Kappa?',
+    levelID: 7485599,
+    playerID: 16,
+    likes: 115556,
+    percent: 0,
+    id: 42602304,
+    age: '5 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'All demons default to hard when first rated, they get the real rating from votes later :)',
+    levelID: 42584142,
+    playerID: 16,
+    likes: 72069,
+    percent: 0,
+    id: 12967791,
+    age: '4 years'
+  },
+  {
+    username: 'RobTop',
+    content: ':)',
+    levelID: 10565740,
+    playerID: 16,
+    likes: 57919,
+    percent: 0,
+    id: 53363972,
+    age: '5 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'Love it :)',
+    levelID: 29424929,
+    playerID: 16,
+    likes: 55456,
+    percent: 0,
+    id: 42731804,
+    age: '5 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'Good enough for me Kappa',
+    levelID: 26681070,
+    playerID: 16,
+    likes: 51795,
+    percent: 1,
+    id: 53375227,
+    age: '5 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'Getting 7 stars doesnt exclude it from the gauntlet competition dont worry :)',
+    levelID: 43908596,
+    playerID: 16,
+    likes: 43546,
+    percent: 0,
+    id: 15614671,
+    age: '4 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'I like this level, you guys prefer newer ones? Almost felt like putting Nine Circles :D',
+    levelID: 17235008,
+    playerID: 16,
+    likes: 38313,
+    percent: 0,
+    id: 61915039,
+    age: '4 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'Kappa',
+    levelID: 19759411,
+    playerID: 16,
+    likes: 37952,
+    percent: 0,
+    id: 22802511,
+    age: '6 years'
+  },
+  {
+    username: 'RobTop',
+    content: 'You know you are getting old when you can only get 2% on an easy demon',
+    levelID: 27690100,
+    playerID: 16,
+    likes: 37144,
+    percent: 2,
+    id: 87255259,
+    age: '1 year'
+  }
+]
+```
+Returns an array of [comment objects](./objects/comment.md).

package/docs/getComments.md

@@ -0,0 +1,111 @@
+# 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/getDailyLevel.md

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,80 @@
+# getGauntlets()
+
+Gets the list of gauntlets and decodes it.
+
+## Parameters
+No parameters!
+
+## 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 gauntlets.
+
+### Properties
+`name` - the gauntlet name.
+`levels` - the array of levels in a gauntlet.

package/docs/getOfficialSongInfo.md

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,36 @@
+# 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

@@ -0,0 +1,26 @@
+# 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/getWeeklyDemon.md

@@ -0,0 +1,17 @@
+# 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/comment.md

@@ -0,0 +1,27 @@
+# Comment object
+
+Used by `getComments()` and `getCommentHistory()`.
+
+## Example
+```
+{
+    username: 'RobTop',
+    content: ':)',
+    levelID: 10565740,
+    playerID: 16,
+    likes: 57919,
+    percent: 0,
+    id: 53363972,
+    age: '5 years'
+}
+```
+
+## Properties
+```username``` - the comment author's username.
+```content``` - the actual content of a comment.
+```levelID``` - the ID of a level, on which the comment was sent.
+```playerID``` - the comment author's player ID.
+```likes``` - the amount of likes on a comment.
+```percent``` - the percentage that has been put on this comment. Returns `0` if the percentage checkbox hadn't been checked.
+```id``` - the ID of a comment.
+```age``` - the age of a comment.

package/docs/objects/level.md

@@ -0,0 +1,70 @@
+# Level object
+
+Used by ```dlLevel()```.
+
+## Example
+```
+{
+  id: 58825144,
+  name: 'xo',
+  description: 'stream vertigo',
+  creator: 'KrmaL',
+  level_version: 2,
+  difficulty: 'Extreme Demon',
+  stars: 10,
+  downloads: 2587512,
+  likes: 106611,
+  disliked: false,
+  length: 'XL',
+  password: '000007',
+  demon: true,
+  featured: false,
+  epic: false,
+  objects: 37838,
+  uploaded: '2 years',
+  updated: '2 years',
+  stars_requested: 10,
+  game_version: '2.1',
+  ldm: false,
+  copied: 0,
+  two_p: false,
+  coins: 0,
+  verified_coins: false,
+  song: {
+    name: 'XO (Eden Cover & Remake)',
+    id: 766165,
+    artist: 'aaronmusslewhite',
+    artistId: 2130,
+    fileSize: '6.1 MB',
+    link: 'http://audio.ngfiles.com/766000/766165_XO-Eden-Cover-amp-Remake.mp3'
+  }
+}
+```
+
+## Properties
+```id``` - the level ID.
+```name``` - the level name.
+```description``` - the level description.
+```creator``` - the level creator.
+```level_version``` - the version of a level.
+```difficulty``` - the level difficulty.
+```stars``` - the amount of stars you get from beating the level.
+```downloads``` - the amount of level downloads.
+```likes``` - the amount of level likes.
+```disliked``` - a boolean that shows if the level is disliked. Returns ```true``` if the like amount is negative, otherwise it's ```false```.
+```length``` - the level length.
+```password``` - the level password. It may return ```'Non-copyable'``` if the level is not copyable, or ```'1'``` if the level is free to copy.
+```demon``` - a boolean that shows if the level is demon.
+```featured``` - a boolean that shows if the level has been featured.
+```epic``` - a boolean that shows if the level is epic-rated.
+```objects``` - the amount of level objects. However, this property has a cap of 65535 objects (it's RobTop's problem).
+```uploaded``` - when the level has been uploaded.
+```updated``` - when the level has been last updated.
+```stars_requested``` - basically how many stars the creator has requested. Returns ```0``` if no stars have been requested.
+```game_version``` - the version required to play the level.
+```ldm``` - a boolean that shows if the level has a "Low Detail Mode" checkbox.
+```copied``` - the original level ID, that got copied. Returns ```0``` if the level is already original.
+```two_p``` - a boolean that shows if the level is in the 2-player mode.
+```coins``` - the amount of coins in the level.
+```verified_coins``` - a boolean that shows if the coins are verified (silver coins).
+```song``` - a [song object](./song.md).

package/docs/objects/song.md

@@ -0,0 +1,23 @@
+# Song object
+
+Used by `getOfficialSongInfo()` and `getSongInfo()`.
+
+## Example
+```
+{
+  name: 'Dynamics',
+  id: 1099128,
+  artist: 'shikoshib',
+  artistId: 10001037,
+  fileSize: '5.74 MB',
+  link: 'https://audio.ngfiles.com/1099000/1099128_Dynamics.mp3?f1640426773'
+}
+```
+
+## Properties
+```name``` - the song name.
+```id``` - the song ID.
+```artist``` - the song artist.
+```artistId``` - the artist's Newgrounds ID.
+```fileSize``` - the size of the song in megabytes, rounded to two decimals.
+```link``` - the link to a file of the song.