diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..292d673 --- /dev/null +++ b/docs/index.md @@ -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) + +--- + diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000..e5f8658 --- /dev/null +++ b/docs/install.md @@ -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 +``` diff --git a/docs/theme.md b/docs/theme.md new file mode 100644 index 0000000..69e9ed3 --- /dev/null +++ b/docs/theme.md @@ -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 + +

+ Fediverse Gacha Bot Logo +

+ +- File: `web/static/logo.png` +- Usage: Website header, favicon, bot avatar, watermark + + +--- \ No newline at end of file diff --git a/readme.md b/readme.md index 40d723d..437b09f 100644 --- a/readme.md +++ b/readme.md @@ -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. +

+ Fediverse Gacha Bot Logo +

-## 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