{"id":17693911,"url":"https://github.com/aurailus/k9","last_synced_at":"2025-05-13T03:20:37.517Z","repository":{"id":37243838,"uuid":"203671961","full_name":"Aurailus/k9","owner":"Aurailus","description":"A minimalist level tracker bot for discord, used on Auri's Den.","archived":false,"fork":false,"pushed_at":"2023-02-01T04:32:44.000Z","size":1609,"stargazers_count":4,"open_issues_count":5,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-26T17:41:49.243Z","etag":null,"topics":["bot","discord","role-rewards"],"latest_commit_sha":null,"homepage":"https://aurail.us/discord","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Aurailus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-21T22:15:04.000Z","updated_at":"2021-05-05T19:00:55.000Z","dependencies_parsed_at":"2024-10-24T16:46:48.157Z","dependency_job_id":"0e749b5d-218a-41ab-b601-729cde38f558","html_url":"https://github.com/Aurailus/k9","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aurailus%2Fk9","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aurailus%2Fk9/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aurailus%2Fk9/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aurailus%2Fk9/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Aurailus","download_url":"https://codeload.github.com/Aurailus/k9/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243307043,"owners_count":20270252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","discord","role-rewards"],"created_at":"2024-10-24T13:47:22.190Z","updated_at":"2025-03-12T22:32:43.394Z","avatar_url":"https://github.com/Aurailus.png","language":"TypeScript","funding_links":["https://patreon.com/Aurailus"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eK9\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/Aurailus/k9/master/assets/logo.png\" width=\"200\"\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eA minimalist level-tracking Discord bot. Woof!\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://app.codacy.com/gh/Aurailus/k9/dashboard\"\u003e\u003cimg src=\"https://img.shields.io/codacy/grade/61133a91364941e8b6bb25b6fa4c2489.svg?logo=codacy\u0026logoColor=cccccc\u0026labelColor=2A3037\" alt=\"Releases\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/Aurailus/k9/commits/master\"\u003e\u003cimg src=\"https://img.shields.io/github/commit-activity/m/aurailus/k9.svg?logo=github\u0026logoColor=cccccc\u0026labelColor=2A3037\u0026label=commit%20activity\" alt=\"Commit Activity\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://aurail.us/discord\"\u003e\u003cimg src=\"https://img.shields.io/discord/416379773976051712.svg?color=7289DA\u0026label=discord\u0026logo=discord\u0026logoColor=cccccc\u0026labelColor=2A3037\" alt=\"Join Discord\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://patreon.com/Aurailus\"\u003e\u003cimg src=\"https://img.shields.io/static/v1?label=patreon\u0026message=support\u0026color=FF6952\u0026logo=patreon\u0026logoColor=cccccc\u0026labelColor=2A3037\" alt=\"Support on Patreon\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\nK9 is a self-hosted, minimalist level tracking Discord bot. It tracks post frequency in a persistent database, assigning experience to posts which contributes to a total user level. This user level is used to apply custom roles to award active users.\n\nAn example of this functionality can be seen in [Auri's Den](https://aurail.us/discord).\n\n### Dependencies\n\n  * NodeJS 12+\n  * NPM\n  * MongoDB\n\n### Installation\n\n1) Clone this repository: `git clone https://github.com/Aurailus/k9`\n2) Install node dependencies: `npm install`\n3) Copy `conf.example.toml` to `conf.toml`\n4) Put a valid discord token and other configuration details in `conf.toml`.\n5) Run the bot: `npm start`\n\n### Configuration\n\nTo allow the bot to start, track levels, and give role rewards, fill out `conf.toml` with the missing credentials. An example and explanation of all the variables are shown below.\n\n**Example:**\n\n```TOML\n[auth]\n# A Discord Bot token\ndiscord = \"token\"\n# MongoDB URL\nmongo_url = \"mongodb://host/database\" \n\n[options]\n# Custom status\nstatus = \"Hanging out\"\n# Command prefix\nprefix = \"/\" \n# Delete commands after execution\ndelete_triggers = true  \n\n[plugin.level]\n# Bot responds to \"good dog\" after ranking up.\nplease_and_thank_you = false \n\n[plugin.level.message]\n# Cooldown time\ncooldown = 30 \n# Minimum message length\nmin_length = 30\n\n[plugin.level.experience] \n# https://www.desmos.com/calculator/80hyi0deu6\n# First level XP offset.\na = 15 \n# Larger values makes XP / level higher.\nb = 6.5 \n# Larger values make XP / level exponentially higher.\nc = 1.5 \n\n[[plugin.level.roles]]\n# Level to acquire role\nlevel = 1 \nrole = \"RoleID\"\n[[plugin.level.roles]]\nlevel = 2\nrole = \"RoleID\"\n[[plugin.level.roles]]\nlevel = 5\nrole = \"RoleID\"\n```\n\n### Contributing\n\nIf you would like to contribute, please follow the code style used in the existing source files, and indent with tabs. Once you are done submit a pull request outlining what you have changed / added and why it should be implementing into the bot.\n\n\u003cbr\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u0026copy; [Auri Collings](https://twitter.com/Aurailus), 2021. Made with \u003c3\n\nLicensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faurailus%2Fk9","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faurailus%2Fk9","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faurailus%2Fk9/lists"}