pre-push commit
This commit is contained in:
28
README.md
Normal file
28
README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Battleflow
|
||||
|
||||
Refactored project layout (same features, cleaner code).
|
||||
|
||||
## Install & Run
|
||||
```bash
|
||||
pip install -e .
|
||||
battleflow --host 0.0.0.0 --port 5050 --token YOURSECRET
|
||||
```
|
||||
Open:
|
||||
- Admin: `http://HOST:PORT/admin?token=YOURSECRET`
|
||||
- Board: `http://HOST:PORT/board?token=YOURSECRET`
|
||||
|
||||
## Data directories
|
||||
Default data folder is `battleflow_data/`. If an older `initrack_data/` exists and `battleflow_data/` isn't present, it will be reused automatically (migration-by-reuse).
|
||||
```
|
||||
battleflow_data/
|
||||
avatars/
|
||||
icons/
|
||||
state.json
|
||||
presets.json
|
||||
preset_groups.json
|
||||
```
|
||||
|
||||
## Notes
|
||||
- Admin requires `?token=...`. Board is public (use OBS Browser Source).
|
||||
- Use the Admin button to seed curated condition icons (Game-Icons.net).
|
||||
- No breaking functional changes vs. single-file.
|
||||
Reference in New Issue
Block a user