Merge pull request #6 from unsecretised/configuration-files

Configuration files... WOOOHOOOO!!!

Author: unsecretised

Cargo.lock

@@ -14,7 +14,9 @@ objc2 = "0.6.3"
 objc2-app-kit = "0.3.2"
 objc2-foundation = "0.3.2"
 rand = "0.9.2"
+serde = { version = "1.0.228", features = ["derive"] }
 tokio = { version = "1.48.0", features = ["full"] }
+toml = "0.9.8"
 
 [package.metadata.bundle]
 name = "RustCast"

Cargo.toml

@@ -1,7 +1,18 @@
 Copyright 2025 Umang Surana
 
-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:
+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 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.
+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.

LICENSE.md

@@ -14,19 +14,24 @@
 3. Open it, and if there is a "this app is damaged", run the command
    `xattr -cr <RustCast.app directory here>`
 
+## Config:
+
+The config file should be located at: `~/.config/rustcast/config.toml` RustCast
+doesn't create the default configuration for you, but it does use its
+[default options](docs/default.toml) Here's a full list of what all you can
+configure [The list](docs/config.toml) The blurring and background is still a
+bit wonky, and will be fixed in the upcoming releases
+
 ## Feature list:
 
 ### Planned:
 
-- [ ] Tray Icon for quitting the app 12/12/2025
 - [ ] Select the options using arrow keys 13/12/2025
 - [ ] Calculator 15/12/2025
 - [ ] Popup note-taking 18/12/2025
 - [ ] Clipboard History 20/12/2025
-- [ ] Customisable themes (21/12/2025)
-  - [ ] Blur / transparent background
-  - [ ] Configurable colours for selected option
 - [ ] Plugin Support 31/12/2025
+- [ ] Blur / transparent background (Partially implemented on 13/12/2025)
 
 ### Finished:
 
@@ -36,6 +41,13 @@
       the app. Simply type `randomvar` and it will generate the num for you
 - [x] Image icons next to the text 13/12/2025
 - [x] Scrollable options 12/12/2025
+- [x] Customisable themes (13/12/2025)
+  - [x] Configurable colours
+
+### Not Planned:
+
+- [ ] Tray Icon for quitting the app. One may ask why? Well, because I CAN'T GET
+      IT TO WORK.. I've SPENT TOO LONG ON THIS
 
 ## Motivations:
 

README.md

@@ -0,0 +1,26 @@
+# Things you can configure
+
+# Full list of modifiers: https://docs.rs/global-hotkey/0.7.0/global_hotkey/hotkey/struct.Modifiers.html#impl-Modifiers
+# Do note, CMD is Super on MacOS
+# If you are not sure, use google or GenAI to find out.
+toggle_mod = "SHIFT"
+
+# Full list of keys: https://docs.rs/global-hotkey/0.7.0/global_hotkey/hotkey/enum.Code.html#variants
+# Same things as Modifiers, google if unsure. If something should work, but isn't working, open an issue and I'll help
+toggle_key = "1"
+placeholder = "Oopsie Dasies"
+
+# Buffer (all fields are optional bools)
+clear_on_hide = false
+clear_on_enter = true
+
+[theme]
+
+text_color = [0.95, 0.95, 0.96]
+background_color = [0.11, 0.11, 0.13]
+
+background_opacity = 1.0
+
+blur = false
+show_icons = true
+show_scroll_bar = true

docs/config.toml

@@ -0,0 +1,17 @@
+# Default Config
+
+toggle_mod = "ALT"
+toggle_key = "Space"
+placeholder = "Time to be productive!"
+
+[buffer_rules]
+clear_on_hide = true
+clear_on_enter = true
+
+[theme]
+text_color = [0.95, 0.95, 0.96]
+background_color = [0.11, 0.11, 0.13]
+background_opacity = 1.0
+blur = false
+show_icons = true
+show_scroll_bar = true