Ben/UmaCardApplication
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: expand README features, detail project structure, and refine descriptions.

Browse Source
This commit is contained in:
kiyreload27
2026-01-05 23:06:03 +00:00
parent 40047ee145
commit 6d9a3da4cc
1 changed files with 28 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -1,14 +1,15 @@
# Umamusume Support Card Manager # Umamusume Support Card Manager
A tool for managing support cards and their effects in Umamusume (Granblue Fantasy Relink). A tool for managing support cards and their effects in Umamusume.
## Features ## Features
- Web scraping of support card data from GameTora - **Cards Management**: View and manage your support cards collection.
- Database storage of card information including effects at different levels - **Deck Builder**: Build and optimize decks with your owned cards.
- GUI application for viewing and managing support cards - **Effects Search**: Search for specific effects across your owned cards (e.g., "Friendship Bonus", "Skill Pt Bonus").
- Deck building functionality - **Web Scraping**: Integrated GameTora scraper to fetch the latest card data.
- Character art downloading - **Auto-Updater**: Automatically improved application updates.
- **Maintenance Scripts**: Suite of scripts for database repair and deep scraping.
## Project Structure ## Project Structure
@@ -23,8 +24,15 @@ A tool for managing support cards and their effects in Umamusume (Granblue Fanta
│ ├── db_init.py # Database initialization │ ├── db_init.py # Database initialization
│ └── db_queries.py # Database queries │ └── db_queries.py # Database queries
├── gui/ # GUI components ├── gui/ # GUI components
│ ├── main_window.py # Main application window
│ ├── card_view.py # Card list and details view
│ ├── deck_builder.py # Deck construction view
│ ├── effects_view.py # Effects search view
│ └── ...
├── updater/ # Update checking functionality ├── updater/ # Update checking functionality
├── database/ # Database files ├── maintenance_scripts/ # Database repair and utility scripts
├── config/ # Configuration files
├── database/ # Database files storage
├── images/ # Character art images ├── images/ # Character art images
├── build/ # Build artifacts ├── build/ # Build artifacts
└── dist/ # Distribution files └── dist/ # Distribution files
@@ -32,9 +40,9 @@ A tool for managing support cards and their effects in Umamusume (Granblue Fanta
## Installation ## Installation
1. Clone the repository 1. Clone the repository.
2. Install dependencies: `pip install -r requirements.txt` 2. Install dependencies: `pip install -r requirements.txt`.
3. Run the application: `python main.py` 3. Run the application: `python main.py`.
## Usage ## Usage
@@ -44,6 +52,7 @@ python main.py
``` ```
### Scraping Mode ### Scraping Mode
To manually run the scraper:
```bash ```bash
python main.py --scrape python main.py --scrape
``` ```
@@ -51,17 +60,17 @@ python main.py --scrape
## Development ## Development
### Code Structure ### Code Structure
- `main.py`: Entry point and argument parsing - `main.py`: Entry point and argument parsing.
- `scraper/gametora_scraper.py`: Web scraping logic - `gui/`: Contains all CustomTkinter-based UI components.
- `db/db_init.py`: Database schema initialization - `db/`: Handles SQLite database interactions.
- `gui/`: GUI components (MainWindow, views, etc.) - `scraper/`: Logic for fetching data from GameTora.
- `updater/update_checker.py`: Update checking functionality - `maintenance_scripts/`: Tools for fixing database inconsistencies or re-fetching data.
### Contributing ### Contributing
1. Fork the repository 1. Fork the repository.
2. Create a feature branch 2. Create a feature branch.
3. Make your changes 3. Make your changes.
4. Submit a pull request 4. Submit a pull request.
## License ## License
MIT MIT