Skip to main content

A library with leveling cards for your discord bot.

Project description

DiscordLevelingCard

A library with Rank cards for your discord bot.

card preview

card1

card1


installation

for pypi version

pip install discordlevelingcard

for github developement version

pip install git+https://github.com/ResetXD/DiscordLevelingCard

How To Use

If you don't provide path then the method will return bytes which can directly be used in discord.py/disnake/pycord/nextcord 's File class.


Example

since no path was given, it returns bytes which can directly be used in discord.py and its fork 's File class.

from disnake.ext import commands
from DiscordLevelingCard import RankCard
import disnake

client = commands.Bot()

@client.slash_command(name="rank")
async def user_rank_card(ctx, user:disnake.Member):
    await ctx.response.defer()
    a = RankCard(
        background=user.banner.url,
        avatar=user.display_avatar.url,
        level=1,
        current_exp=1,
        max_exp=1,
        username="cool username"
    )
    image = await a.card1()
    await ctx.edit_original_message(file=disnake.File(image, filename="rank.png")) # providing filename is very important

if you want to use path

@client.slash_command(name="rank")
async def user_rank_card(ctx, user:disnake.Member):
    await ctx.response.defer()
    a = RankCard(
        background="https://cool-banner-url.com",
        avatar=user.display_avatar.url,
        level=1,
        current_exp=1,
        max_exp=1,
        username="cool username",
        bar_color="red",
        text_color="white",
        path="./user_cards/rank_card.png"
    )
    # image return the path provided i.e. "./user_cards/rank_card.png"
    image = await a.card1()
    await ctx.edit_original_message(file=disnake.File(image, filename="rank.png")) # providing filename is very important

Documentation

RankCard class

__init__ method

RankCard(
    background:Union[PathLike, BufferedIOBase],
    avatar:Union[PathLike, BufferedIOBase],
    level:int,
    current_exp:int,
    max_exp:int,
    username:str,
    bar_color:str="white",
    text_color:str="white",
    path:str=None
)

background - background image url or file-object in rb mode

avatar - avatar image url or file-object in rb mode

level - level of the user

current_exp - current exp of the user

max_exp - max exp of the user

username - username of the user

bar_color - color of the bar [example: "white" or "#000000"]

text_color - color of the text [example: "white" or "#000000"]

path - path to save the card [if not provided will return bytes instead]


card1 method

RankCard.card1()

returns - path if path was provided in __init__ or bytes if path was not provided in __init__


todo

  • add more cards
  • better documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

discordlevelingcard-0.2.2.tar.gz (60.6 kB view hashes)

Uploaded Source

Built Distribution

discordlevelingcard-0.2.2-py3-none-any.whl (60.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page