An open API service indexing awesome lists of open source software.

https://github.com/devvyyxyz/xeno-bot

Build your xenomorph hive! Eggs will randomly spawn in a channel. be the first to collect them and hatch your xenos. Grow your hive, trade with friends, and compete to create the ultimate collection.
https://github.com/devvyyxyz/xeno-bot

bot css discord html js

Last synced: 3 months ago
JSON representation

Build your xenomorph hive! Eggs will randomly spawn in a channel. be the first to collect them and hatch your xenos. Grow your hive, trade with friends, and compete to create the ultimate collection.

Awesome Lists containing this project

README

          

![Xeno Bot Banner](https://placehold.co/1280x400?text=Xeno+Bot)

# 👾 Xeno Bot

[![Discord.js](https://img.shields.io/badge/discord.js-v14-blue.svg)](https://discord.js.org/)
[![Node.js](https://img.shields.io/badge/node-%3E%3D18-green.svg)](https://nodejs.org/)
[![License](https://img.shields.io/github/license/devvyyxyz/xeno-bot)](LICENSE)
[![GitHub Stars](https://img.shields.io/github/stars/devvyyxyz/xeno-bot)](https://github.com/devvyyxyz/xeno-bot/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/devvyyxyz/xeno-bot)](https://github.com/devvyyxyz/xeno-bot/network)

Build your xenomorph hive! Eggs will randomly spawn in a channel. be the first to collect them and hatch your xenos. Grow your hive, trade with friends, and compete to create the ultimate collection.

---

## 🔗 Links

- 🤖 **Invite Bot** — https://discord.com/oauth2/authorize?client_id=1476427270326583306
- 🗳 **Top.gg Page** — https://top.gg/bot/1476427270326583306
- 📚 **Documentation** — https://xeno-bot-docs.devvyy.xyz/
- 💬 **Support Server** — https://discord.gg/WmFDeMKvzj
- 🧑‍💻 **GitHub Repository** — https://github.com/devvyyxyz/xeno-bot

---

# ✨ Features

- ⚡ Built with **discord.js v14**
- 🧩 **Modular command & event system**
- 🛠 **Developer friendly architecture**
- 🗄 **SQLite + PostgreSQL support**
- 📊 **Remote logging support**
- 🚨 **Optional Sentry error monitoring**
- 🔧 **Development & production bot profiles**
- 🌌 **Sci-fi themed bot experience**

---

# 🚀 Getting Started (For Users)

Adding Xeno Bot to your server is quick and easy.

### 1️⃣ Invite the bot

Use the invite link below:

[https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID](https://discord.com/oauth2/authorize?client_id=1476427270326583306)

### 2️⃣ Grant permissions

The bot will request permissions needed to operate commands and respond to interactions.

### 3️⃣ Start using commands

Once invited, you can begin using slash commands such as:

```

/help
/profile
/stats

````

More commands and features are documented in the full documentation.

---

# 📚 Documentation

Full documentation for setup, commands, configuration, and development can be found here:

**https://docs.xeno-bot.xyz**

Documentation includes:

- Command reference
- Configuration guides
- Self-hosting instructions
- Development architecture

---

# 🌌 Theming & Lore

Xeno Bot takes inspiration from the **Alien franchise**, bringing a biomechanical sci-fi atmosphere to Discord servers.

The bot’s design and concept revolve around the mysterious **Xenomorph species**, advanced technology, and deep space exploration themes.

Future features may expand on this theme with:

- Alien-inspired commands
- Sci-fi economy elements
- Interactive lore systems

---

# 🛠 Self Hosting

If you want to run your own instance of Xeno Bot:

### Requirements

- Node.js **18+**
- A Discord bot token
- npm

### Installation

Clone the repository:

```bash
git clone https://github.com/devvyyxyz/xeno-bot.git
cd xeno-bot
````

Install dependencies:

```bash
npm install
```

Create your environment file:

```bash
cp .env.example .env
```

Fill in your bot credentials inside `.env`.

Start the bot:

```bash
npm start
```

---

### Redis (optional but recommended)

Xeno Bot can use Redis for background job queues, caching, and faster pub/sub operations. Redis is optional for many core features, but recommended if you plan to run workers or use queue-backed features.

- Environment vars:
- `REDIS_URL` — full connection URL (overrides host/port/password)
- `REDIS_HOST` — host (default: `127.0.0.1`)
- `REDIS_PORT` — port (default: `6379`)
- `REDIS_PASSWORD` — password (optional)
- `AUTO_START_REDIS` — when set to `1` for development scripts, the bot will attempt to auto-start Redis (Docker or local `redis-server`) and wait briefly for readiness. Default is controlled in `.env`.
- `AUTO_START_REDIS_TIMEOUT_MS` — timeout for auto-start helper (milliseconds)
- `REDIS_REQUIRED` — when set to `1|true|yes`, startup will fail if Redis is not reachable.

If you don't run Docker on your machine, the auto-start helper will try to spawn a local `redis-server` binary (if installed).

Platform-specific quick-start

- macOS (Homebrew)

```bash
# If you don't have Homebrew, install it first:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# Install and start Redis:
brew install redis
brew services start redis
# Verify
redis-cli ping # should reply PONG
```

- Linux (Debian/Ubuntu)

```bash
sudo apt update
sudo apt install redis-server
sudo systemctl enable --now redis-server
redis-cli ping
```

- Windows

Use WSL and follow the Linux steps inside the WSL shell, or run Redis via Docker:

```bash
docker run -p 6379:6379 --name xeno-redis -d redis:7-alpine
redis-cli -h 127.0.0.1 ping
```

- Docker (cross-platform)

```bash
docker run -p 6379:6379 --name xeno-redis -d redis:7-alpine
redis-cli -h 127.0.0.1 ping
```

To disable auto-start in development, set `AUTO_START_REDIS=0` in your `.env` file.

- Dev note: See the developer Redis guide for local-dev limitations and recommendations: [docs/DEV_REDIS.md](docs/DEV_REDIS.md)

# 🤝 Contributing

Contributions are welcome and appreciated.

If you'd like to contribute:

1. Fork the repository
2. Create a new branch

```
git checkout -b feature/my-feature
```

3. Commit your changes
4. Push your branch
5. Open a Pull Request

Please open an **issue first** if you're planning a large feature or change.

---

# 🐛 Issues & Support

If you encounter bugs or problems:

### GitHub Issues

Report bugs or request features here:

[https://github.com/devvyyxyz/xeno-bot/issues](https://github.com/devvyyxyz/xeno-bot/issues)

### Support Server

Join the community support server: https://discord.gg/WmFDeMKvzj

---

# ⭐ Star History

If you like the project, consider **starring the repository**.

Star growth over time:

[![Star History Chart](https://api.star-history.com/svg?repos=devvyyxyz/xeno-bot\&type=Date)](https://star-history.com/#devvyyxyz/xeno-bot&Date)

---

# 📄 License

This project is licensed under the **MIT License**.

See the full license here:

[https://github.com/devvyyxyz/xeno-bot/blob/main/LICENSE](https://github.com/devvyyxyz/xeno-bot/blob/main/LICENSE)