45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# Spielerplus Chat Watcher
|
|
|
|
Periodically pulls chat messages from Spielerplus and informs about new ones.
|
|
|
|
## Setup
|
|
|
|
To run the script uv and Firefox need to be installed.
|
|
|
|
In a copy of this repository on the intended host machine run
|
|
|
|
```
|
|
uv sync
|
|
```
|
|
|
|
Make a copy of `.env.example` called `.env` and provide values for the environment variables.
|
|
|
|
The script can be run as a daemon using a systemd service,
|
|
defined in `spcw.service.`
|
|
To install the service copy the file to `~/.config/systemd/user/` and provide the correct path to a copy of this project as the working directory.
|
|
Then enable and start the service.
|
|
|
|
``` bash
|
|
systemctl --user enable spcw
|
|
systemctl --user start spcw
|
|
```
|
|
|
|
The service would stop if the starting user logs out.
|
|
You can prevent this by enabling user lingering for that user:
|
|
|
|
```
|
|
sudo loginctl enable-linger $USER
|
|
```
|
|
|
|
## License and Dependencies
|
|
|
|
This software is released under the AGPL3.0+ by its author,
|
|
Philipp Matthias Schäfer <philipp.matthias.schaefer@posteo.de>.
|
|
You find a copy of the license in the file LICENSE included as part of the repository/distribution of this software.
|
|
|
|
The software depends on the following Python libraries that have been published under the mentioned licenses:
|
|
|
|
- pydantic-settings (MIT)
|
|
- pydantic (MIT)
|
|
- selenium (Apache-2.0)
|