From f101119b47ae89bf57a334b62458826b273cdd65 Mon Sep 17 00:00:00 2001 From: Moon Date: Thu, 12 Jun 2025 11:26:10 +0900 Subject: [PATCH] documentation update for configurable backends --- example_config.ini | 3 +++ readme.md | 14 +++++++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/example_config.ini b/example_config.ini index 4412c92..aa93e07 100644 --- a/example_config.ini +++ b/example_config.ini @@ -10,6 +10,9 @@ ApiKey = abcdefghijklmnopqrstuvwxyz012345 ; Fully qualified URL of the instance hosting the bot InstanceUrl = http://example.tld +; Instance type - either "misskey" or "pleroma" +InstanceType = misskey + ; Comma separated list of fedi handles for any administrator users DefaultAdmins = ['admin@example.tld'] diff --git a/readme.md b/readme.md index cf4470c..fdfc649 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ # 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. ![Fediverse Gacha Bot Logo](./web/static/logo.png) @@ -35,13 +35,13 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac - 🌐 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! +✅ Anyone from the fediverse can play! The bot supports both Misskey and Pleroma instances through configurable backends. ## 🗃️ Tech Stack - Python (3.11+) - SQLite -- Fediverse API integration (via Misskey endpoints) +- Fediverse API integration (Misskey and Pleroma support) - Flask - Modular DB design for extensibility @@ -58,12 +58,12 @@ Instructions on installing dependencies, initializing the database, and running flowchart TD subgraph Player Interaction - A1[Misskey bot] + A1[Fediverse bot] A2[Web] end - subgraph Misskey - B1[Misskey instance] + subgraph Fediverse + B1[Fediverse instance] end subgraph Bot @@ -71,7 +71,7 @@ flowchart TD C2[Notification parser] C3[Gacha roll logic] C4[Database interface] - C5[Misskey API poster] + C5[Fediverse API poster] end subgraph Website