https://github.com/harukayamamoto0/alcyone
Alcyone is a Discord bot designed to be as complete, stable, and customizable as possible—offering automation, moderation, and fun in an integrated and reliable way.
https://github.com/harukayamamoto0/alcyone
alcyone bot discord portfolio typescript
Last synced: 3 months ago
JSON representation
Alcyone is a Discord bot designed to be as complete, stable, and customizable as possible—offering automation, moderation, and fun in an integrated and reliable way.
- Host: GitHub
- URL: https://github.com/harukayamamoto0/alcyone
- Owner: HarukaYamamoto0
- License: apache-2.0
- Created: 2025-09-10T05:23:02.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-11-07T07:11:38.000Z (8 months ago)
- Last Synced: 2025-11-07T09:09:12.431Z (8 months ago)
- Topics: alcyone, bot, discord, portfolio, typescript
- Language: TypeScript
- Homepage:
- Size: 143 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌌 **Alcyone**
### _A modular Discord bot core forged in order, silence, and a whisper of chaos._
[](LICENSE)
[]()
[]()
[]()
> “In every system, there must be structure.
> In every structure, a pulse.”
> — *Alcyone Core Protocol*
## ✨ **Overview**
**Alcyone** is not just another Discord bot —
it is a **framework**, a **foundation**, and a **core system** built for developers who want clarity and power without sacrificing elegance.
Designed with:
- 🔧 **True Modularity** — commands, events, loaders and interfaces fully isolated
- ⚡ **High Performance** — Bun runtime + optimized loading
- 🧩 **Extensibility First** — structure ready for scaling, theming and customization
- 🔐 **Secure Integrations** — powered by Infisical and strict environment validation
- 🖤 **Aesthetic + Order** — code that looks clean, feels clean, and _stays_ clean
Use Alcyone as:
- a complete bot,
- a boilerplate for new bots,
- or the baseline for your own SDK.
## 🌒 **Why Alcyone Exists**
Discord bots often fall into two extremes:
- total chaos,
- or unnecessary complexity.
Alcyone is born in the perfect middle ground:
A solid core, simple to understand, hard to crack — and elegant enough for you to be proud to keep.
## 🧱 **Project Structure**
```bash
src/
│
├── core/ # Client, gateway, initialization
├── commands/ # Slash, context and utilities
│ ├── slash/
│ ├── context/
│ └── ...
│
├── events/ # Bot events (ready, interactions)
├── loaders/ # Automatic loaders (commands, events)
├── config/ # Constants, emojis, API keys, env validators
├── interfaces/ # Base classes & TypeScript contracts
├── utils/ # Helpers and safe utilities
└── main.ts # Entry point
````
**No manual wiring.**
Every command and event is detected and registered automatically.
## ⚙️ **Tech Stack**
| Component | Technology |
| --------------- | ----------------- |
| Runtime | Bun |
| API Layer | Discord.js v14 |
| Language | TypeScript |
| Formatting | ESLint + Prettier |
| HTTP Client | Axios |
| Date Utils | Moment.js |
| Secrets Manager | Infisical |
## 🚀 **Running the Project**
### ✅ Install dependencies
```bash
bun install
```
### ✅ Login to Infisical
```bash
infisical login
```
### ✅ Development mode
```bash
bun run dev
```
### ✅ Production build
```bash
bun run build
```
## 🧩 **Command Design**
All Slash Commands extend the unified base class:
```ts
class Ping extends BaseSlashCommand {
constructor() {
super();
this
.setName('ping')
.setDescription('Shows bot and server latency with style');
}
async execute(interaction) {
await interaction.reply('Pong');
}
}
export default Ping;
```
This ensures:
* predictable behavior,
* automatic loading,
* shared metadata,
* easier maintenance.
Events follow the same architecture.
## 🧠 **Core Philosophy**
> *“Simplicity is not the absence of complexity,
> but the mastery of it.”*
Every piece of Alcyone is built with:
* low coupling,
* clear responsibilities,
* and minimal side-effects.
It is the exact opposite de um bot “gigante e bagunçado”.
## 📜 License
Distributed under the **Apache 2.0 License**.
See [`LICENSE`](LICENSE) for details.
### 🖤 Alcyone
**Built by [HarukaYamamoto0](https://github.com/HarukaYamamoto0)**
with elegance, caffeine, and the gentle fear of breaking production.