From: Skye Kelley <10640425-sb24kelley@users.noreply.gitlab.com> Date: Mon, 8 Dec 2025 20:33:32 +0000 (-0500) Subject: Add readme and license X-Git-Url: https://skyeroc.xyz/gitweb/?a=commitdiff_plain;h=74c03d14079d52f772f5f9ee7420846c20c6c00f;p=obs-ctl Add readme and license --- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9a77a83 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2025 Skye Kelley + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a328e24 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# obs-ctl # +This is a console OBS WebSocket interface I made for personal use. + +To install: `pip install git+https://gitlab.com/sb24kelley/obs-ctl.git@1.0.0` + +Then, in your console (eg PowerShell, or Terminal on Linux), type `obs-ctl`. + +If you're on some flavor of Debian linux, you might have to force it through, "at the risk of breaking the system--" or just use a virtual environment. + +## Features ## +Basic controls and output!!! + +![A screenshot of obs-ctl]() + +Change window size at will!!! + +![A screenshot of obs-ctl in a small window]() +![A screenshot of an even smaller window]() + +Slightly-customizable!!! + +![A screenshot of a different theme]() \ No newline at end of file diff --git a/doc/screenshots/Screenshot 2025-12-08 152502.png b/doc/screenshots/Screenshot 2025-12-08 152502.png new file mode 100644 index 0000000..b695cc9 Binary files /dev/null and b/doc/screenshots/Screenshot 2025-12-08 152502.png differ diff --git a/doc/screenshots/Screenshot 2025-12-08 152647.png b/doc/screenshots/Screenshot 2025-12-08 152647.png new file mode 100644 index 0000000..9bcca25 Binary files /dev/null and b/doc/screenshots/Screenshot 2025-12-08 152647.png differ diff --git a/doc/screenshots/Screenshot 2025-12-08 152708.png b/doc/screenshots/Screenshot 2025-12-08 152708.png new file mode 100644 index 0000000..9fca507 Binary files /dev/null and b/doc/screenshots/Screenshot 2025-12-08 152708.png differ diff --git a/doc/screenshots/Screenshot 2025-12-08 152747.png b/doc/screenshots/Screenshot 2025-12-08 152747.png new file mode 100644 index 0000000..7725e23 Binary files /dev/null and b/doc/screenshots/Screenshot 2025-12-08 152747.png differ