{"id":19660649,"url":"https://github.com/yamdbf/core","last_synced_at":"2025-04-28T20:32:24.013Z","repository":{"id":48313267,"uuid":"68603087","full_name":"yamdbf/core","owner":"yamdbf","description":"The core YAMDBF Framework","archived":false,"fork":false,"pushed_at":"2021-08-02T06:26:16.000Z","size":5379,"stargazers_count":65,"open_issues_count":13,"forks_count":13,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-01T09:13:43.469Z","etag":null,"topics":["bot","discord","discord-bot-framework","discord-js","framework","typescript","yamdbf"],"latest_commit_sha":null,"homepage":"http://yamdbf.js.org","language":"TypeScript","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/yamdbf.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}},"created_at":"2016-09-19T12:22:13.000Z","updated_at":"2024-06-29T00:28:35.000Z","dependencies_parsed_at":"2022-09-16T21:40:30.569Z","dependency_job_id":null,"html_url":"https://github.com/yamdbf/core","commit_stats":null,"previous_names":["zajrik/yamdbf"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamdbf%2Fcore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamdbf%2Fcore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamdbf%2Fcore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamdbf%2Fcore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yamdbf","download_url":"https://codeload.github.com/yamdbf/core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224134018,"owners_count":17261302,"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","discord-bot-framework","discord-js","framework","typescript","yamdbf"],"created_at":"2024-11-11T16:04:45.783Z","updated_at":"2024-11-11T16:04:47.177Z","avatar_url":"https://github.com/yamdbf.png","language":"TypeScript","readme":"## YAMDBF: Yet Another Modular Discord Bot Framework\n\n[![Discord](https://discordapp.com/api/guilds/233751981838041090/embed.png)](https://discord.gg/cMXkbXV)\n[![npm](https://img.shields.io/npm/v/@yamdbf/core.svg?maxAge=3600)](https://www.npmjs.com/package/@yamdbf/core)\n[![David](https://david-dm.org/yamdbf/core/status.svg)](https://david-dm.org/yamdbf/core)\n[![David](https://david-dm.org/yamdbf/core/peer-status.svg)](https://david-dm.org/yamdbf/core?type=peer)\n[![Travis](https://api.travis-ci.org/yamdbf/core.svg)](https://travis-ci.org/yamdbf/core)\n\n\u003c!-- Hidden until someday when scoped packages are supported --\u003e\n\u003c!-- [![NPM](https://nodei.co/npm/@yamdbf/core.png?downloads=true\u0026stars=true)](https://nodei.co/npm/yamdbf/) --\u003e\n\nYAMDBF is a lightweight Discord Bot framework for rapid bot development using [Discord.js](https://discord.js.org),\nmaking it simple to get a bot up and running with minimal effort and configuration.\n\n## Features\n- Fully localizable (English by default)\n- Base commands for control over default settings\n- Full control over all base commands via disabling or overloading\n- Simple structure for creation of custom commands\n- Automatic custom command loading\n- Fine control of command execution per-user/globally via configurable ratelimits\n- Robust middleware system for fine control of execution flow and  \n  control over the data passed to your commands\n  - Ships with methods for resolving different data types and ensuring  \n    certain args/types are passed to commands\n- Easy to use storage with support for custom storage providers\n  - Ships with a default JSON provider, and other optional providers using Sequelize:\n    - Postgres\n    - SQLite\n    - MySQL\n    - MSSQL\n- Easy to use Plugin system\n- Full TypeScript support (It's written in it!)\n  - Support for decorators for simpler handling of:\n    - Event listeners\n    - Command metadata\n    - Command middleware assignment\n    - Attaching Logger for logging/debugging\n\n## Installation\nIgnore any warnings about unmet peer dependencies as they are all optional unless\nusing a Sequelize-based storage provider.\n\n\u003e**Note:** YAMDBF Requires \u003e Node 8.0.0 to run\n\n- Regular install: `npm install --save @yamdbf/core`\n- With the Postgres provider: `npm install --save @yamdbf/core pg sequelize`\n- With the SQLite provider: `npm install --save @yamdbf/core sqlite3 sequelize`\n- With the MySQL provider: `npm install --save @yamdbf/core mysql2 sequelize`\n- With the MSSQL provider: `npm install --save @yamdbf/core tedious sequelize`\n\n\n\u003eIndev builds can be installed from NPM: `npm install --save @yamdbf/core@indev`  \nDocumentation for indev builds can be found [here](https://yamdbf.js.org/indev).  \nIndev builds currently require \u003e= Node 14.0.0 to run.\n\n## Links\n- [YAMDBF Documentation](https://yamdbf.js.org)\n- [YAMDBF Discord server](https://discord.gg/cMXkbXV)\n- [YAMDBF GitHub](https://github.com/yamdbf/core)\n- [YAMDBF Issues](https://github.com/yamdbf/core/issues)\n- [YAMDBF NPM](https://www.npmjs.com/package/@yamdbf/core)\n- [YAMDBF Yarnpkg](https://yarnpkg.com/en/package/@yamdbf/core)\n- [Zajrik on Patreon](https://patreon.com/zajrik)","funding_links":["https://patreon.com/zajrik"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamdbf%2Fcore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyamdbf%2Fcore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamdbf%2Fcore/lists"}