gj-boomlings-api 0.4.0 → 1.0.0

package/README.md

@@ -1,5 +1,5 @@
-# gj-boomlings-api
 <div align="center">
+  <a href="https://www.npmjs.com/package/gj-boomlings-api"><img src="https://shikoshib.github.io/font1.png" width="600"></a><hr>
   <a href="https://www.npmjs.com/package/gj-boomlings-api"><img src="https://img.shields.io/npm/v/gj-boomlings-api.svg?maxAge=3600" alt="npm version" /></a>
   <a href="https://www.npmjs.com/package/gj-boomlings-api"><img src="https://img.shields.io/npm/dt/gj-boomlings-api.svg?maxAge=3600" alt="npm downloads" /></a>
   <a href="https://snyk.io/test/github/shikoshib/gj-boomlings-api"><img src="https://snyk.io/test/github/shikoshib/gj-boomlings-api/badge.svg" alt="Known Vulnerabilities" /></a>
@@ -57,7 +57,6 @@ Returns:
   }
 }
 ```
-
 ### getProfile(user)
 
 With this function, you can get somebody's profile info. You can use a player ID (not the account ID) or a name string, it doesn't matter.
@@ -90,8 +89,20 @@ Returns:
   twitch: 'https://twitch.tv/robtopgames'
 }
 ```
+### uploadComment(comment, id, user, password, percent)
+
+You can post comments with this function.
+
+For example,
+```js
+const gd = require("gj-boomlings-api");
+gd.uploadComment("I love gj-boomlings-api!", 83925274, "gmdshxdow", "*********", 99).then(console.log);
+// of course you need to replace the asterisks with your password
+```
+
+Posts a comment on the level with the ID of 83925274, with 99 percent, on gmdshxdow's behalf.
 
-Check out [docs](./docs/) for more info.
+**Check out [docs](./docs/) for more info.**
 
 ---
 

package/config.json

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

package/docs/blockUser.md

@@ -0,0 +1,21 @@
+# blockUser()
+
+Blocks the user.
+
+## Parameters
+`target` - the user that is being blocked.
+
+`user` - the player ID or the username of the user that blocks.
+
+`gjp` - the password of the user that blocks.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.blockUser("colon", "gmdshxdow", "*********").then(console.log);
+```
+
+## Response
+```js
+1
+```

package/docs/deleteAccountPost.md

@@ -0,0 +1,23 @@
+# deleteAccountPost()
+
+Posts a comment to a profile.
+
+## Parameters
+`id` - the account post ID. Returned by `getAccountPosts()`.
+
+`user` - the username or player ID.
+
+`gjp` - the user's password.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.deleteAccountPost("18183557", "gmdshxdow", "*********").then(console.log);
+```
+
+## Response
+```js
+1
+```
+
+Returns `1` if the comment was successfully deleted.

package/docs/getCreatorScores.md

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

@@ -3,7 +3,7 @@
 Gets the list of gauntlets and decodes it.
 
 ## Parameters
-No parameters!
+None!
 
 ## Example
 ```js
@@ -73,7 +73,7 @@ gd.getGauntlets().then(console.log);
   }
 ]
 ```
-This function returns an array of gauntlets.
+This function returns an array of gauntlet objects.
 
 ### Properties
 `name` - the gauntlet name.

package/docs/getLevelByID.md

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

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

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

@@ -0,0 +1,84 @@
+# 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/objects/level.md

