{"id":50882325,"url":"https://github.com/gravendev/omnibot","last_synced_at":"2026-06-15T14:01:31.367Z","repository":{"id":310364174,"uuid":"1039539209","full_name":"GravenDev/OmniBot","owner":"GravenDev","description":"The future async community discord bot, which will handle progressively all our needs","archived":false,"fork":false,"pushed_at":"2026-06-11T18:12:15.000Z","size":623,"stargazers_count":3,"open_issues_count":15,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-11T20:07:13.060Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GravenDev.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-17T13:09:28.000Z","updated_at":"2026-06-11T07:13:19.000Z","dependencies_parsed_at":"2026-05-01T06:00:52.387Z","dependency_job_id":null,"html_url":"https://github.com/GravenDev/OmniBot","commit_stats":null,"previous_names":["asynccommunitydiscord/omnibot","gravendev/omnibot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GravenDev/OmniBot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GravenDev%2FOmniBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GravenDev%2FOmniBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GravenDev%2FOmniBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GravenDev%2FOmniBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GravenDev","download_url":"https://codeload.github.com/GravenDev/OmniBot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GravenDev%2FOmniBot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34365597,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-06-15T14:01:27.998Z","updated_at":"2026-06-15T14:01:31.355Z","avatar_url":"https://github.com/GravenDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003e\n  \u003cimg src=\"https://avatars.githubusercontent.com/u/78621926?s=200\u0026v=4\" width=\"75\"\u003e\u003cbr/\u003e\n  Async - Community\u003cbr/\u003e\n  This project is under the \u003ca href=\"https://choosealicense.com/licenses/gpl-3.0/\"\u003eGNU GPL v3\u003c/a\u003e license\u003cbr/\u003e\u003cbr/\u003e\n\u003c/h3\u003e\n\n# \u003cp align=\"center\"\u003e`OmniBot`\u003c/p\u003e\n\nAll the projects in the \u003ccode\u003eAsyncCommunityDiscord\u003c/code\u003e organisation are used by the discord server \u003ccode\u003ediscord.gg/graven\u003c/code\u003e both by the moderators and the members.\nMost of the contributors are part of the staff but the members are also allowed to contribute.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/State-In_development-orange?style=for-the-badge\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues/AsyncCommunityDiscord/OmniBot?style=for-the-badge\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues-pr/AsyncCommunityDiscord/OmniBot?style=for-the-badge\"\u003e\n\u003c/p\u003e\n\n---\n\n## What is OmniBot?\n\nOmniBot is a **modular** Discord bot: each feature is a self-contained **module**\nthat is auto-discovered at startup and can be installed/uninstalled **per Discord\nserver** via `/modules`. Modules declare their own slash commands, event\nlisteners, interaction handlers and a typed configuration schema (edited live\nwith `/config \u003cmodule\u003e`) — the core wires everything together, so adding a\nfeature never means touching the bootstrap.\n\n## Tech stack\n\n| Area        | Choice                                                                                                                                                                      |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Language    | TypeScript (ESM, `NodeNext`), Node.js 24                                                                                                                                    |\n| Discord     | [discord.js](https://discord.js.org/) v14                                                                                                                                   |\n| Database    | PostgreSQL 17 via [Prisma](https://www.prisma.io/) (multi-file schema)                                                                                                      |\n| Package mgr | [pnpm](https://pnpm.io/)                                                                                                                                                    |\n| Toolchain   | [mise](https://mise.jdx.dev/) (tool versions), [oxlint](https://oxc.rs/) + oxfmt (lint/format), [lefthook](https://lefthook.dev/) (git hooks), commitlint (commit messages) |\n| Tests       | [Vitest](https://vitest.dev/)                                                                                                                                               |\n| Logging     | [pino](https://getpino.io/)                                                                                                                                                 |\n| Dev runner  | [pitchfork](https://github.com/jdx/pitchfork) (one-command stack)                                                                                                           |\n\n## Getting started\n\n### Prerequisites\n\n- [mise](https://mise.jdx.dev/) — pins Node.js, pnpm and pitchfork (`mise install`).\n  Without mise, install Node.js 24 and pnpm manually (versions are in `.mise.toml`).\n- Docker (for the PostgreSQL container).\n- A Discord bot token — from the [Discord Developer Portal](https://discord.com/developers/applications).\n\n### Setup\n\n```bash\nmise install            # installs Node, pnpm, pitchfork from .mise.toml\npnpm install            # installs dependencies and git hooks (lefthook)\ncp .env.example .env    # then fill in the values (see Environment below)\n```\n\n### Run\n\nOne command brings up PostgreSQL and the bot (daemons defined in `pitchfork.toml`):\n\n```bash\npitchfork start bot     # starts the db daemon, waits until it is ready, then runs the bot\npitchfork logs bot      # tail logs   ·   pitchfork stop bot db   # stop everything\n```\n\nPrefer to run things yourself?\n\n```bash\ndocker compose up -d    # PostgreSQL 17\npnpm prisma:migrate     # apply migrations (first run)\npnpm dev                # run the bot with tsx\n```\n\n### Environment\n\nCopy `.env.example` to `.env`:\n\n- `DISCORD_TOKEN` — bot token from the Discord Developer Portal.\n- `DATABASE_URL` — PostgreSQL connection string (default matches `compose.yaml`).\n- `DEV_GUILD_ID` — **dev only**: guild where slash commands are registered\n  instantly (global commands take ~1h to propagate). Required by `pnpm dev`.\n\n## Project layout\n\n```\nsrc/\n├── core/      # framework: module loader, /config \u0026 /modules, command/event/interaction loaders\n├── modules/   # one folder per feature module (commands/, listeners/, services/, *.config.ts, *.module.ts)\n├── lib/       # shared contracts (module, config, registry, listener, …)\n└── prisma/    # consolidated schema + migrations (generated — never edit by hand)\n```\n\nEach module is a plugin: drop a folder under `src/modules/` and it is discovered\nautomatically — **no registration anywhere else**.\n\n## Common commands\n\n```bash\npnpm dev                 # run with tsx\npnpm build               # prisma:generate + tsc → dist/\npnpm test                # run the full test suite (unit + integration)\npnpm format              # oxfmt + oxlint --fix\npnpm prisma:migrate      # create \u0026 apply a migration\npnpm prisma:studio       # open Prisma Studio\n```\n\n## Contributing\n\nContributions are welcome — staff and members alike.\n\n- **Start with the developer guide in [`docs/`](docs/README.md)**: how to create a\n  module, slash commands, listeners, interactions, services, the Prisma schema,\n  and the user-facing behaviour.\n- **Conventional Commits** are enforced (commitlint, via a lefthook `commit-msg`\n  hook). A lefthook `pre-commit` hook runs oxfmt + oxlint on staged files —\n  `pnpm install` sets the hooks up for you.\n- **Before opening a PR**, make sure `pnpm build`, `pnpm test`, `pnpm exec oxlint\n--deny-warnings` and `pnpm exec oxfmt --check` all pass (CI runs the same).\n- **Agent instructions** live in [`AGENTS.md`](AGENTS.md) (also symlinked as\n  `CLAUDE.md`) — a concise orientation that is handy for humans too.\n- **Known tech-debt and follow-ups** are tracked in [`AUDIT.md`](AUDIT.md).\n\n## License\n\n[GNU GPL v3](https://choosealicense.com/licenses/gpl-3.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgravendev%2Fomnibot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgravendev%2Fomnibot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgravendev%2Fomnibot/lists"}