PEAKER
Who knew that PEAK could get even more PEAK!? An all-in-one feature & fix mod for larger expeditions! Patch: 1.62.a
By lammas123
| Last updated | 5 days ago |
| Total downloads | 127058 |
| Total rating | 12 |
| Categories | Mods Quality Of Life Client Side Host Only Optimization |
| Dependency string | lammas123-PEAKER-0.4.9 |
| Dependants | 39 other packages depend on this package |
This mod requires the following mods to function
BepInEx-BepInExPack_PEAK
BepInEx pack for PEAK. Preconfigured and ready to use.
Preferred version: 5.4.75301lammas123-PEAKERRpcInfo
A dependency for mods that need the info parameter on Rpcs.
Preferred version: 1.1.0README
Who Needs the Mod?
For all features, only the host is required to have the mod, though it's recommended all clients have it for the best experience.
More Scouts (Host Only)
The maximum number of scouts that may join your expeditions has been increased to 20, and is configurable from 1 to 30!
There will always be enough marshmallows and hot dogs for everyone to have a bite to eat at campfires!
- The number that spawn is based on how many scouts there are at the start of the expedition, more or less will not spawn if scouts join or leave mid game.
Why Limit It?
The game and its networking is unoptimized, untested, and unstable in many ways for this many scouts, and would require massive reworks that would be far too invasive for a mod to perform without risking breaking the game, or breaking with each game update.
Character Ragdolls
The physics-based ragdoll characters lead to a lot of CPU-bound lag around 15-20 scouts, even on the most performant of cpus.
Without the mod, all dead scout's characters are teleported to the same spot off screen and constantly collide on your client's end, causing lots of lag! This is fixed by disabling dead character's colliders on your end if you have the mod.
Photon Networking Instability
The game has lots of networking to do, especially when lots of scouts are revived at the same time via the Ancient Statue. In the past (at least) it was a common occurence for many scouts in the lobby to disconnect when several scouts were being respawned at once due to Photon being unable to keep up, effectively crashing and ruining the lobby.
Client Side Improvements
Normally, there's only enough volume sliders in the pause menu for ~8 scouts, the mod creates more sliders as the number of scouts demands it.
There's only enough nametags for ~8 scouts in the base game, leading to nametags being missing or even incorrect for some scouts when there's more than 8. The mod creates more nametags as the number of scouts demands it.
The helicopter at the PEAK only has enough seating for 4 scouts, this mod fixes that by making every scout past 4 sit on the laps of other scouts.
The end screen normally can only handle 4 scouts, the mod fixes that. It may look a little janky, but I'd rather not fully remake the UI to fit the extra scouts.
It may be difficult to keep count of so many scouts in larger lobbies, so the mod displays the current and maximum number of scouts for the lobby in the top left next to the version string.
Cheat Detection
To assist with finding cheaters in your (potentially) public lobbies, the mod comes with a couple cheat detections. This mod will not actively moderate and automatically punish detected cheaters (besides one optional case), only detecting potential cheating.
The Atlas and Cherry Mods
If a scout joins your lobby using the Atlas or Cherry mods, you will be constantly notified every 10 seconds of their presence.
- I haven't met many Atlas nor Cherry users in my dozens of lobbies who didn't use their mods to cheat, ruin the experience, or otherwise crash the lobby.
- There is one host only config option (off by default) where you can enable automatically kicking Atlas and Cherry mod users. Seeing as it's easy to check, can't be falsely flagged, and has been requested by hosts using this mod, this is the one 100% safe automatic punishment I can implement.
Detections
You'll be notified when a scout:
- forces another scout to slip on a banana peel,
- forces a bee swarm to disperse,
- forcefully changes a bee swarm's anger illegally,
- makes a tick to attach to another scout,
- forces a flare to trigger the game to end,
- forcefully extinguishes a campfire,
- attempts to make the game end,
- attempts to kill another scout,
- attempts to revive another scout,
- attempts to teleport another scout,
- forcefully initializes or retarget's another scout's ghost,
- spawns an eruption,
- forces a magic bean to grow,
- forces the fog to start or sync,
- attempts to forcefully start the game or return to the airport,
- forces a bridge to shake or fall,
- forces a rope to detach,
- forces a icicle to shake or fall,
- forces a piton to break or start breaking,
- or illegally instantiates a networked prefab.
Do Note
As of writing this, some of these notifications may be triggered through normal gameplay, such as by reviving another scout, though others, such as attaching a tick to another scout or spawning an eruption, are not. Use your best judgement and game knowledge before taking action.
PEAKER GUI (F9 Keybind)
Managing such large lobbies can be a hassle, so having a centralized and simple to use GUI to help keep things under control is crucial. This GUI comes with several actions and features you may use!
Actions
Simple buttons you may use to perform a specific action quickly.
Airport Start Kiosk Lock Toggle (Host Only)
The Start Kiosk is now locked, so only the host may start the expedition by default! Great for keeping random people from starting your expeditions prematurely on settings you didn't want!
Light Nearby Campfire (Host Only)
This will force the campfire near you to instantly light, useful if scouts are afk after respawning or unwilling to come close enough to the campfire for you to light it normally.
- Keep in mind, this will not teleport distant scouts to the campfire! If scouts are still climbing the current section, the mountain will unload and they may fall out of bounds!
Spawn Backpack (Host Only)
This mod does not spawn more backpacks at each campfire. If you'd like more backpacks to be in play, or something happens to a backpack and you just want to get another, this is the action to use!
Skip End Screen (Host Only)
Are scouts taking too long to confirm the end screen and continue on to the credits? Skip the wait and roll the credits!
Copy Invite
This will copy the Steam lobby invite link to your clipboard! Makes it easy to share your lobby's invite link and fill the expedition quicker.
Steam Lobby Lock Toggle (Host Only)
While the Steam Lobby is locked, no scouts will be able to join. Useful if you've started your expedition and don't want anyone joining in the middle of it, which may cause desync issues and other bugs!
- If scouts already in your expedition disconnect, they will not be able to rejoin unless you unlock the Steam Lobby!
Scouts
Here, you will find every Photon and Steam scout in your expedition, with several options for managing them.
For Photon scouts, you may:
- Kick them (Host Only),
- The same as pressing the kick button in the pause menu.
- Modify their character's max velocity,
- Useful if that scout's ragdoll is freaking out, simply decrease their max velocity until the issue stops.
- and Ignore Cheat Detections from them.
For Steam scouts, you can:
- Copy their Steam ID to your clipboard,
- Open their Steam Profile in the Steam Overlay,
- Ban them,
- This does not make them leave the game, only preventing them from entering future ones you host.
- Temporarily ignore their ban,
- Technical explanation will come later.
- and Allow them into First Class.
First Class
First Class is my representation of an 'allowlist' where, when enabled, only Steam scouts you've added to it (or Steam friends if that's enabled) may enter your expedition when you're the host.
From here, you may manage the scouts you've added to the list in game, or open the first-class.txt where you may edit the list freely.
The No Fly List
If you have a list for First Class, then you've got to have a list for those who may not partake on your expeditions. The No Fly List is my representation of a 'denylist' where Steam scouts you've added to it will not be able to enter your expedition when you're the host.
From here, you may manage the scouts you've added to the list in game, or open the banned.txt where you may edit the list freely.
Important to Note
There may be a slight chance for banned scouts may be able to get around this, depending on if a bunch of scouts join the expedition at the same time in a certain order, but I have not experienced this myself, and with how the game works, I cannot patch this without requiring everyone to have the mod.
- This also applies to First Class!
Other than that, the only way to get around this ban would be for them to get another copy of the game on another Steam account (or a friend), which you can then also promptly ban.
How the Ban Works (Simplified)
- When someone first tries to join your expedition, they first join your Steam lobby.
- They'll then ask you for a Photon room name, so that they may enter the expedition.
- So long as a banned scout's Steam ID is present in your Steam lobby (unless they are ignored), you will send a completely random, incorrect Photon room name in response.
- The Photon room name is sent to every person in the Steam lobby, I cannot control who receives it, as this is just part of Steam's SteamMatchmaking API.
- Scouts will then try joining this Photon room of the incorrect name, are unable to do so, and promptly disconnect from your Steam lobby.
Witch Hunting or Public Shaming (Sharing the banned.txt)
I do not condone or wish to witch hunt or publicly shame anyone, and thus will never share my own banned.txt publicly.
- Though I feel confident most people would agree that most of the people I have banned should be banned from their public lobbies, not everyone will, and I'd rather not deal with the drama associated with managing a public ban list. I just wanna play the game.
If your friends have been hosting with this mod a while, you can ask them for their ban list to get a head start. Otherwise, just start hosting and ban those you don't want in your lobbies when they come around, you'll quickly accumulate a list of banned scouts of your own and start having a good time climbing PEAKs again.
Config
Here contains some config options from the mod's config file you may change in game without opening the file!
Locale/Language
This mod supports localization! It only ships with the English (US) locale (aka. en-US), but it's easy to write your own localization config and share it, or use someone elses! Localization configs are located at *profile-directory*/BepInEx/config/lammas123.PEAKER/.
Character Physics Optimization Mode
By default, character's colliders will be disabled when they're dead (to improve performance) since they're the cause of lots of lag in vanilla. I guess the option is there to disable this optimization if you want to see how much laggier the game would be without it!
Late Join Anti Fling Mode (Experimental!)
It's been reported that people joining later in the game often leads to their ragdolls bugging out. To try and combat this, this setting can be enabled to automatically slow the maximum velocity of scout's ragdolls when they join late.
Max Scouts (Host Only)
A slider to change the maximum number of scouts allowed in your lobby.
Cheat Detections
A toggle to enable and disable cheat detections, in case they're not needed or you need to turn them on.
Automatically Kick Atlas and Cherry Users (Host Only)
After request from users of this mod, I've added this one automatic cheat detection punishment as an option that's off by default. If this is enabled and a scout with the Atlas or Cherry mods joins your lobby, they will be automatically kicked.
W.I.P!
This mod is still semi-experimental, so there may be a few issues! Until I'm satisfied with the state of the mod, I won't be releasing a 1.0.0 version of the mod to reflect the mod's unfinished state!
If you encounter any issues, have any suggestions, or would like to offer help, I am in the PEAK Modding Discord!
Installation (Manual)
Firstly, I don't recommend manual installation to the average user. You can always use Thunderstore Mod Manager, r2modman, or Gale to mod your games if you're not familiar with this process!
- Download this BepInEx if you don't already have it installed. If you do, skip to step 4.
- Extract the contents of the .zip into your game's root directory.
- You may navigate there directly by: opening your Steam library, right clicking them game, selecting Manage, and then Browse local files.
- Run the game once, wait for the game's window to appear, then you may close the game.
- Download the latest release of this mod.
- Move the
PEAKER.dllcontained within the .zip to yourBepInEx/pluginsfolder. - Download the latest release of PEAKERRpcInfo.
- Move the
PEAKERRpcInfo.dllcontained within the .zip to yourBepInEx/patchersfolder. - Enjoy! Running the game once will generate the
lammas123.PEAKER.cfgfile inBepInEx/configs.