documentation update for configurable backends

This commit is contained in:
Moon 2025-06-12 11:26:10 +09:00
parent dac05a3ed8
commit b2ca6dd59a
2 changed files with 9 additions and 7 deletions

View file

@ -33,3 +33,5 @@ User = @bot@example.tld
; Generate one by going to Settings > API > Generate access token ; Generate one by going to Settings > API > Generate access token
Token = abcdefghijklmnopqrstuvwxyz012345 Token = abcdefghijklmnopqrstuvwxyz012345
; Instance type - either "misskey" or "pleroma"
InstanceType = misskey

View file

@ -1,6 +1,6 @@
# Kemoverse # Kemoverse
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. A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Supports both Misskey and Pleroma instances. Name comes from Kemonomimi and Fediverse.
<p align="center"> <p align="center">
<img src="./web/static/logo.png" alt="Fediverse Gacha Bot Logo" width="300" height="auto"> <img src="./web/static/logo.png" alt="Fediverse Gacha Bot Logo" width="300" height="auto">
</p> </p>
@ -47,13 +47,13 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
- 🌐 Web app to generate cards from images - 🌐 Web app to generate cards from images
### 🌍 Fediverse Support ### 🌍 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! ✅ Anyone from the fediverse can play! The bot supports both Misskey and Pleroma instances through configurable backends.
## 🗃️ Tech Stack ## 🗃️ Tech Stack
- Python (3.12+) - Python (3.12+)
- SQLite - SQLite
- Fediverse API integration (via Misskey endpoints) - Fediverse API integration (Misskey and Pleroma support)
- Flask - Flask
- Modular DB design for extensibility - Modular DB design for extensibility
@ -65,12 +65,12 @@ The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and
flowchart TD flowchart TD
subgraph Player Interaction subgraph Player Interaction
A1[Misskey bot] A1[Fediverse bot]
A2[Web] A2[Web]
end end
subgraph Misskey subgraph Fediverse
B1[Misskey instance] B1[Fediverse instance]
end end
subgraph Bot subgraph Bot
@ -78,7 +78,7 @@ flowchart TD
C2[Notification parser] C2[Notification parser]
C3[Gacha roll logic] C3[Gacha roll logic]
C4[Database interface] C4[Database interface]
C5[Misskey API poster] C5[Fediverse API poster]
end end
subgraph Website subgraph Website