README.md

🌸 Aki

Your stylish Danbooru-powered image curator for Discord.

---

🚀 Quick Start

1. Clone the repo

   git clone https://github.com/signalbean/Aki.git
   cd Aki

2. Install dependencies

   npm i

3. Configure environment Create a .env file in the project root:

   TOKEN=discord_bot_token
   CLIENT_ID=bot_client_id
   GUILD_ID=server_id # optional (for dev only)

4. Build the project - Read Build Notes First.

   npm run build

5. Start the bot

   npm run start

6. Start in dev

   npm run dev

Note

Commands may take a few minutes to appear globally. Use a GUILD_ID during development for faster testing in a single server.

---

⚙️ Configuration

Key	Required	Description
TOKEN	✅	Your Discord bot token.
CLIENT_ID	✅	Your bot's application (client) ID.
GUILD_ID	⛔️	Optional. Guild related stuff during dev.

Where do I find these?

• TOKEN: Discord Developer Portal → Applications → Your App → Bot → Reset Token
• CLIENT_ID: Developer Portal → Applications → Your App → General Information
• GUILD_ID: Right‑click your server → Copy ID (enable Developer Mode in Discord settings if needed)

---

🧱 Build Notes

This project used to rely on a script (coffee-break) to rewrite TypeScript path aliases. That’s not included anymore.

Options if you want aliases:

• Configure tsconfig.json and run with ts-node in dev.
• Use a bundler (Vite, esbuild, tsup, webpack) to resolve aliases.
• Or just keep it simple with relative paths.

---

📜 Documentation

• Full feature list, command reference, and troubleshooting are moved to the Wiki.
• The README here is only for install, setup, and build info.

---

📜 License

Licensed under the MIT License. See LICENSE for details.

---

_{Built with TypeScript. Runs on vibes. If it breaks, blame the vibes.}