forked from waifu/kemoverse
readme update
This commit is contained in:
parent
d5de73cf22
commit
6aa0bf704d
2 changed files with 48 additions and 14 deletions
62
readme.md
62
readme.md
|
@ -1,23 +1,57 @@
|
|||
# Readme
|
||||
# Kemoverse
|
||||
|
||||
To-do:
|
||||
- Whitelist system for users
|
||||
- Time limitation on rolls
|
||||
A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Currently designed for use with Misskey. Name comes from Kemonomimi and Fediverse.
|
||||
|
||||
Long term:
|
||||
- Trading
|
||||
- Card burning
|
||||
- Favorite characters
|
||||
- Public post for rare cards
|
||||
- Leaderboards
|
||||

|
||||
|
||||
## 🔧 Features
|
||||
|
||||
### ✅ Implemented
|
||||
- 🎲 Character roll system
|
||||
- 🎴 Cards stats system
|
||||
- 🧠 Core database structure for characters and stats
|
||||
- 📦 Basic support for storing pulls per user
|
||||
|
||||
### 🧩 In Progress
|
||||
- 📝 Whitelist system to limit access
|
||||
- ⏱️ Time-based limitations on rolls
|
||||
- ⚔️ Dueling system
|
||||
|
||||
## 🧠 Planned Features (Long Term)
|
||||
|
||||
### 🛒 Gameplay & Collection
|
||||
- 🔁 **Trading system** between users
|
||||
- ⭐ **Favorite characters** (pin them or set profiles)
|
||||
- 📢 **Public post announcements** for rare card pulls
|
||||
- 🧮 **Leaderboards**
|
||||
- Most traded Characters
|
||||
- Most owned Characters
|
||||
- Most voted Characters
|
||||
- Most popular Characters
|
||||
- Most popular Characters (via usage-based popularity metrics)
|
||||
- Users with the rarest Characters
|
||||
- Simple card template
|
||||
- Website to place images in the card
|
||||
- Add Pleroma support
|
||||
|
||||
### 🎨 Card Aesthetics
|
||||
- 🖼️ Simple card template for character rendering
|
||||
- 🌐 Web app to generate cards from images
|
||||
|
||||
### 🌍 Fediverse Support
|
||||
✅ Anyone from the fediverse can play, but the server only works using a Misskey instance. Want to rewrite the program in Elixir for Pleroma? Let us know!
|
||||
|
||||
## 🗃️ Tech Stack
|
||||
|
||||
- Python (3.11+)
|
||||
- SQLite
|
||||
- Fediverse API integration (via Misskey endpoints)
|
||||
- Flask
|
||||
- Modular DB design for extensibility
|
||||
|
||||
## 💡 Philosophy
|
||||
|
||||
The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and duel tactics.
|
||||
|
||||
## 🧪 Getting Started (coming soon)
|
||||
|
||||
Instructions on installing dependencies, initializing the database, and running the bot locally will go here.
|
||||
|
||||
|
||||
```mermaid
|
||||
|
|
BIN
web/static/logo.png
Normal file
BIN
web/static/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 100 KiB |
Loading…
Add table
Reference in a new issue