app_lisium/README.md
2025-11-01 13:34:11 -05:00

26 lines
1.3 KiB
Markdown

# DND Character/Item/Feat Creator & Maintainer
This project is a Dungeons & Dragons 5th Edition (DND5e) companion app focused on character management and creation. It provides a backend structure for modeling, storing, and manipulating DND entities such as characters, items, feats, and other attributes.
## Features
- Define and manage base and derived character attributes based on DND5e rules
- Extensible backend ready for API or web interface integration
- Support for custom skills, resistances, and multi-stage attribute calculation
- User management for storing player profiles and multiple characters
## Tech Overview
- Python backend (main.py entrypoint)
- Modular architecture for standalone backend or combined webapp use
- Flexible data model designed for expansion
## Database Model Highlights
- USERS: Stores user profiles (UUID, username, password, type, profile picture, flags)
- CHARACTERS: Stores character data, linked to user IDs
- Detailed separation of base, derived, child, and passive attributes for robust computation and extension
## Getting Started
1. Clone the repo
2. Run with `python main.py`
3. Add dependencies or tests as needed (see AGENTS.md for agent and style guidelines)
> This project is evolving! Please see backend/README.md for detailed schema notes. Contributions and suggestions are welcome.