Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyvern800/tldkp
A simple but helpful bot to manage DKP (Dragon Kill Points) of your Guild Members, made for Throne & Liberty
https://github.com/wyvern800/tldkp
discord-bot discord-js typescipt
Last synced: 2 months ago
JSON representation
A simple but helpful bot to manage DKP (Dragon Kill Points) of your Guild Members, made for Throne & Liberty
- Host: GitHub
- URL: https://github.com/wyvern800/tldkp
- Owner: wyvern800
- License: mit
- Created: 2024-10-12T19:33:13.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T06:28:03.000Z (2 months ago)
- Last Synced: 2024-10-28T01:27:59.037Z (2 months ago)
- Topics: discord-bot, discord-js, typescipt
- Language: JavaScript
- Homepage: https://www.tldkp.online/
- Size: 9.6 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TLDKP Discord Bot (Throne and Liberty Dragon Kill Points)
### TL;DR
The Dragon Kill Points (DKP) system is a method used in MMORPGs (Massively Multiplayer Online Role-Playing Games) to distribute loot among players after defeating bosses or completing raids. DKP is a type of currency that players earn by participating in these activities, and they can spend their points to bid on or claim items dropped by defeated enemies.
> NOTE: This project was a nightly build, which means it was coded in speedrun mode, not much focused, but ive put some more effort onto it, so you are good to use it as it is.
## Features:
- Add command to manage people's DKPs - OK
- Add command to view my DKPs - OK
- Create command to add ingame Nick - OK
- Fix error log - OK
- Added repo - OK
- Create language/localization system - WIP
- Added base, selector/command to change language - OK
- Add help command - OK
- Create way to add the bot to the owners' servers - OK
- Add way to interact with the command only if it is a specific role determined by the site
- Ability to enable/disable an automatic DKP decaying system with some cool features like setting the minimum dkp you can have when decaying and all automatic.
## Start contributing (Setting up the local dev. environment)
### How do I start contributing?
> We use firebase so you'll have to setup your Cloud Firestore (Firebase), you'll have to create a discord bot application and also a Clerk account (for the authentication),
so you'll need:
1. Setup [Cloud Firestore](https://firebase.google.com) and set its vars on .env (root), the var is **FIREBASE_SERVICE_ACCOUNT**.
2. Setup [Clerk](https://clerk.com) and set its vars in **frontend/.env.local**: **VITE_CLERK_PUBLISHABLE_KEY** and **VITE_BOT_INSTALL** and in the .env in the root folder: **CLERK_SECRET_KEY**, **CLERK_PUBLISHABLE_KEY** they're the same
in both (frontend and root) but since vite uses the prefix **VITE_**, it had to be set this way.
3. Setup the [Discord Application](https://discord.com/developers/applications) and set its vars: **GUILD_ID** (Your discord server id), **CLIENT_ID** and **DISCORD_TOKEN**
4. And last but not least, after configuring the bot application in discord dev portal, grab its install url under **Installation**, and put on the **frontend/.env.local**: **VITE_BOT_INSTALL**
5. And you can now continue to the next steps
### Using docker (Recommended)
We have docker environment setup for our development project, so you can [Download](https://www.docker.com/products/docker-desktop/) it and then just run:
```docker-compose -f docker-compose.dev.yml --build```
### After running the build step (to start the dev env):
```docker-compose -f docker-compose.dev.yml up```
### Without docker (normal way)
1. ```npm install``` (root folder)
2. ```cd frontend```
3. ```npm install```
4. Fill the necessary .envs (one in root folder, one in frontend folder)
5. Then go to root folder again, and you can run the scripts present in package.json
### Available scripts
* ```npm run dev``` - Run the whole app (bot, server and frontend)
* ```npm run dev:bot``` - Run only the bot
* ```npm run dev:client``` - Run only the frontend dev server
* ```npm run dev:api``` - Run only the backend (server)
* ```npm run dev:site``` - Run only server and frontend (leave bot down)
The url to local frontend is: http://localhost:5173/
The backend is: http://localhost:3000/
If you reached here, you're now free to develop and collaborate, lets build together <3
## Updates
I will be pushing fixes/suggestions whenever I feel the urge to, so there is no updates schedule, that means I could push a bunch per week, but none in another, (remind that supporting me trough patreon and by direct donations can make me feel motivated to keep pushing more and more, as this is a free project but have it's costs to keep it up online).
## Repomap
## Collaboration
Feel free to fork and contribute, its always fun to share knowledge