Compare commits

...

4 commits

Author SHA1 Message Date
w
fa21ce201d Theme and visual identity 2025-06-10 00:32:53 -03:00
w
62cc80033d docs 2025-06-10 00:23:28 -03:00
w
3626949020 cleaned readme 2025-06-09 23:59:12 -03:00
w
bad06c4f23 docs index 2025-06-09 23:40:37 -03:00
4 changed files with 148 additions and 87 deletions

24
docs/index.md Normal file
View file

@ -0,0 +1,24 @@
# 🎲 Kemoverse Documentation
Welcome to the developer documentation for **Kemoverse**, a gacha trading card game in the Fediverse!
Features collectible cards, rarity-based pulls, and integration with Misskey.
Name comes from Kemonomimi and Fediverse.
---
## 📁 Table of Contents
- [Installation](./install.md)
- [Game Design](./design.md)
- [Bot Architecture](./bot.md)
- [Database Structure](./database.md)
- [Card System](./cards.md)
- [Web UI](./web.md)
- [Theming and Assets](./theme.md)
- [Contributing](./contributing.md)
- [FAQ](./faq.md)
---

83
docs/install.md Normal file
View file

@ -0,0 +1,83 @@
## 🧪 Installation
### Download and install dependencies
Clone the repo
```sh
git clone https://git.waifuism.life/waifu/kemoverse.git
cd kemoverse
```
Setup a virtual environment (Optional, recommended)
```sh
python3 -m venv venv
source venv/bin/activate
```
Install project dependencies via pip
```sh
python3 -m pip install -r requirements.txt
```
### Setup config file
A sample config file is included with the project as a template: `example_config.ini`
Create a copy of this file and replace its' values with your own. Consult the
template for more information about individual config values and their meaning.
Config files are environment-specific. Use `config_dev.ini` for development and
`config_prod.ini` for production. Switch between environments using the
`KEMOVERSE_ENV` environment variable.
```sh
cp example_config.ini config_dev.ini
# Edit config_dev.ini
```
### Setup database
To set up the database, run:
```sh
KEMOVERSE_ENV=dev python3 setup_db.py
```
### Run the bot
```sh
KEMOVERSE_ENV=dev ./startup.sh
```
If all goes well, you should now be able to interact with the bot.
### Running in production
To run the the in a production environment, use `KEMOVERSE_ENV=prod`. You will
also need to create a `config_prod.ini` file and run the database setup step
again if pointing prod to a different database. (you are pointing dev and prod
to different databases, right? 🤨)
### Updating
To update the bot, first pull new changes from upstream:
```sh
git pull
```
Then run any database migrations. We recommend testing in dev beforehand to
make sure nothing breaks in the update process.
**Always backup your prod database before running any migrations!**
```sh
# Backup database file
cp gacha_game_dev.db gacha_game_dev.db.bak
# Run migrations
KEMOVERSE_ENV=dev python3 setup_db.py
```

33
docs/theme.md Normal file
View file

@ -0,0 +1,33 @@
Welcome to the **Visual Identity** guide for the Kemoverse. This page contains the standard colors, logos, and graphic elements used across the game (cards, UI, web presence, bots, etc). Please follow these guidelines to ensure consistency.
---
## 🟢 Primary Color Palette
| Color Name | Hex Code | Usage |
|----------------|------------|--------------------------------------|
| Green | `#5aa02c` | Main buttons, links, headers |
| Midnight Black | `#1A1A1A` | Backgrounds, dark mode |
| Misty White | `#FAFAFA` | Default backgrounds, light text bg |
| Soft Gray | `#CCCCCC` | Borders, placeholders, separators |
| Highlight Green | `#8dd35f` | Alerts, emphasis, icons |
| Rarity Gold | `#FFD700` | Special rare cards, SSR outlines |
| Rarity Silver | `#C0C0C0` | Rare card text, stat glow effects |
> ✅ Use `Green` and `Misty White` for the standard UI. Avoid mixing in extra palettes unless explicitly needed.
---
## 🖼 Logos
### Main Logo
<p align="center">
<img src="../web/static/logo.png" alt="Fediverse Gacha Bot Logo" width="300" height="auto">
</p>
- File: `web/static/logo.png`
- Usage: Website header, favicon, bot avatar, watermark
---

View file

@ -1,12 +1,15 @@
# 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.
<p align="center">
<img src="./web/static/logo.png" alt="Fediverse Gacha Bot Logo" width="300" height="auto">
</p>
## Installation
## 📝 Docs
## Roadmap
👉 [**Start reading the docs**](./docs/index.md)
![Fediverse Gacha Bot Logo](./web/static/logo.png)
🤌 [**Install instructions for those in a rush**](docs/install.md)
## 🔧 Features
@ -15,10 +18,11 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
- 🧠 Core database structure for cards
- 📦 Basic support for storing pulls per player
- ⏱️ Time-based limitations on rolls
- ⚠️ Explicit account creation/deletion
### 🧩 In Progress
- 📝 Whitelist system to limit access
- ⚠️ Explicit account creation/deletion
## 🧠 Roadmap
@ -57,89 +61,6 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and duel tactics.
## 🧪 Installation
### Download and install dependencies
Clone the repo
```sh
git clone https://git.waifuism.life/waifu/kemoverse.git
cd kemoverse
```
Setup a virtual environment (Optional, recommended)
```sh
python3 -m venv venv
source venv/bin/activate
```
Install project dependencies via pip
```sh
python3 -m pip install -r requirements.txt
```
### Setup config file
A sample config file is included with the project as a template: `example_config.ini`
Create a copy of this file and replace its' values with your own. Consult the
template for more information about individual config values and their meaning.
Config files are environment-specific. Use `config_dev.ini` for development and
`config_prod.ini` for production. Switch between environments using the
`KEMOVERSE_ENV` environment variable.
```sh
cp example_config.ini config_dev.ini
# Edit config_dev.ini
```
### Setup database
To set up the database, run:
```sh
KEMOVERSE_ENV=dev python3 setup_db.py
```
### Run the bot
```sh
KEMOVERSE_ENV=dev ./startup.sh
```
If all goes well, you should now be able to interact with the bot.
### Running in production
To run the the in a production environment, use `KEMOVERSE_ENV=prod`. You will
also need to create a `config_prod.ini` file and run the database setup step
again if pointing prod to a different database. (you are pointing dev and prod
to different databases, right? 🤨)
### Updating
To update the bot, first pull new changes from upstream:
```sh
git pull
```
Then run any database migrations. We recommend testing in dev beforehand to
make sure nothing breaks in the update process.
**Always backup your prod database before running any migrations!**
```sh
# Backup database file
cp gacha_game_dev.db gacha_game_dev.db.bak
# Run migrations
KEMOVERSE_ENV=dev python3 setup_db.py
```
```mermaid
flowchart TD