@elaraa/discord-xp v1.0.0

Installation

To install the package, you can easily do it by typing the command below:

+ npm install @elaraa/discord-xp@latest

To update to the latest version to our package, just do

+ npm update @elaraa/discord-xp

If you need help or you encountered an error while using our package, feel free to join our Discord server and we'll try to assist as soon as possible!

Changelogs

// Updates coming soon!

Starting up

To start using this package, you will need to do these two steps first.

• You will need to require the package using the example code below:

const Xp = require('@elaraa/discord-xp')

After that you can now connect to your Mongoose database. Put this below the line where you imported the package

Xp.connect('mongodb://...');

Functions

• createUser — Creates a new user on the database if it doesn't exist.

Xp.createUser(<UserID - String>, <GuildID - String>)

• deleteUser — Remove all the data of a user in the database if data exist.

Xp.deleteUser(<UserID - String>, <GuildID - String>)

• deleteGuild — Deletes all the data of the server in the database.

Xp.deleteGuild(<GuildID - String>)

• resetGuild — Resets all the settings for the guild in the database (XP will not reset)

Xp.resetGuild(<GuildID - String>)

• fetchLeadboard — Fetches the leaderboard from the guild Id provided

Xp.fetchLeadboard(<GuildID - String>, <Ranks - Number>)

• fetchUser — Fetch an individual user from the database

Xp.fetchUser(<UserID - String>, <GuildID - String>)

• xpFor — Calculate how many XP needed for a level

Xp.xpFor(<Level - Number>)

• xpLevel — Calculate how many levels is equal to the XP given.

Xp.xpLevel(<XP - Number>)

• setXp — Set the user's XP manually

Xp.setXp(<UserID - String>, <GuildID - String>, <XP - Number>)

• setLevel — Set the user's level manually

Xp.setLevel(<UserID - String>, <GuildID - String>, <Level - Number>)

• addXp — Add XP to the given user

Xp.addXp(<UserID - String>, <GuildID - String>, <XP - Number>)

• addLevel — Add level to the given user

Xp.addLevel(<UserID - String>, <GuildID - String>, <Level - Number>)

• subtractXp — Subtract the XP from the user's current XP

Xp.addXp(<UserID - String>, <GuildID - String>, <XP - Number>)

• subtractLevel — Subtract the level from the user's current level

Xp.subtractLevel(<UserID - String>, <GuildID - String>, <Level - Number>)

• cdAppend — Add a random XP to a user every minute only (Suggested for Leveling System)

Xp.cdAppend(<UserID - String>, <GuildID - String>, <MinimumXP - Number>, <MaximumXP - Number>)

• disableGuildXp — Disable XP system to the guild if enabled

Xp.disableGuildXp(<GuildID - String>)

• disableUserXp — Disable XP system to a specific user on a guild if enabled

Xp.disableUserXp(<UserID - String>, <GuildID - String>)

• enableGuildXp — Enable XP system to the Guild if disabled

Xp.enableGuildXp(<GuildID - String>)

• enableUserXp — Enable XP system to a specific user on a guild if disabled

Xp.enableUserXp(<UserID - String>, <GuildID - String>)

Example Usage

import { Client } from "discord.js";
const client = new Client({ intents: 3276799 });
const Xp = require('@elaraa/discord-xp')

xp.connect("mongodb://...").then(() => {
  console.log("Connected to database");
});

client.on("ready", () => {
  console.log("I am ready!");
});

client.on("messageCreate", (message) => {

  const prefix = "!";
  const args = message.content.slice(prefix.length).split(/ +/);
  const command = args.shift().toLowerCase();

  if (message.author.bot || !message.content.startsWith(prefix)) return;

  xp.cdAppend(message.author.id, message.guildId, 5, 20)
    .then((msg) => {
      if (msg === "LevelUp") {
        message.channel.send({ content: "You have leveled up!" });
      }
    })
    .catch((err) => console.log("Error appending xp: " + err));

});

client.login(token);

Level Data

The current version of this package uses the XP system to determine on how much XP the user will need in order to level up. You can use the following formula to calculate how much XP you need to level up: 6 * (lvl ** 2) + (55 * lvl) + 100 - xp where lvl is your current level, and xp is how much XP you already have.