Discord server

# Discord-Xp - A lightweight and easy to use xp framework for discord bots, uses MongoDB. - If you need help feel free to join our discord server to talk and help you with your code. - If you encounter any of those fell free to open an issue in our github repository. # Download & Update You can download it from npm: ```cli npm i discord-xp ``` You can update to a newer version to receive updates using npm. ```cli npm update discord-xp ``` # Changelog - **27 May 2021** (v1.1.11) - Adding deleteGuild() method. - **3 April 2021** (v1.1.11) - Adding TS typings. - **25 February 2021** (v1.1.8) - Preventing further deprection warnings to be displayed, if you encounter any of these deprecation issues, update the module. - **22 November 2020** (v1.1.7) `WARNING: This semi-major version contains breaking changes in the way leaderboard computing function works.` 1. Added an optional `fetchPosition` argument to the `Levels.fetch` which will add the leaderboard rank as the `position` property. Caution: Will be slower on larger servers. 2. `Levels.computeLeaderboard` is now asynchronous and can take in a third parameter called `fetchUsers` which will fetch all users on the leaderboard. This parameter **does not** require additional Gateway Intents. Caution: Will be substantially slower if you do not have `Guild_Members` intent and catch some users beforehand. - **16 July 2020** - Added `xpFor` method to calculate xp required for a specific level. ```js /* xpFor Example */ const Levels = require("discord-xp"); // Returns the xp required to reach level 30. var xpRequired = Levels.xpFor(30); console.log(xpRequired); // Output: 90000 ``` # Setting Up First things first, we include the module into the project. ```js const Levels = require("discord-xp"); ``` After that, you need to provide a valid mongo database url, and set it. You can do so by: ```js Levels.setURL("mongodb://..."); // You only need to do this ONCE per process. ``` # Examples *Examples can be found in /test* # Methods **createUser** Creates an entry in database for that user if it doesnt exist. ```js Levels.createUser(, ); ``` - Output: ``` Promise ``` **deleteUser** If the entry exists, it deletes it from database. ```js Levels.deleteUser(, ); ``` - Output: ``` Promise ``` **deleteGuild** If the entry exists, it deletes it from database. ```js Levels.deleteGuild(); ``` - Output: ``` Promise ``` **appendXp** It adds a specified amount of xp to the current amount of xp for that user, in that guild. It re-calculates the level. It creates a new user with that amount of xp, if there is no entry for that user. ```js Levels.appendXp(, , ); ``` - Output: ``` Promise ``` **appendLevel** It adds a specified amount of levels to current amount, re-calculates and sets the xp reqired to reach the new amount of levels. ```js Levels.appendLevel(, , ); ``` - Output: ``` Promise ``` **setXp** It sets the xp to a specified amount and re-calculates the level. ```js Levels.setXp(, , ); ``` - Output: ``` Promise ``` **setLevel** Calculates the xp required to reach a specified level and updates it. ```js Levels.setLevel(, , ); ``` - Output: ``` Promise ``` **fetch** (**Updated recently!**) Retrives selected entry from the database, if it exists. ```js Levels.fetch(, , ); ``` - Output: ``` Promise ``` **subtractXp** It removes a specified amount of xp to the current amount of xp for that user, in that guild. It re-calculates the level. ```js Levels.subtractXp(, , ); ``` - Output: ``` Promise ``` **subtractLevel** It removes a specified amount of levels to current amount, re-calculates and sets the xp reqired to reach the new amount of levels. ```js Levels.subtractLevel(, , ); ``` - Output: ``` Promise ``` **fetchLeaderboard** It gets a specified amount of entries from the database, ordered from higgest to lowest within the specified limit of entries. ```js Levels.fetchLeaderboard(, ); ``` - Output: ``` Promise ``` **computeLeaderboard** (**Updated recently!**) It returns a new array of object that include level, xp, guild id, user id, leaderboard position, username and discriminator. ```js Levels.computeLeaderboard(, , ); ``` - Output: ``` Promise ``` **xpFor** It returns a number that indicates amount of xp required to reach a level based on the input. ```js Levels.xpFor(); ``` - Output: ``` Integer ```