https://github.com/texnoforge/wopvault
Words of Power Vault
https://github.com/texnoforge/wopvault
Last synced: about 2 months ago
JSON representation
Words of Power Vault
- Host: GitHub
- URL: https://github.com/texnoforge/wopvault
- Owner: texnoforge
- License: mit
- Created: 2024-01-30T05:16:30.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T01:39:15.000Z (over 2 years ago)
- Last Synced: 2025-01-25T13:41:45.385Z (over 1 year ago)
- Language: Python
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Words of Power Vault
This is a trivial Python 3.10+ FastAPI server with a singular purpose of
colleting user generated [Words of Power] / [TexnoMagic] content.
This software can be used to collect user drawings as a series of points through
a REST API and save them into CSV files for further processing.
See [woptrainer] for a Godot client implemention.
## Status: alpha
It seems to work fine :)
## Installation
This is a standard python package.
Install with `pip` or `pipx` in the repo root:
pip install .
## Configuration
You can configure `wopvault` through `wopvault.yaml` config files.
Please use
wopvault config
to see
- config paths for your system
- current effective configuration
## Usage
You can start `uvicorn` dev server using
wopvault server
`wopvault.api` is based on FastAPI,
feel free to use `wopvault.api:app` as you need.
See [woptrainer] for a Godot client implementation.
[Words of Power]: https://texnoforge.dev/words-of-power/
[TexnoMagic]: https://texnoforge.github.io/texnomagic/
[woptrainer]: https://github.com/texnoforge/woptrainer/