Compare commits
No commits in common. "master" and "5_administrator_control" have entirely different histories.
master
...
5_administ
20 changed files with 314 additions and 514 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -185,5 +185,3 @@ cython_debug/
|
|||
gacha_game*.db
|
||||
gacha_game*.db.*
|
||||
config*.ini
|
||||
|
||||
.idea
|
||||
|
|
@ -49,8 +49,6 @@ INSTANCE = config['credentials']['Instance'].lower()
|
|||
ADMINS = json.loads(config['application']['DefaultAdmins'])
|
||||
# SQLite Database location
|
||||
DB_PATH = config['application']['DatabaseLocation']
|
||||
# Whether to enable the instance whitelist
|
||||
USE_WHITELIST = config['application']['UseWhitelist']
|
||||
|
||||
NOTIFICATION_POLL_INTERVAL = int(config['notification']['PollInterval'])
|
||||
NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
|
||||
|
|
|
|||
|
|
@ -90,9 +90,6 @@ def delete_player(username: str) -> bool:
|
|||
)
|
||||
player = CURSOR.fetchone()
|
||||
|
||||
if not player:
|
||||
return False
|
||||
|
||||
player_id = player[0]
|
||||
|
||||
# Delete pulls
|
||||
|
|
@ -110,40 +107,10 @@ def delete_player(username: str) -> bool:
|
|||
return True
|
||||
|
||||
|
||||
def ban_player(username: str) -> bool:
|
||||
'''Adds a player to the ban list.'''
|
||||
try:
|
||||
CURSOR.execute(
|
||||
'INSERT INTO banned_players (handle) VALUES (?)',
|
||||
(username,)
|
||||
)
|
||||
return True
|
||||
except sqlite3.IntegrityError:
|
||||
return False
|
||||
|
||||
|
||||
def unban_player(username: str) -> bool:
|
||||
'''Removes a player from the ban list.'''
|
||||
def is_player_administrator(player_id: int) -> bool:
|
||||
CURSOR.execute(
|
||||
'DELETE FROM banned_players WHERE handle = ?',
|
||||
(username,)
|
||||
)
|
||||
return CURSOR.rowcount > 0
|
||||
|
||||
|
||||
def is_player_banned(username: str) -> bool:
|
||||
CURSOR.execute(
|
||||
'SELECT * FROM banned_players WHERE handle = ?',
|
||||
(username,)
|
||||
)
|
||||
row = CURSOR.fetchone()
|
||||
return row is not None
|
||||
|
||||
|
||||
def is_player_administrator(username: str) -> bool:
|
||||
CURSOR.execute(
|
||||
'SELECT is_administrator FROM players WHERE username = ? LIMIT 1',
|
||||
(username,)
|
||||
'SELECT is_administrator FROM PLAYERS WHERE id = ? LIMIT 1',
|
||||
(player_id,)
|
||||
)
|
||||
row = CURSOR.fetchone()
|
||||
return row[0] if row else False
|
||||
|
|
@ -179,36 +146,6 @@ DESC",
|
|||
return row[0] if row else 0
|
||||
|
||||
|
||||
def add_to_whitelist(instance: str) -> bool:
|
||||
'''Adds an instance to the whitelist, returns false if instance was already
|
||||
present'''
|
||||
try:
|
||||
CURSOR.execute(
|
||||
'INSERT INTO instance_whitelist (tld) VALUES (?)', (instance,)
|
||||
)
|
||||
return True
|
||||
except sqlite3.IntegrityError:
|
||||
return False
|
||||
|
||||
|
||||
def remove_from_whitelist(instance: str) -> bool:
|
||||
'''Removes an instance to the whitelist, returns false if instance was not
|
||||
present'''
|
||||
CURSOR.execute(
|
||||
'DELETE FROM instance_whitelist WHERE tld = ?', (instance,))
|
||||
return CURSOR.rowcount > 0
|
||||
|
||||
|
||||
def is_whitelisted(instance: str) -> bool:
|
||||
'''Checks whether an instance is in the whitelist'''
|
||||
if instance == 'local':
|
||||
return True
|
||||
CURSOR.execute(
|
||||
'SELECT * FROM instance_whitelist WHERE tld = ?', (instance,))
|
||||
row = CURSOR.fetchone()
|
||||
return row is not None
|
||||
|
||||
|
||||
def get_config(key: str) -> str:
|
||||
'''Reads the value for a specified config key from the db'''
|
||||
CURSOR.execute("SELECT value FROM config WHERE key = ?", (key,))
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ from typing import Dict, Any
|
|||
import misskey
|
||||
from misskey.exceptions import MisskeyAPIException
|
||||
|
||||
from config import NOTIFICATION_BATCH_SIZE, USE_WHITELIST
|
||||
from config import NOTIFICATION_BATCH_SIZE
|
||||
from parsing import parse_notification
|
||||
from db_utils import get_config, set_config, is_whitelisted, is_player_banned
|
||||
from db_utils import get_config, set_config
|
||||
from response import generate_response
|
||||
from custom_types import BotResponse
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ def process_notification(
|
|||
host = user.get('host') # None if local user
|
||||
instance = host if host else 'local'
|
||||
|
||||
if USE_WHITELIST and not is_whitelisted(instance):
|
||||
if not (instance in WHITELISTED_INSTANCES or instance == 'local'):
|
||||
print(f'⚠️ Blocked notification from untrusted instance: {instance}')
|
||||
return
|
||||
|
||||
|
|
@ -44,11 +44,6 @@ def process_notification(
|
|||
if not parsed_notification:
|
||||
return
|
||||
|
||||
author = parsed_notification['author']
|
||||
if is_player_banned(author):
|
||||
print(f'⚠️ Blocked notification from banned player: {author}')
|
||||
return
|
||||
|
||||
# Get the note Id to reply to
|
||||
note_id = notification.get('note', {}).get('id')
|
||||
|
||||
|
|
|
|||
|
|
@ -24,8 +24,6 @@ def parse_notification(
|
|||
note_id = note_obj.get("id")
|
||||
|
||||
note = note_text.strip().lower() if note_text else ""
|
||||
# Split words into tokens
|
||||
parts = note.split()
|
||||
|
||||
# Check for both short and fully-qualified name mentions
|
||||
username_variants = [
|
||||
|
|
@ -33,16 +31,18 @@ def parse_notification(
|
|||
f'@{config.USER.split("@")[1]}'
|
||||
]
|
||||
|
||||
# Notifs must consist of the initial mention and at least one other token
|
||||
if len(parts) <= 1:
|
||||
# Make sure the notification text explicitly mentions the bot
|
||||
if not any(variant in note for variant in username_variants):
|
||||
return None
|
||||
|
||||
# Make sure the first token is a mention to the bot
|
||||
if not parts[0] in username_variants:
|
||||
return None
|
||||
# Find command and arguments after the mention
|
||||
# Removes all mentions
|
||||
# regex = mentions that start with @ and may contain @domain
|
||||
cleaned_text = re.sub(r"@\w+(?:@\S+)?", "", note).strip()
|
||||
parts = cleaned_text.split()
|
||||
|
||||
command = parts[1].lower()
|
||||
arguments = parts[2:] if len(parts) > 2 else []
|
||||
command = parts[0].lower() if parts else None
|
||||
arguments = parts[1:] if len(parts) > 1 else []
|
||||
|
||||
return {
|
||||
'author': full_user,
|
||||
|
|
|
|||
129
bot/response.py
129
bot/response.py
|
|
@ -1,6 +1,7 @@
|
|||
from datetime import datetime, timedelta, timezone
|
||||
from typing import TypedDict, Any, List, Dict
|
||||
import db_utils as db
|
||||
from db_utils import get_player, insert_player, delete_player, insert_pull, \
|
||||
get_last_rolled_at, get_random_card, is_player_administrator
|
||||
from add_card import add_card
|
||||
from config import GACHA_ROLL_INTERVAL
|
||||
from custom_types import BotResponse, ParsedNotification
|
||||
|
|
@ -8,7 +9,7 @@ from custom_types import BotResponse, ParsedNotification
|
|||
|
||||
def do_roll(author: str) -> BotResponse:
|
||||
'''Determines whether the user can roll, then pulls a random card'''
|
||||
user_id = db.get_player(author)
|
||||
user_id = get_player(author)
|
||||
if not user_id:
|
||||
return {
|
||||
'message': f'{author} 🛑 You haven’t signed up yet! Use the \
|
||||
|
|
@ -16,7 +17,7 @@ def do_roll(author: str) -> BotResponse:
|
|||
'attachment_urls': None
|
||||
}
|
||||
# Get date of user's last roll
|
||||
date = db.get_last_rolled_at(user_id)
|
||||
date = get_last_rolled_at(user_id)
|
||||
|
||||
# No date means it's users first roll
|
||||
if date:
|
||||
|
|
@ -45,7 +46,7 @@ def do_roll(author: str) -> BotResponse:
|
|||
'attachment_urls': None
|
||||
}
|
||||
|
||||
card = db.get_random_card()
|
||||
card = get_random_card()
|
||||
|
||||
if not card:
|
||||
return {
|
||||
|
|
@ -54,7 +55,7 @@ cards found. 😿',
|
|||
'attachment_urls': None
|
||||
}
|
||||
|
||||
db.insert_pull(user_id, card['id'])
|
||||
insert_pull(user_id, card['id'])
|
||||
stars = '⭐️' * card['rarity']
|
||||
return {
|
||||
'message': f'{author} 🎲 Congrats! You rolled {stars} \
|
||||
|
|
@ -65,7 +66,7 @@ cards found. 😿',
|
|||
|
||||
def do_signup(author: str) -> BotResponse:
|
||||
'''Registers a new user if they haven’t signed up yet.'''
|
||||
user_id = db.get_player(author)
|
||||
user_id = get_player(author)
|
||||
|
||||
if user_id:
|
||||
return {
|
||||
|
|
@ -74,7 +75,7 @@ begin~ 🎲',
|
|||
'attachment_urls': None
|
||||
}
|
||||
|
||||
new_user_id = db.insert_player(author)
|
||||
new_user_id = insert_player(author)
|
||||
return {
|
||||
'message': f'{author} ✅ Signed up successfully! Your gacha \
|
||||
destiny begins now... ✨ Use the roll command to start!',
|
||||
|
|
@ -155,7 +156,7 @@ def delete_account(author: str) -> BotResponse:
|
|||
return {
|
||||
'message': f'{author} ⚠️ This will permanently delete your account \
|
||||
and all your cards.\n'
|
||||
'If you\'re sure, reply with `confirm_delete_account` to proceed.\n\n'
|
||||
'If you’re sure, reply with `confirm_delete_account` to proceed.\n\n'
|
||||
'**There is no undo.** Your gacha luck will be lost to the void... 💀✨',
|
||||
'attachment_urls': None
|
||||
|
||||
|
|
@ -163,7 +164,7 @@ and all your cards.\n'
|
|||
|
||||
|
||||
def confirm_delete(author: str) -> BotResponse:
|
||||
db.delete_player(author)
|
||||
delete_player(author)
|
||||
|
||||
return {
|
||||
'message': f'{author} 🧼 Your account and all your cards have been \
|
||||
|
|
@ -172,89 +173,14 @@ deleted. RIP your gacha history 🕊️✨',
|
|||
}
|
||||
|
||||
|
||||
def do_whitelist(author: str, args: list[str]) -> BotResponse:
|
||||
if len(args) == 0:
|
||||
return {
|
||||
'message': f'{author} Please specify an instance to whitelist',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
if db.add_to_whitelist(args[0]):
|
||||
return {
|
||||
'message': f'{author} Whitelisted instance: {args[0]}',
|
||||
'attachment_urls': None
|
||||
}
|
||||
else:
|
||||
return {
|
||||
'message': f'{author} Instance already whitelisted: {args[0]}',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
|
||||
def do_unwhitelist(author: str, args: list[str]) -> BotResponse:
|
||||
if len(args) == 0:
|
||||
return {
|
||||
'message': f'{author} Please specify an instance to remove from \
|
||||
the whitelist',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
if db.remove_from_whitelist(args[0]):
|
||||
return {
|
||||
'message': f'{author} Unwhitelisted instance: {args[0]}',
|
||||
'attachment_urls': None
|
||||
}
|
||||
else:
|
||||
return {
|
||||
'message': f'{author} Instance not whitelisted: {args[0]}',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
|
||||
def do_ban(author: str, args: list[str]) -> BotResponse:
|
||||
if len(args) == 0:
|
||||
return {
|
||||
'message': f'{author} Please specify a user to ban',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
if db.is_player_administrator(args[0]):
|
||||
return {
|
||||
'message': f'{author} Cannot ban other administrators.',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
if db.ban_player(args[0]):
|
||||
# Delete banned player's account
|
||||
db.delete_player(args[0])
|
||||
return {
|
||||
'message': f'{author} 🔨 **BONK!** Get banned, {args[0]}!',
|
||||
'attachment_urls': None
|
||||
}
|
||||
else:
|
||||
return {
|
||||
'message': f'{author} Player is already banned: {args[0]}',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
|
||||
def do_unban(author: str, args: list[str]) -> BotResponse:
|
||||
if len(args) == 0:
|
||||
return {
|
||||
'message': f'{author} Please specify a user to unban',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
if db.unban_player(args[0]):
|
||||
return {
|
||||
'message': f'{author} Player unbanned: {args[0]}!',
|
||||
'attachment_urls': None
|
||||
}
|
||||
else:
|
||||
return {
|
||||
'message': f'{author} Player was not banned: {args[0]}',
|
||||
'attachment_urls': None
|
||||
}
|
||||
def do_admin_test(author: str) -> BotResponse:
|
||||
player_id = get_player(author)
|
||||
is_admin = is_player_administrator(player_id)
|
||||
return {
|
||||
'message': f'{author} You are {"not " if not is_admin else ""}an \
|
||||
admin.',
|
||||
'attachment_urls': None
|
||||
}
|
||||
|
||||
|
||||
def generate_response(notification: ParsedNotification) -> BotResponse | None:
|
||||
|
|
@ -264,7 +190,7 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
|
|||
# Temporary response variable
|
||||
res: BotResponse | None = None
|
||||
author = notification['author']
|
||||
player_id = db.get_player(author)
|
||||
player_id = get_player(author)
|
||||
command = notification['command']
|
||||
|
||||
# Unrestricted commands
|
||||
|
|
@ -294,25 +220,14 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
|
|||
res = delete_account(author)
|
||||
case 'confirm_delete_account':
|
||||
res = confirm_delete(author)
|
||||
case 'admin_test':
|
||||
res = do_admin_test(author)
|
||||
case _:
|
||||
pass
|
||||
|
||||
# Commands beyond this point require the user to be an administrator
|
||||
if not db.is_player_administrator(author):
|
||||
if not is_player_administrator(player_id):
|
||||
return res
|
||||
|
||||
# Admin commands
|
||||
match command:
|
||||
case 'whitelist':
|
||||
res = do_whitelist(author, notification['arguments'])
|
||||
case 'unwhitelist':
|
||||
res = do_unwhitelist(author, notification['arguments'])
|
||||
case 'ban':
|
||||
res = do_ban(author, notification['arguments'])
|
||||
case 'unban':
|
||||
res = do_unban(author, notification['arguments'])
|
||||
case _:
|
||||
pass
|
||||
|
||||
# Administrator commands go here
|
||||
return res
|
||||
|
|
|
|||
|
|
@ -1,24 +0,0 @@
|
|||
# 🎲 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)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1,83 +0,0 @@
|
|||
|
||||
## 🧪 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
|
||||
```
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
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
|
||||
|
||||
|
||||
---
|
||||
|
|
@ -2,12 +2,9 @@
|
|||
[application]
|
||||
; Comma separated list of fedi handles for any administrator users
|
||||
; More can be added through the application
|
||||
DefaultAdmins = ["@localadmin", "@remoteadmin@example.tld"]
|
||||
DefaultAdmins = ["@localadmin", "remoteadmin@example.tld"]
|
||||
; SQLite Database location
|
||||
DatabaseLocation = ./gacha_game.db
|
||||
; Whether to lmit access to the bot via an instance whitelist
|
||||
; The whitelist can be adjusted via the application
|
||||
UseWhitelist = False
|
||||
|
||||
[gacha]
|
||||
; Number of seconds players have to wait between rolls
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
CREATE TABLE IF NOT EXISTS instance_whitelist (
|
||||
tld TEXT UNIQUE PRIMARY KEY
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS banned_players (
|
||||
handle TEXT UNIQUE PRIMARY KEY
|
||||
);
|
||||
95
readme.md
95
readme.md
|
|
@ -1,15 +1,12 @@
|
|||
# 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>
|
||||
|
||||
## 📝 Docs
|
||||
## Installation
|
||||
|
||||
👉 [**Start reading the docs**](./docs/index.md)
|
||||
## Roadmap
|
||||
|
||||
🤌 [**Install instructions for those in a rush**](docs/install.md)
|
||||
|
||||
|
||||
## 🔧 Features
|
||||
|
||||
|
|
@ -18,11 +15,10 @@ 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
|
||||
|
||||
|
|
@ -61,6 +57,89 @@ 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
|
||||
|
||||
|
|
|
|||
14
web/app.py
14
web/app.py
|
|
@ -1,8 +1,6 @@
|
|||
from flask import Flask, render_template
|
||||
import sqlite3
|
||||
|
||||
from flask import Flask, render_template, abort
|
||||
from werkzeug.exceptions import HTTPException
|
||||
|
||||
app = Flask(__name__)
|
||||
DB_PATH = "./gacha_game.db" # Adjust path if needed
|
||||
|
||||
|
|
@ -11,14 +9,6 @@ def get_db_connection():
|
|||
conn.row_factory = sqlite3.Row
|
||||
return conn
|
||||
|
||||
@app.errorhandler(HTTPException)
|
||||
def handle_exception(error):
|
||||
return render_template("_error.html", error=error), error.code
|
||||
|
||||
@app.route("/i404")
|
||||
def i404():
|
||||
return abort(404)
|
||||
|
||||
@app.route('/')
|
||||
def index():
|
||||
conn = get_db_connection()
|
||||
|
|
@ -43,8 +33,6 @@ def user_profile(user_id):
|
|||
|
||||
cursor.execute('SELECT * FROM users WHERE id = ?', (user_id,))
|
||||
user = cursor.fetchone()
|
||||
if user is None:
|
||||
abort(404)
|
||||
|
||||
cursor.execute('''
|
||||
SELECT pulls.timestamp, characters.name as character_name, characters.rarity
|
||||
|
|
|
|||
|
|
@ -1,92 +0,0 @@
|
|||
body {
|
||||
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
|
||||
background-color: #f4f6fa;
|
||||
color: #333;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
header {
|
||||
background-color: #7289da;
|
||||
color: white;
|
||||
padding: 20px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
header h1 {
|
||||
margin: 0;
|
||||
font-size: 2.5em;
|
||||
}
|
||||
|
||||
header p {
|
||||
margin-top: 5px;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 800px;
|
||||
margin: 30px auto;
|
||||
padding: 20px;
|
||||
background-color: #ffffff;
|
||||
border-radius: 10px;
|
||||
box-shadow: 0 3px 10px rgba(0, 0, 0, 0.07);
|
||||
}
|
||||
|
||||
h2 {
|
||||
border-bottom: 1px solid #ccc;
|
||||
padding-bottom: 8px;
|
||||
margin-top: 30px;
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style-type: none;
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
li {
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: #2c3e50;
|
||||
font-weight: bold;
|
||||
background-color: #e3eaf3;
|
||||
padding: 8px 12px;
|
||||
border-radius: 6px;
|
||||
display: inline-block;
|
||||
transition: background-color 0.2s;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
background-color: #cdd8e6;
|
||||
}
|
||||
|
||||
.leaderboard-entry {
|
||||
margin-bottom: 8px;
|
||||
padding: 6px 10px;
|
||||
background: #f9fafc;
|
||||
border-left: 4px solid #7289da;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
margin-top: 40px;
|
||||
font-size: 0.9em;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
.note {
|
||||
background: #fcfcf0;
|
||||
border: 1px dashed #bbb;
|
||||
padding: 10px;
|
||||
border-radius: 8px;
|
||||
margin-top: 30px;
|
||||
font-size: 0.95em;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
.footer-link {
|
||||
margin: 0 10px;
|
||||
}
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='style.css') }}">
|
||||
<link rel="shortcut icon" href="{{ url_for('static', filename='logo.png') }}">
|
||||
<title>
|
||||
{% if title %}
|
||||
{{ title }}
|
||||
{% else %}
|
||||
{% block title %}{% endblock %}
|
||||
{% endif %}
|
||||
| Kemoverse
|
||||
</title>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
{% block header %}{% endblock %}
|
||||
</header>
|
||||
|
||||
<div class="container">
|
||||
{% block content %}{% endblock %}
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<a class="footer-link" href="{{ url_for('about') }}">About</a>
|
||||
<a class="footer-link" href="{{ url_for('submit_character') }}">Submit a Character</a>
|
||||
{% block footer_extra %}{% endblock %}
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
{% extends "_base.html" %}
|
||||
{% block title %}
|
||||
{{ error.code }}
|
||||
{% endblock %}
|
||||
{% block content %}
|
||||
<h2>{{ error.code }} - {{ error.name }} </h2>
|
||||
<p>{{ error.description }}</p>
|
||||
{% endblock %}
|
||||
|
|
@ -1,9 +1,13 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block content %}
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>About - Misskey Gacha Center</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>About This Gacha</h1>
|
||||
<p>This is a playful Misskey-themed gacha tracker made with Flask and SQLite.</p>
|
||||
<p>All rolls are stored, stats are tracked, and characters are added manually for now.</p>
|
||||
<p>Built with love, chaos, and way too much caffeine ☕.</p>
|
||||
<a href="{{ url_for('index') }}">← Back to Home</a>
|
||||
{% endblock %}
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -1,11 +1,110 @@
|
|||
{% extends "_base.html" %}
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Misskey Gacha Center</title>
|
||||
<style>
|
||||
body {
|
||||
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
|
||||
background-color: #f4f6fa;
|
||||
color: #333;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
{% block header %}
|
||||
<h1>Misskey Gacha Center</h1>
|
||||
<p>Track your luck. Compare your pulls. Compete with friends.</p>
|
||||
{% endblock %}
|
||||
header {
|
||||
background-color: #7289da;
|
||||
color: white;
|
||||
padding: 20px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
{% block content %}
|
||||
header h1 {
|
||||
margin: 0;
|
||||
font-size: 2.5em;
|
||||
}
|
||||
|
||||
header p {
|
||||
margin-top: 5px;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 800px;
|
||||
margin: 30px auto;
|
||||
padding: 20px;
|
||||
background-color: #ffffff;
|
||||
border-radius: 10px;
|
||||
box-shadow: 0 3px 10px rgba(0, 0, 0, 0.07);
|
||||
}
|
||||
|
||||
h2 {
|
||||
border-bottom: 1px solid #ccc;
|
||||
padding-bottom: 8px;
|
||||
margin-top: 30px;
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style-type: none;
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
li {
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: #2c3e50;
|
||||
font-weight: bold;
|
||||
background-color: #e3eaf3;
|
||||
padding: 8px 12px;
|
||||
border-radius: 6px;
|
||||
display: inline-block;
|
||||
transition: background-color 0.2s;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
background-color: #cdd8e6;
|
||||
}
|
||||
|
||||
.leaderboard-entry {
|
||||
margin-bottom: 8px;
|
||||
padding: 6px 10px;
|
||||
background: #f9fafc;
|
||||
border-left: 4px solid #7289da;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
margin-top: 40px;
|
||||
font-size: 0.9em;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
.note {
|
||||
background: #fcfcf0;
|
||||
border: 1px dashed #bbb;
|
||||
padding: 10px;
|
||||
border-radius: 8px;
|
||||
margin-top: 30px;
|
||||
font-size: 0.95em;
|
||||
color: #666;
|
||||
}
|
||||
|
||||
.footer-link {
|
||||
margin: 0 10px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<header>
|
||||
<h1>Misskey Gacha Center</h1>
|
||||
<p>Track your luck. Compare your pulls. Compete with friends.</p>
|
||||
</header>
|
||||
|
||||
<div class="container">
|
||||
|
||||
<h2>🎖️ Leaderboard: Most Rolls</h2>
|
||||
{% for user in top_users %}
|
||||
|
|
@ -26,4 +125,13 @@
|
|||
<div class="note">
|
||||
🚀 This is a fun little gacha tracker! More features coming soon. Want to help shape it?
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<a class="footer-link" href="{{ url_for('about') }}">About</a>
|
||||
<a class="footer-link" href="{{ url_for('submit_character') }}">Submit a Character</a>
|
||||
</footer>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,12 @@
|
|||
{% extends "_base.html" %}
|
||||
|
||||
{% block content %}
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Submit a Character - Misskey Gacha Center</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Submit a Character</h1>
|
||||
<p>Want to add a new character to the gacha pool?</p>
|
||||
<p>This feature will be available soon. Stay tuned!</p>
|
||||
<a href="{{ url_for('index') }}">← Back to Home</a>
|
||||
{% endblock %}
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,57 @@
|
|||
{% extends "_base.html" %}
|
||||
{% block content %}
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>{{ user['username'] }}'s Rolls</title>
|
||||
<style>
|
||||
body {
|
||||
font-family: Arial, sans-serif;
|
||||
background-color: #f4f4f8;
|
||||
margin: 0;
|
||||
padding: 20px;
|
||||
}
|
||||
.profile, .pulls {
|
||||
background-color: white;
|
||||
padding: 15px;
|
||||
border-radius: 10px;
|
||||
box-shadow: 0 0 10px rgba(0,0,0,0.1);
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
h1, h2 {
|
||||
margin-top: 0;
|
||||
}
|
||||
ul {
|
||||
list-style-type: none;
|
||||
padding: 0;
|
||||
}
|
||||
li {
|
||||
padding: 10px 0;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
.rarity {
|
||||
color: gold;
|
||||
font-weight: bold;
|
||||
margin-left: 8px;
|
||||
}
|
||||
.timestamp {
|
||||
color: #888;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
a {
|
||||
display: inline-block;
|
||||
margin-top: 20px;
|
||||
color: #333;
|
||||
text-decoration: none;
|
||||
background-color: #ddd;
|
||||
padding: 8px 12px;
|
||||
border-radius: 5px;
|
||||
}
|
||||
a:hover {
|
||||
background-color: #bbb;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div class="profile">
|
||||
<h1>{{ user['username'] }}'s Gacha Rolls</h1>
|
||||
<p>User ID: {{ user['id'] }}</p>
|
||||
|
|
@ -20,4 +72,6 @@
|
|||
</div>
|
||||
|
||||
<a href="{{ url_for('index') }}">← Back to Users</a>
|
||||
{% endblock %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue