{"id":23231355,"url":"https://github.com/cnily03/ctf-bot","last_synced_at":"2026-05-02T01:33:58.692Z","repository":{"id":74704631,"uuid":"557972699","full_name":"Cnily03/ctf-bot","owner":"Cnily03","description":"A discord bot for CTF crafting based on Pycord.","archived":false,"fork":false,"pushed_at":"2023-01-13T07:14:32.000Z","size":37,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-11T17:17:05.200Z","etag":null,"topics":["bot","capture-the-flag","ctf","ctf-bot","ctf-helper","ctf-helper-bot","ctf-tools","discord","discord-bot","discordbot","helper","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cnily03.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-10-26T16:46:32.000Z","updated_at":"2024-01-20T15:30:35.000Z","dependencies_parsed_at":"2023-07-08T02:30:48.016Z","dependency_job_id":null,"html_url":"https://github.com/Cnily03/ctf-bot","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/Cnily03%2Fctf-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cnily03%2Fctf-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cnily03%2Fctf-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cnily03%2Fctf-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cnily03","download_url":"https://codeload.github.com/Cnily03/ctf-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247388608,"owners_count":20931066,"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","capture-the-flag","ctf","ctf-bot","ctf-helper","ctf-helper-bot","ctf-tools","discord","discord-bot","discordbot","helper","python"],"created_at":"2024-12-19T02:14:24.699Z","updated_at":"2026-05-02T01:33:58.605Z","avatar_url":"https://github.com/Cnily03.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CTF Helper\n\nA discord bot for CTF crafting based on [Pycord](https://pycord.dev/github).\n\n## Application\n\nInvite CTF Helper to your server: https://discord.cnily.me/invite/bot/ctf-bot\n\nIf you want to create your own bot, clone this repository to your computer.\n\n```bash\ngit clone https://github.com/Cnily03/ctf-bot.git\n```\n\nInstall requirements.\n\n```bash\npip install -r requirements.txt\n```\n\nor if you use Poetry to manage your project, install as following.\n\n```bash\npoetry install\n```\n\nMake file `token` at root directory, which contains Token of your discord bot .\n\nThen start the program.\n\n```bash\npython ctf-bot\n```\n\n## Configure\n\nEdit `config.yml` at the root directory.\n\n## Development\n\n### Extensions\n\n#### Class `BotController`\n\n`BotController` is a packed abstract class of `discord.Bot`, which can help control the bot more easily.\n\n##### Prototype of `BotController`\n\n```python\nclass BotController:\n    def __init__(self, bot: discord.Bot):\n        self.bot = bot\n    def use(self, plugin: AppPlugin):\n        plugin.apphandler(self.bot)\n```\n\n#### Class `AppPlugin`\n\n`AppPlugin` is a abstract class for developers to create various plugins with colorful functions.\n\nThe implementation of API to connect with `bot` is method `apphandler` with a param `bot` in type `discord.Bot`.\n\n##### Prototype of `AppPlugin`\n\n```python\nclass AppPlugin:\n    def apphandler(self, bot: discord.Bot): pass\n```\n\n#### Example\n\n```python\nclass CustomPlugin(AppPlugin):\n    # do something here\n    def apphandler(self, bot: discord.Bot):\n        #do something here\nbot = discord.Bot()\napp = BotController(bot)\napp.use(CustomPlugin())\n```\n\nMany functions in this project is implemented in this way.\n\n### Register commands\n\nAll the commands python file is in `commands` directory.\n\nRemember to modify `register_args` in `__main__.py` after adding  or removing a command.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnily03%2Fctf-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcnily03%2Fctf-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnily03%2Fctf-bot/lists"}