Skip to content

Commit fc0494f

Browse files
authored
Update README.md
1 parent e44938d commit fc0494f

1 file changed

Lines changed: 34 additions & 8 deletions

File tree

README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,40 @@
1-
# ExampleMod
1+
# FckSessionCapture
22

3-
A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that does something.
4-
<!-- Edit to describe what your mod does and what it may solve -->
5-
<!-- If your mod solves an issue, you should link to any relevant issues on the resonite github -->
3+
A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that gives you full control over session capture privacy.
64

5+
### This Mod is to prevent SessionCaptures to be Uploaded to a minimaly secure server. This mod is meant to fix a security exploit, until the Session Orbs's API is updated and Session Captures are a API Check first, to be able to see the Image.
76

8-
## Screenshots
9-
<!-- If your mod has visible effects in the game, attach some images or video of it in-use here! Otherwise remove this section -->
7+
**FckSessionCapture** allows you to block the automatic upload and/or local generation of session thumbnails ("session captures") in Resonite. This helps protect your privacy by preventing images of your session from being uploaded to the internet or even stored locally, depending on your configuration.
8+
9+
- Block session capture in sessions labled, Private, Contacts, LAN, and Public.
10+
- Optionally block local session capture generation (Session Capture is Triggered and Cached on the Session/Host, so anyone can see the Session Capture you create, but not upload yet).
11+
- All blocking is local: only affects your client, not others in the session.
12+
13+
> **Why?**
14+
> When you are in a session, Resonite uploads a 360° image of the session to a Image Caching server. This, while a lovely feature, can be accessed by anyone with the UUID of the Image.
15+
> This UUID, can be reverse enginered to scrape the website for any images that are not dead links. Yes, this also means any Private or LAN sessions you have ever had, are/have been at some point, is seen on an WEBP image PUBLICALLY ON THE INTERNET!
16+
>This mod gives you control over when the local user opens a dashboard or Userspace UI, and sends an image of the current session to a image caching server for other sessions and people to see the Session Preview.
17+
> The Mod I've created, intends to stop sending images to the Image Caching server, and can be ether removed or considered "Legacy", until theres at minimum, an API check to see if the user is able to view the Session Image.
1018
1119
## Installation
1220
1. Install [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader).
13-
1. Place [ExampleModName.dll](https://github.com/YourGithubUsername/YourModRepoName/releases/latest/download/ExampleModName.dll) into your `rml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods` for a default install. You can create it if it's missing, or if you launch the game once with ResoniteModLoader installed it will create this folder for you.
14-
1. Start the game. If you want to verify that the mod is working you can check your Resonite logs.
21+
2. Place [FckSessionCapture.dll](https://github.com/nalathethird/Fck-SessionCapture/releases/latest/download/FckSessionCapture.dll) into your `rml_mods` folder.
22+
This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods` for a default install.
23+
You can create it if it's missing, or if you launch the game once with ResoniteModLoader installed it will create this folder for you.
24+
3. Start the game.
25+
If you want to verify that the mod is working you can check your Resonite logs for messages from `FckSessionCapture`.
26+
27+
## Configuration
28+
29+
You can configure the mod in the ResoniteModLoader mod settings UI.
30+
Options include:
31+
32+
- **Enable FckSessionCapture mod**: Master toggle for the mod.
33+
- **Allow capture in private/contacts/LAN/public sessions**: Control uploads for each session type.
34+
- **Allow local session capture**: If disabled, even local session captures are blocked (max privacy).
35+
36+
## License
37+
38+
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
39+
40+
---

0 commit comments

Comments
 (0)