feat: instructions and restrictions for AI tooling

For the AI-inclined amongst us

Author: Dragory

.cursorignore

@@ -0,0 +1,93 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+/logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.clinic
+.clinic-bot
+.clinic-api
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+*.env
+.env
+
+# windows folder options
+desktop.ini
+
+# PHPStorm
+.idea/
+
+# Misc
+/convert.js
+/startscript.js
+.cache
+npm-ls.txt
+npm-audit.txt
+.vscode/launch.json
+
+# Debug files
+*.debug.ts
+*.debug.js
+
+.vscode/
+
+config-errors.txt
+/config-schema.json
+
+*.tsbuildinfo
+
+# Legacy data folders
+/docker/development/data
+/docker/production/data

AGENTS.md

@@ -0,0 +1,21 @@
+The project is called Zeppelin. It's a Discord bot that uses Discord.js. The bot is built on the Knub framework.
+
+This repository is a monorepository that contains these projects:
+1. **Backend**: The shared codebase of the bot and API. Located in `backend`.
+2. **Dashboard**: The web dashboard that contains the bot's management interface and documentation. Located in `dashboard`.
+3. **Config checker**: A tool to check the configuration of the bot. Located in `config-checker`.
+
+There is also a `shared` folder that contains shared code used by all projects, such as types and utilities.
+
+# Backend
+The backend codebase is located in the `backend` directory. It contains the main bot code, API code, and shared code used by both the bot and API.
+Zeppelin's functionality is split into plugins, which are located in the `src/plugins` directory.
+Each plugin has its own directory, with a `types.ts` for config types, `docs.ts` for a `ZeppelinPluginDocs` structure, and the plugin's main file.
+Each plugin has an internal name, such as "common". In this example, the folder would be `src/plugins/Common` (note the capitalization). The plugin's main file would be `src/plugins/CommonPlugin.ts`.
+There are two types of plugins: "guild plugins" and "global plugins". Guild plugins are loaded on a per-guild basis, while global plugins are loaded once for the entire bot.
+Plugins can specify dependencies on other plugins and call their public methods. Likewise, plugins can specify public methods in the main file.
+Available plugins are specified in `src/plugins/availablePlugins.ts`.
+
+Zeppelin's data layer uses TypeORM. Entities are located in `src/data/entities`, while repositories are in `src/data`. If the repository name is prefixed with "Guild", it's a guild-specific repository. If it's prefixed with "User", it's a user-specific repository. If it has no prefix, it's a global repository.
+
+Environment variables are parsed in `src/env.ts`.