https://github.com/hacktix/iayb-steamfriendleaderboard
A BepInEx plugin for I Am Your Beast which adds a leaderboard that shows the record times of Steam friends who also use the mod.
https://github.com/hacktix/iayb-steamfriendleaderboard
Last synced: about 1 year ago
JSON representation
A BepInEx plugin for I Am Your Beast which adds a leaderboard that shows the record times of Steam friends who also use the mod.
- Host: GitHub
- URL: https://github.com/hacktix/iayb-steamfriendleaderboard
- Owner: Hacktix
- License: mit
- Created: 2024-12-17T10:35:24.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-17T13:10:46.000Z (over 1 year ago)
- Last Synced: 2025-02-10T16:52:19.053Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IAYB Steam Friend Leaderboard
## What's this?
A BepInEx plugin for [I Am Your Beast](https://store.steampowered.com/app/1876590/I_Am_Your_Beast/) which adds a leaderboard display to the level select screen of the game, letting you compare your best times with those of your Steam friends.
## What does it look like?
## How do I use it?
* Install [BepInEx](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.2)
* [Download the mod](https://github.com/Hacktix/IAYB-SteamFriendLeaderboard/releases/latest)
* Drag the `BepInEx` folder from the mod zip file into the IAYB game folder
* Boot up the game
**NOTE:** You will only be able to see times of players who also have the mod installed and are on your Steam friends list.
## Is there a global leaderboard?
No, and there never will be. I neither have the ability nor the interest to prevent cheating, and vetting leaderboard entries manually goes way past my paygrade (of 0$, as I'm working on this as a hobby and hosting all the relevant infrastructure needed for it at my own cost).
-----
## WARNING: Nerd stuff under here
### How does it connect to Steam?
It uses the Steamworks API that's also used by the game itself in order to interface with Steam.
### Where is leaderboard data stored?
I've set up a small webserver connected to a database that is storing all leaderboard data. If I was a developer of the game I could've used the official Steam leaderboards feature, but as I am not, this is the next best thing. The API endpoint the mod connects to is configurable via a config file for the plugin, and documentation about the functionality of the API is in the works, so if someone wants to host their own leaderboard instance, they could very much do that.
### How is cheating prevented?
It's not! That's why these are friend-only leaderboards, not global ones. The mod uses the Steam Session Ticket system in order to ensure that people cannot impersonate others and falsify their record times, but the actual values themselves aren't checked at all. But, since they'd only be visible to Steam Friends anyway, I don't feel the need to add anything of that sort.