v0.2.0; License; BlankieStart event

Author: mxve

.github/webhook_join.png

@@ -1,6 +1,6 @@
 [package]
 name = "blankie"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2024"
 
 [dependencies]

.github/webhook_start.png

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 mxve
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.github/webhook_stop.png

@@ -12,13 +12,24 @@
 - schedule server commands
 - blankie is _not_ a proxy, the target server must be reachable by the user and have `accepts-transfers` enabled
 - whitelist support (monitors server whitelist, unauthorized players are rejected before transfer/server startup)
+- webhooks for events
+
 ---
 
+### table of contents
+
+- [cli args](#cli-args)
+- [example config file](#example-configtoml)
+- [webhooks](#webhooks)
+  - [events](#events)
+  - [examples](#examples)
+
 ### cli args
 
 - `--config <path>`
 
 ### example config.toml
+
 ```toml
 [server]
 java_path = "java" # java executable
@@ -49,7 +60,9 @@ bearer_token = "your-bearer-token" # bearer token (optional)
 user_agent = "blankie/0.1.0" # user agent (optional)
 ```
 
-### (webhook) events
+### webhooks
+
+#### events
 
 - `Connect`: player connected to blankie
   - `{ip}`
@@ -75,13 +88,17 @@ user_agent = "blankie/0.1.0" # user agent (optional)
   - `{uuid}`
   - `{host}`
   - `{port}`
+- `BlankieStart`: blankie started
 
-### example webhooks
+#### examples
 
 - discord
   - user join (transfer)
     - `body = "{ \"content\": null, \"embeds\": [{\"description\": \"{user} joined the server!\", \"color\": 5369975, \"author\": {\"name\": \"{user}\", \"icon_url\": \"https://mc-heads.net/avatar/{uuid}\"}}], \"attachments\": []}"`
+    ![](.github/webhook_join.png)
   - server start
     - `body = "{ \"content\": null, \"embeds\": [{\"description\": \"Server started for {user}\", \"color\": 13652464, \"author\": {\"name\": \"blankie\", \"icon_url\": \"https://raw.githubusercontent.com/mxve/blankie/main/.github/blankie.png\"}}], \"attachments\": []}"`
+    ![](.github/webhook_start.png)
   - server stop
-    - `body = "{ \"content\": null, \"embeds\": [{\"description\": \"Server stopped\", \"color\": 15749463, \"author\": {\"name\": \"blankie\", \"icon_url\": \"https://raw.githubusercontent.com/mxve/blankie/main/.github/blankie.png\"}}], \"attachments\": []}"`
+    - `body = "{ \"content\": null, \"embeds\": [{\"description\": \"Server stopped\", \"color\": 15749463, \"author\": {\"name\": \"blankie\", \"icon_url\": \"https://raw.githubusercontent.com/mxve/blankie/main/.github/blankie.png\"}}], \"attachments\": []}"`
+    ![](.github/webhook_stop.png)

Cargo.lock

@@ -38,6 +38,7 @@ pub enum Event {
     },
     ServerEmpty,
     ServerUp,
+    BlankieStart,
 }
 
 impl Event {
@@ -78,6 +79,7 @@ impl Event {
             Event::Action { msg } => ("blankie", msg.clone()),
             Event::ServerEmpty => ("blankie", "Server is now empty".into()),
             Event::ServerUp => ("blankie", "Target server reached online status".into()),
+            Event::BlankieStart => ("blankie", "Blankie has started".into()),
         }
     }
 

Cargo.toml

@@ -51,10 +51,6 @@ async fn main() -> std::io::Result<()> {
         whitelist: RwLock::new(HashSet::new()),
     });
 
-    state.events.emit(Event::Action {
-        msg: "blankie started".into(),
-    });
-
     let s = state.clone();
     tokio::spawn(async move {
         server::monitor_loop(s).await;
@@ -67,6 +63,7 @@ async fn main() -> std::io::Result<()> {
 
     let l = TcpListener::bind(&cfg.blankie.bind_addr).await?;
     println!("blankie started on {}", cfg.blankie.bind_addr);
+    state.events.emit(Event::BlankieStart);
 
     loop {
         let (stream, addr) = l.accept().await?;