11# steamcountsnotifyd
22SteamCountsNotifyD is a notification daemon written in Rust that notifies you when your selected game(s) gets some player activity
33
4- * Development release: v0.0.4 - Alpha
5- * Current release: v0.0.2 - Alpha
4+ * Current release: v0.0.4 - Alpha
5+ * (In-Development) Next release: v0.0.5 - Alpha
66
77## License
88SteamCountsNotifyD is released under a the [ GNU General Public License v3.0] ( https://www.gnu.org/licenses/gpl-3.0.html ) a free software copyleft license.
99
1010## Dependencies
11+ * serde, serde\_ json, toml, dirs-next, notify-rust, clap, reqwest, tokio, futures, a2s
12+ * All apart from a2s are available on [ crates.io] ( https://crates.io/ )
13+ * a2s: [ a2s-rs repo] ( https://github.com/rumblefrog/a2s-rs )
1114
1215## Requirements to build
13- * [ rust] ( https://www.rust-lang.org/ )
16+ * [ Rust] ( https://www.rust-lang.org/ )
17+ * Just install with the instructions straight from the site. The compiler and cargo should be provided by default.
1418
1519## Instructions
16- ### Compile
17- * ` cd steamcountsnotifyd `
18- * ` cargo build `
19- ### Install
20- * ` cargo install `
20+ ### Compile and Install
21+ * ` cargo install --path . `
2122### Uninstall
2223* ` cargo uninstall `
2324
@@ -27,6 +28,7 @@ SteamCountsNotifyD is released under a the [GNU General Public License v3.0](htt
2728## Configuration
2829* Uses xdg directory: ` $HOME/.config/steamcountsnotifyd/config.toml `
2930* Program will generate the configuration file if user requested via ` --generate-config ` and is not available
31+
3032### Parameters
3133CLI | Name | Description
3234---|---|---
@@ -35,8 +37,7 @@ CLI | Name | Description
3537` -c ` | ` connection_timeout ` | How long in seconds the connection stay puts.
3638` -n ` | ` notify_timeout ` | How long in seconds the notification stays shown.
3739` -a ` | ` action_type ` | Which type of clickable notification should use: 0 - click, 1 - button
38- ` -d ` | ` daemonize ` | This flag makes the program daemonize
39- ` -g ` | ` generate ` | Generates configuration file at default directory
40+
4041### Example
4142```
4243interval = 1
@@ -63,16 +64,19 @@ threshold = 0
6364### systemd
6465* Use the systemd daemon as under user control, more information: [ systemd/User - ArchWiki] ( https://wiki.archlinux.org/index.php/systemd/User )
6566
66- ## TODO (Possible future features)
67- * SOON: Per server notification
67+ ## TODO
68+ * Edit configuration via the CLI
6869* Improving on the Windows port
6970* Better documentation and comments
7071* Making it work with systemd properly
7172 * Support reload function
7273* Support runit and openrc also, sysvinit won't be however
74+ * Configuration: More controls can be given for per game/server
75+ * EX: Give interval for each game/server
7376
7477## Releases
75- ### v0.0.4 Alpha (Rust Rewrite)
78+ ### v0.0.4 Alpha (First Version of Rust Rewrite)
79+ * 2021-03-01: Daemon option and forking/daemonization process removed
7680* Using [ a2s-rs] ( https://github.com/rumblefrog/a2s-rs ) library to do Source A2S Queries
7781 * Can now query from each server
7882* Roughly working and ported to Windows 10
@@ -82,10 +86,12 @@ threshold = 0
8286 * NOTE: Daemon is there but counter notification not working and CLI flag different/switched
8387 * Non-daemon is by default
8488* 2021-02-22: Initial rewrite to Rust
89+
8590### v0.0.3 Alpha (Final C++ Version, Unreleased)
8691* Notification hint set to "resident", meaning the game launcher is clickable even if after the notification goes away
8792 * However only usable if only "default" (default anyway) is set
8893* Notifies that the daemon started up
94+
8995### v0.0.2 Alpha
9096* counts to count (grammar fix)
9197* systemd service file available, but buggy at the moment (need ` restart ` after a ` start ` )
@@ -94,6 +100,7 @@ threshold = 0
94100* Added the ability to launch the game (` default ` or ` clicked ` options available)
95101 * Added ` actiontype ` to configuration and command-line paramter
96102 * 0 = default, 1 = clicked
103+
97104### v0.0.1 Alpha
98105* First release
99106* Basic daemon implementation implemented
0 commit comments