diff --git a/readme.md b/readme.md index 9da5b60..cf4470c 100644 --- a/readme.md +++ b/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 +![Fediverse Gacha Bot Logo](./web/static/logo.png) + +## ๐Ÿ”ง 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 diff --git a/web/static/logo.png b/web/static/logo.png new file mode 100644 index 0000000..a94cfdb Binary files /dev/null and b/web/static/logo.png differ