You are viewing a potentially older version of this package. View all versions.
Enova-ReadyCompany-0.3.0 icon

ReadyCompany

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

Date uploaded 2 days ago
Version 0.3.0
Download link Enova-ReadyCompany-0.3.0.zip
Downloads 360
Dependency string Enova-ReadyCompany-0.3.0

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
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
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

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.

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.
The custom string is a Unity Interactions string. A more user-friendly way to configure this may be added in the future.

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.
  • When starting the ship clients see "0 / 3 Ready" longer than the host does
  • Not much testing has been done

Planned (Maybe) Features

  • Standby option: "i'm AFK but you can start without me"
  • 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

CHANGELOG

Changelog

0.3.1 (1.0.RC5)

  • Fixed bug with Ship Lever tips not resetting
  • Changed default keybind for ready/unready to 'c'
  • Don't allow the player to vote under certain conditions
  • Show different header text in popup when lobby is ready
  • Add config option to not allow dead players to vote (Forces them to be ready)

Version 0.3.0 (1.0.RC4)

  • Ready Checking is now enabled on Gordion to leave the moon.
  • LethalConfig is now an optional/soft dependency

Version 0.2.7 (1.0.RC2)

Considered feature complete; New updates will likely slow down once 1.0 is out.

  • Added presets for different interaction methods with the ready and unready binds
  • The position of the ready status text is now configurable
  • Added changelog to package