bricks04-HoloCheck icon

HoloCheck

A mod that controls access to your public lobbies either by whitelist, or by password.

Last updated 2 months ago
Total downloads 912
Total rating 0 
Categories Mods Client-side Server-side
Dependency string bricks04-HoloCheck-0.1.5
Dependants 2 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

HoloCheck Lobby Control Tools

Provides functions and tools to control access to Public facing lobbies.

Allows users to create Public lobbies that are access controlled - enabling scenarios like streamer lobbies, where individually inviting users via Steam may not be viable.

Instructions

  • Install mod dependencies (Bepinex)
  • Extract provided ZIP
  • Place contents in the root folder for the game.
  • The file "bricks04.holoCheck.dll" and "holocheckassetbundle" should be within the BepInEx/plugins folder. Ensure the dll and assetbundle are in the same folder.

r2ModMan Instructions

  • Ensure mod dependencies are installed.
  • Should be ok for single-click install.

Usage - Passkey

  • On the main menu, new fields for changing the passkey and viewing the whitelist will appear on the bottom right of the screen.
  • To use a passkey, enter four digits into the Passkey field, and press "Change".
  • Other users joining your lobby must install the H-check mod and enter the exact same Passkey digits into their own Passkey field. If they do not follow these steps, they will be unable to view/join your lobby.
  • If you do not wish for the passkey to be displayed on screen(eg. for streaming purposes), press the "Reveal" button to change the displayed passkey into *s. Press the button again to display the active passkey.
  • If you wish to allow users to join without passkey check, clear the Passkey field and press "Change".

Injecting Passkey into Payload

  • Some mods rely on changing the version number to work. HoloCheck will conflict with mods that do this.
  • If you do not encounter issues with version checking, you do not need to enable Payload Injection. Enabling Payload Injection will disable Version Number checking.
  • To use a passkey without changing the version, firstly press the blue key button on the Lethal Company main menu, then press the Injector button near the bottom left of the screen.
  • Users joining your lobby will also have to press the same Injector button to join your lobby.
  • Payload Injection mode uses a different method to transmit passkeys for checking, avoiding the need for version number changes. This does mean that, in comparison to version checking, your lobby will show up in the lobby list for users who do not have HoloCheck/do not have the correct passkey. Users will still need to enter the correct passkey to enter your lobby, with incorrect passkeys being unable to join.

Usage - Whitelist

  • To use a whitelist, first collect the SteamIDs of every user that you wish to allow to join.
  • Enter all the collected SteamIDs as a comma-separated string into the "Allowed Steam IDs" field in the mod's config file BepInEx/config.
  • eg. 123456789,234567893,4534634563456
  • ENSURE that there are no spaces in your comma-separated string!
  • To disable whitelist checking, empty the "Allowed Steam IDs" field.
  • To check what whitelist you have active, press the blue key button on the Lethal Company main menu.

Reporting Bugs and Contacts

Found a bug? Need to contact me for some reason? Please send contact to discord@andrew3199 or twitter@bricks041lol

Changelog

- v0.1.0
	- Release
- V0.1.1
	- Added Payload Injection mode as a fallback if Version Number method becomes broken.
	- Bugfixes :
		- Fixed a bug where inputting a negative number would cause an unhandled exception.
- v0.1.2
	- Functionality assurance for v55.
	- Fixed visual typos and display annoyances.
- v0.1.3
	- Hotfixed minor issue.
- v0.1.4
	- Added measures to prevent attempted joins from users with an incorrect password. 
	- Modified password input to more effectively hide the inputted password.
- v0.1.5
	- Fixed a bug where the Passkey field displays inaccurate digits. 
	- Added a warning when attempting to make a lobby without a passkey.
	- Added a warning when accessing the lobby list without a passkey. 
	- Added a warning to restart the game when an unexpected error occurs.