@@ -80,7 +80,7 @@ Used by ```dlLevel()```.
 
 ```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.
+```game_version``` - the version required to play the level. Returns `Pre-1.7` if the level has been uploaded or last updated earlier, than 1.7 came out.
 
 ```ldm``` - a boolean that shows if the level has a "Low Detail Mode" checkbox.
 

package/docs/searchLevels.md

@@ -0,0 +1,113 @@
+# searchLevels()
+
+Searches the levels by a specified query.
+
+## Parameters
+`query` - the search string, for example, the level name. If you'll leave it empty, you'll just get the list of most liked levels.
+
+`page` (optional) - the page. Defaults to 1.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.searchLevels("", 2).then(console.log);
+```
+
+## Response
+```
+[
+  {
+    id: 27319926,
+    name: 'through time',
+    description: 'Run... run through time. For you all! Follow me on twitter: @ItsBerkoo',
+    creator: 'Berkoo',
+    level_version: 2,
+    difficulty: 'Normal',
+    stars: 3,
+    downloads: 28632458,
+    likes: 2503368,
+    disliked: false,
+    length: 'Long',
+    demon: false,
+    featured: true,
+    epic: false,
+    objects: 0,
+    stars_requested: 2,
+    game_version: '2.0',
+    copied: 0,
+    two_p: false,
+    coins: 1,
+    verified_coins: true,
+    song: {
+      name: 'Promises',
+      id: 678497,
+      artist: 'KabukiTunes',
+      artistId: 47258,
+      fileSize: '8.23 MB',
+      link: 'http://audio.ngfiles.com/678000/678497_Promises.mp3'
+    }
+  },
+  {
+    id: 28179535,
+    name: 'Acid Factory',
+    description: 'Geometry dash - Poison Gauntlet - Thanks for play! [Acid Factory] 11,000,000 Downloads! <3 ',
+    creator: 'TrinckyFinki',
+    level_version: 3,
+    difficulty: 'Hard',
+    stars: 4,
+    downloads: 51023385,
+    likes: 2446217,
+    disliked: false,
+    length: 'Long',
+    demon: false,
+    featured: true,
+    epic: false,
+    objects: 14193,
+    stars_requested: 3,
+    game_version: '2.1',
+    copied: 28178503,
+    two_p: false,
+    coins: 3,
+    verified_coins: true,
+    song: {
+      name: 'VGMusicRox - Frantic Factory (',
+      id: 550260,
+      artist: 'Viproxi',
+      artistId: 4107,
+      fileSize: '5.94 MB',
+      link: 'http://audio.ngfiles.com/550000/550260_VGMusicRox---Frantic-Facto.mp3'
+    }
+  },
+  {
+    id: 55520,
+    name: 'THE LIGHTNING ROAD',
+    description: 'Removed Coins, ~ Timeless Real / Reduloc',
+    creator: 'timeless real',
+    level_version: 3,
+    difficulty: 'Easy Demon',
+    stars: 10,
+    downloads: 44657564,
+    likes: 2440721,
+    disliked: false,
+    length: 'Long',
+    demon: true,
+    featured: true,
+    epic: false,
+    objects: 3527,
+    stars_requested: 10,
+    game_version: '2.1',
+    copied: 55520,
+    two_p: false,
+    coins: 0,
+    verified_coins: false,
+    song: {
+      name: 'Dry Out',
+      id: 'Level 4',
+      artist: 'DJVI',
+      link: 'https://www.youtube.com/watch?v=FnXabH2q2A0'
+    }
+  },
+...and so on
+```
+
+Returns an array of [level objects](./objects/level.md), sorted by the amount of likes.

package/docs/updateLevelDesc.md

@@ -0,0 +1,23 @@
+# updateLevelDesc()
+
+Updates the description of a level.
+
+## Parameters
+`level` - the level ID.
+
+`description` - the new description of a level.
+
+`user` - the username or player ID.
+
+`gjp` - the user's password.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.updateLevelDesc("83430836", "I love gj-boomlings-api!", "gmdshxdow", "*********").then(console.log);
+```
+
+## Response
+```js
+1
+```

package/docs/uploadAccountPost.md

@@ -12,14 +12,14 @@ Posts a comment to a profile.
 ## Example
 ```js
 const gd = require("gj-boomlings-api");
-gd.uploadAccountPost("i'm a furry", "colon", "*********").then(console.log);
-// basically this function posts the "i'm a furry" message to Colon's profile
+gd.uploadAccountPost("I love gj-boomlings-api!", "gmdshxdow", "*********").then(console.log);
 ```
 
 ## Response
 ```js
 1
 ```
+
 Returns `1` if the comment was successfully posted.
 
 ---

package/docs/uploadComment.md

@@ -0,0 +1,28 @@
+# uploadComment()
+
+Posts a comment to a profile.
+
+## Parameters
+ 
+`content` - the actual comment content.
+
+`id` - the level ID.
+
+`user` - the username or player ID.
+
+`gjp` - the user's password
+
+`percent` (optional) - the comment percentage. Defaults to 0.
+
+## Example
+```js
+const gd = require("gj-boomlings-api");
+gd.uploadComment("I love gj-boomlings-api!", 83925274, "gmdshxdow", "*********", 99).then(console.log);
+```
+
+## Response
+```js
+1
+```
+
+Returns `1` if the comment was successfully posted.