https://github.com/arenekosreal/qdamakuengine
A Damaku Engine using PySide6
https://github.com/arenekosreal/qdamakuengine
cross-platform crossplatform damaku namedpipe pyside6 python qt qt6 qtcpserver qtnetwork socket tcp-socket unixsocket
Last synced: 6 months ago
JSON representation
A Damaku Engine using PySide6
- Host: GitHub
- URL: https://github.com/arenekosreal/qdamakuengine
- Owner: arenekosreal
- License: wtfpl
- Created: 2020-05-07T00:24:51.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T00:24:34.000Z (12 months ago)
- Last Synced: 2024-10-22T22:01:44.367Z (12 months ago)
- Topics: cross-platform, crossplatform, damaku, namedpipe, pyside6, python, qt, qt6, qtcpserver, qtnetwork, socket, tcp-socket, unixsocket
- Language: Python
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QDamakuEngine
## What is this
This is just a Damaku Engine written in PySide6
## How to use
1. Prepare poetry
See https://python-poetry.org/docs/#installation for more info.
2. Install project
Run `poetry install` in this repository
3. Build wheel
Run `poetry build` in this repository, you will find artifacts in `dist` folder
4. Install wheel
Run `python -m installer dist/*.whl` in this repository to install it.
5. Run the program
Run `qdamakuengine` in your terminal and everything should be fine.
6. Run from source
After finishing step 2, run `poetry run qdamakuengine` in this repository instead building, installing and running.
## API
Simply connect to the socket and send json string like this:
```json
{
"text": "sample-damaku"
}
```
And you should received the response like this:
```json
{
"result": 0,
"message": "Success to record damaku"
}
```
When there is something wrong, you need to check result code and message for detailed info.
# Test
Run `poetry install --with=dev` to install pytest and its plugins, then run `poetry run pytest`.
Running `poetry run pytest --cov=qdamakuengine` to get test coverage report.