Enova-ReadyCompany icon

ReadyCompany

Adds a Ready Check system during the ship phase to let players make sure everyone is ready.

Last updated 10 hours ago
Total downloads 2280
Total rating 4 
Categories Mods Misc BepInEx Client-side Server-side Tweaks & Quality Of Life
Dependency string Enova-ReadyCompany-1.0.0
Dependants 4 other packages depend on this package

This mod requires the following mods to function

Sigurd-CSync-5.0.1 icon
Sigurd-CSync

Configuration file syncing library for BepInEx.

Preferred version: 5.0.1
Rune580-LethalCompany_InputUtils-0.7.7 icon
Rune580-LethalCompany_InputUtils

API/Library for creating Unity InputActions with in-game re-binding support. Provides an alternative UI that allows for supporting mods to have in-game re-bindable keybinds.

Preferred version: 0.7.7
xilophor-LethalNetworkAPI-3.3.2 icon
xilophor-LethalNetworkAPI

A library/API to allow developers to easily add networking to their mods.

Preferred version: 3.3.2

README

Ready Company

ReadyCompany mod icon

A mod that adds a Ready Check system, inspired by FFXIV. It is highly customizable, and built with real users in mind.
It fully supports MoreCompany and I tried my best not to conflict with any other mods or give you the option to fix it.

Screenshots

A screenshot of the game with a Tip popup and text anchored to the hotbar that both say "1 / 1 Players are ready. MultiTap R to Unready!" A screenshot showing off the several ReadyCompany configuration options available in LethalConfig.

Usage

[!NOTE]
You can change how the ready and unready binds need to be pressed to activate in LethalConfig.
Theres a few built in presets for you to use, but you can fully customize it with a string, and you can use the presets for reference.
The custom string is a Unity Interactions string.

There is custom sound support that can be utilized by placing sound files in BepInEx/config/Enova.ReadyCompany/CustomSounds/.
Your sounds must be formatted according to LCSoundTool's wiki, and all audio files will be selected from randomly to play whenever the ready status changes.
You can also add separate sounds for specifically when the lobby is ready by placing sound files in BepInEx/config/Enova.ReadyCompany/CustomSounds/LobbyReady.

Known Issues

  • Lever tooltips are sometimes inaccurate to vanilla when lobby is ready
  • When the lever hasn't been pulled yet, clients can pull the lever but it will not work.
  • When landing, sometimes the lever will keep the host Warning for all players. (Should be fixed)
  • When starting the ship clients see "0 / 3 Ready" longer than the host does

Planned (Maybe) Features

  • Standby option: "i'm AFK but you can start without me"
  • Countdown for lever auto pull
  • Auto ready under certain user-specified conditions

Credits

mattymatty97 for their implementation of knowing when a player has fully connected: https://github.com/mattymatty97/LTC_LobbyControl
LCSoundTool for the entire AudioUtility class: https://github.dev/susy-bakaa/LCSoundTool
My friends for being nicies to me :3