Skip to content

Latest commit

 

History

History
154 lines (108 loc) · 5.54 KB

README.md

File metadata and controls

154 lines (108 loc) · 5.54 KB
Raw

Code0 Discord Bot

Discord bot standalone by Nicusch | Nicolas Morawietz

Code0

Basic Overview:

This this the Discord Bot for Code0 running in javascript.

The Bot is running the Discord.js Client instance and a small Web-Server for Github o-auth in order to perform some commands which includes reading commits and pull's.

For that reason a Http Port is required and currently set to http-config.port inside the http-config.json

A MongoDb is required as this Bot stores some Data

Main Interactions

Command Status Bugs Fixed
1 /open-contributer Finished 3
2 /ticket Finished 2
3 /links Design X
4 /contributor Finished X
5 /rank or /rank @user +uptodate15 Finished 1
6 /leaderboard or /leaderboard limit: 1-20 Finished 1
7 Code0 Application Ticket Finished X
8 /stats or /stats @user + uptodate15 Finished 1
9 /logs show or /logs list Finished 1
10 /debug for debugging Debug (WIP) -
11 Git rank message every 24 hours Finished 2
12 /git display charts of Git activity WIP 0

Bugs Fixed: Since i save them / remember.

Tracking

We do track stats, as you could tell by our Bot's source code such as:

  • Message Stats -> message/word/char *count.
  • Voice Stats -> joins/leaves/switches *count.

We use these to determine your rank or display stats about you.

For the Command /open-contributer we are not saving your o-auth url for github in any way, which also means that you have to re-auth yourself at any command execution.

Command tracking is not implemented (yet). We are currently not saving any executed commands

The entries look like this:

{
    "_id": {
        "$oid": "6644f92497346d3e063052fe" // MongoDb unique id
    },
    "id": "380808844093292555", // user id, no name
    "rawxp": 744, // Your rawXp
    "stats": {
        "messages": {
            "words": 3847, // Total words count
            "chars": 19610, // Total chars count
            "count": 641 // Total messages count
        },
        "voice": {
            "joins": 106, // Voice channel joins
            "switchs": 14, // Voice channel changes like from Talk#1 to Talk#2 (while remaining connection)
            "time": 60633 // Voice time in seconds
        }
    },
    "commandstats": {} // empty unused
}

MongoDb entries last updated inside this ReadMe: 30.08.2024

Ps: On Discord you can do <@user_id> to find out the name of a discord by his user id.

Were are the missing files?

The code you see here mirrors what's running on the Discord Bot server. However, some files are not open-source:

  • node_modules: Not included here because storing them wouldn't be practical.
  • server.env: Server-side configuration.
  • .env: Development configuration.
  • config.json: Contains server-specific settings like roles, channels, embeds, etc.
  • http-config.json: Specifically used for our server.
  • unused-temp.js: Stores unused code snippets for potential future use.
  • a-workon: Is a folder with files which are still wip and not able to be used now.
  • .gitignore: A mysterious file that even hides from itself.

If you'd like to set up this bot for testing purposes, please contact me at [DC:nixkuchen]. I can provide you with a template to get started.

Unused files for the Discord Bot process

In ./_app/* are files that are just to setup the Discord server, like images

Versions

"@discordjs/voice": "^0.17.0",
"canvas": "^2.11.2",
"chartjs-node-canvas": "^4.1.6",
"discord.js": "^14.15.3",
"dotenv": "^16.3.1",
"html-to-image": "^1.11.11",
"html2canvas": "^1.4.1",
"libsodium-wrappers": "^0.7.13",
"mongo": "^0.1.0",
"node-fetch": "^2.6.12",
"puppeteer": "^22.10.0",
"ytdl-core": "^4.11.5"

The Code works 100% with these versions.

What is?

  • wip: Work in Progess

  • uptodate15: This means the message will be updated when changes occur up to 15 more minutes after the interaction execution.

  • todo: When creating my todos i will create a new commit which will be named after "todo".

  • readme: Is also a commit whenever i update the readme.

Why Does Code Sometimes Fall Short?

  • Reason 1: Code is often hastily written just to achieve functionality.

  • Reason 2: Requirements frequently change, necessitating frequent code revisions.

  • Reason 3: Code undergoes continuous style and functional evolution in Code0.

  • Reason 4: While the current state might seem messy, it functions without known bugs; any issues are documented in TODO => index.js.

  • Reason 5: Rapid development can lead to shortcuts, resulting in functional but sometimes suboptimal code.

Since this bot is under development, significant changes may occur.

Nicusch Version System

0.0.1 => Bug fixes or small changes

0.1.0 => Command changes

1.0.0 => Changes of entire Class or Interaction method structures

Very simple to keep track of, this NVS was not used correctly until now 10.07.2024.

Know issues

  • 1: Tables and Bars are not displayed correctly on Mobile devices