AdminHelper

AdminHelper is a BepInEx mod for Holdfast: Nations At War. It scores every player on their distance from their own side and marks players who stay out of formation (rambos). It also adds admin tools to the P menu.

Anything that shows another player requires an rc login on the server. See Admin only.

Install

Mod manager

Install AdminHelper with r2modman or Thunderstore Mod Manager and start the game from the manager. BepInEx and RyLib are installed with it.

Manual

1. Install BepInExPack_Holdfast into the game folder and start the game once.
2. Download AdminHelper.dll from the latest release and RyLib.dll from the RyLib release.
3. Copy them to:

Steam\steamapps\common\Holdfast Nations At War\BepInEx\plugins\AdminHelper\AdminHelper.dll
Steam\steamapps\common\Holdfast Nations At War\BepInEx\plugins\RyLib\RyLib.dll

Checking the install

BepInEx\LogOutput.log contains these lines when both mods load:

[Info   :   BepInEx] Loading [RyLib 1.1.1]
[Info   :   BepInEx] Loading [AdminHelper 1.3.1]

If they are missing, see Troubleshooting.

Rambo overlay

1. Log in to the server console with rc login <password>.
2. Open the P menu and click Rambo UI under the players list, or press F6.

Rambo UI cycles through three modes:

F6 turns the overlay off, and pressing it again restores the previous mode. The mode is saved between launches. ToggleKey changes the key.

A player is marked once their ISO passes RingThreshold. The mark is a glow visible through walls and terrain, a ring on the ground around them, and a label with their name, state and scores. A rider's ring is wider and circles their horse. The mark is removed when their ISO drops below the threshold.

Compact labels in Mods > AdminHelper > Rambo UI, or CompactLabels, shortens each label to the player's name in their state color.

States

Colors

Spectating marked players

With an rc login, ] spectates the next marked player and [ the previous one. The order is RAMBO, then CAV CHARGE, then ISOLATED and MELEE GRACE sorted by DGR, then AFK. While Rambo UI is not Off, the key bar in free roam and in spectator mode shows a Spectate Rambos entry for these keys. SpectateNextKey and SpectatePrevKey change them.

Cavalry

A mounted player is cavalry, whatever their class. A Hussar or Dragoon on foot is scored like any other class.

Compass range is the distance at which a friendly drops off the compass. AdminHelper reads it from the game each round and logs it. CompassRangeMeters sets it by hand, and 0 uses the game's value.

Isolation

A rider is measured to the nearest mounted teammate. Isolation is 0 inside compass range and reaches full at compass range times CavalryFarMultiplier. A rider with no other mounted teammate is not scored.

Multicharge

When a mounted player kills an enemy, AdminHelper counts the riders chained to them at that moment: every mounted teammate within compass range of the killer or of another rider in the chain. With fewer than MultichargeMinRiders in the chain, the killer included, the kill log shows a red horse icon between the names. MultichargeCheck turns it off.

Cav Charge

A mounted player enters a melee the same way as anyone else. Mounted players in a melee spread it to other mounted players within CavalryChainMeters. A mounted player stays in the melee while any enemy is within CavalryEngageMeters, so riders circling an enemy remain in the fight. Every mounted player in the melee is marked CAV CHARGE in light purple.

CavalryRules turns all cavalry rules off. Mounted players are then not scored.

P menu

Settings

The P menu has AdminHelper's settings under Mods > AdminHelper. Each section holds switches, sliders, dropdowns and text boxes for the same values as the config file:

RequireAdminLogin is only in the config file.

Reset to defaults in the General section puts every AdminHelper setting back to its default, along with the glow and icon size settings shown in the tab. It needs a second click within four seconds.

Rules tab

The game's Rules tab is hidden. Rules tab in the Players Tab section, or ShowRulesTab, shows it.

Player search

The search box in the P menu players tab accepts classes, factions, sides and regiment tags as well as names and IDs. It works without an rc login.

Terms combine. french cav lists French hussars and dragoons, and defenders surgeon lists the defending side's surgeons. Plurals work for all terms.

Regiment tags and player names are compared with punctuation removed and accents replaced by plain letters. [45e] matches 45e and 45, and 7.Fuß matches 7fus.

Text that is not a class, faction or side searches names and tags as in the base game.

ClassFilterEnabled, FactionSearchEnabled and RegimentSearchEnabled turn each part off.

Regiment teleport

An expanded player row in the P menu has two extra admin buttons.

Both buttons use the game's revive request and rc teleport. RowActionsEnabled removes them.

Kill log

Melee mark

Crossed swords between the names mean the victim was in a melee with an enemy player when they died. A kill at range shows the distance and then the swords.

A player enters a melee when they hit an enemy with a melee attack, have their attack blocked by an enemy, or block an enemy's attack. Hits and blocks between teammates do not count. Every player within MeleeChainMeters of someone in the melee is also in it, on either side. The melee ends when nobody in it has hit or blocked for MeleeWindowSeconds.

Only kills that happen while you are in the round can be marked.

Name colors

The killer's and victim's names use the color of their rambo mark at the time of the kill. They show while Rambo UI is not Off. KillLogColorsWithoutUi also shows them while Rambo UI is Off.

Multicharge mark

A red horse icon between the names marks a mounted kill that broke the multicharge rule. See Multicharge.

Color key

A line under the kill log title shows what each icon and name color means. The swords are Killed In Melee and the red horse is OUT OF SPACING. These two always show when their features are on. The state colors, with orange to red as Rambo, show whenever the name colors do. ColorKey turns the key off.

Actions

Clicking a row opens actions for the killer and the victim: Spectate, Go To, Bring, Slay, Revive, Heal, Slap, Kick, Reg TP and Rez + Reg TP. Slay, Slap and Kick need a second click within four seconds.

Teamkills

The square toggle next to the search box shows teamkills only and changes the title to TEAM KILL LOG. Typing tk in the search box does the same. Suicides do not count as teamkills.

Minimap

The Minimap tab is on by default. Minimap tab under Mods > AdminHelper > Minimap, or MapEnabled, turns it off.

The tab shows an overhead image of the play area, with each player drawn as their class icon in their faction's color. The image is taken once per round at 8192 pixels, covers the terrains that hold the spawns and capture points, and leaves out players, horses and ships.

• The legend under the map lists the classes each faction can spawn and how many of each are on the field.
• The search box filters the icons by name, class or faction.
• The mouse wheel zooms and dragging pans. Battle Area frames the current spawns and capture points, and Whole Map shows the full image.
• Icons - and Icons + change the icon size.
• Clicking a player selects them. The panel has Spectate, Go To, Bring, Teleport To, Slay, Reg TP and Rez + Reg TP. Slay needs a second click.
• Teleport To moves the selected player and Teleport Me moves you. Both wait for a click on the map and teleport to that spot. Right click cancels.
• While the rambo overlay is showing, marked players have an outline in their mark color.
• With FlagHighlightEnabled on, flags are drawn on the map.

Flags

All flag settings are off by default.

ShowFlagLabels and FlagMinimapMarkers need FlagHighlightEnabled. FlagMinimapAlways needs FlagMinimapMarkers.

A carried flag follows its carrier, and a dropped flag is marked where it lies. Tracking covers every flag carryable in the game, including the custom bearing flag, whichever mod or map places it.

AFK players

A player who has moved less than AfkMoveMeters in AfkSeconds is marked AFK in gray. Moving further clears the mark. AfkMarkEnabled turns it off.

Melee grace

When a player who is not flagged joins a melee, they cannot be flagged until MeleeWindowSeconds after the melee ends, plus RamboHoldSeconds. Their label reads MELEE GRACE during this time. Their dwell time keeps counting, and if they are still isolated when the grace ends they are flagged straight away. A player who is already flagged when the melee starts gets no grace. MeleeGrace turns it off.

Scores

Both run from 0 to 100, and DGR is never higher than ISO. A player alone with no enemies nearby has a high ISO and a DGR of 0. A player at 60 ISO with three enemies close by has a DGR near 60.

Scoring

Scores update TickHz times a second from four inputs.

Mounted players follow the cavalry rules. Artillery is never scored. ExemptClasses excludes other classes.

Admin only

Other players are shown only after the server accepts your rc login. Setting RequireAdminLogin to false removes this check for testing with bots on your own server. With it off, every player is shown to anyone running the mod.

Settings

The config file is BepInEx\config\com.ryannlt.adminhelper.cfg, created on first launch. Changes to the file apply within a second without a restart.

ConfigurationManager can edit the settings in game. It needs HideManagerGameObject = true under [Chainloader] in BepInEx\config\BepInEx.cfg.

Glow style and map icon size are set in RyLib's config, com.ryannlt.rylib.cfg.

Tuning

Each marked player's label shows their ISO and DGR. Compare these with the table below to adjust the thresholds.

With the default settings, ISO settles at these values:

A player is marked at about 18 m. A RAMBO flag needs more than 25 m held for about 8 seconds, plus RamboHoldSeconds.

Dwell time falls at RecoverMultiplier times the rate it builds, and a short return to formation does not reset it.

Troubleshooting

Building

Requirements:

• The game.
• BepInEx installed in an r2modman profile.
• RyLib cloned next to this repo and built, so ..\RyLib\RyLib.dll exists.
• A .NET SDK, for the compiler.

powershell -ExecutionPolicy Bypass -File .\build.ps1

build.ps1 compiles every .cs file in the repo and copies AdminHelper.dll to BepInEx\plugins\AdminHelper\ in the r2modman profile. Restart the game to load it.

AdminHelper compiles against ..\RyLib\RyLib.dll. When changing both, build RyLib first.

package.ps1 builds the mod and writes a Thunderstore zip to Package\.

Both scripts expect the game in C:\Program Files (x86)\Steam\steamapps\common\Holdfast Nations At War. For another location, change $GameDir at the top of the script.

The .csproj is for IDE support. build.ps1 calls csc directly.

Source layout

Releases

There is no CI build. Building needs Assembly-CSharp.dll from a game install, which is not in this repo. Releases are built locally.

Compatibility

Built against Holdfast on Unity 2022.3.62f2 with BepInEx 5.4.23.5 (Mono). A game update that renames or restructures the client player managers stops the mod from working. Please open an issue if that happens.

License

MIT.

Changelog

1.3.1

• Rings lie on the ground and follow its slope. A rider's ring is wider and circles the horse.
• Needs RyLib 1.1.1.

1.3.0

• Cavalry.
  • A mounted player is cavalry. Riders are scored against the nearest mounted teammate at compass range, which AdminHelper reads from the game's compass.
  • A Hussar or Dragoon on foot is scored like any other class.
  • New [Cavalry] settings. ScoreCavalry is removed.
• Multicharge. A mounted kill with fewer than 3 riders chained at compass range gets a red horse icon in the kill log.
• Cav Charge. Mounted players in a melee show a light purple CAV CHARGE state. The melee spreads between riders over a longer distance and lasts while they stay close to an enemy. ] reaches them right after the RAMBOs.
• Kill log color key under the title. The Killed In Melee and OUT OF SPACING icons are always listed, and the name colors are listed while they show.
• Kill log name colors show while Rambo UI is on, and with the new KillLogColorsWithoutUi while it is off.
• FIGHT is renamed MELEE GRACE, the state for an isolated player excused while fighting a melee.
• Settings in the Mods tab. Nearly every setting is in Mods > AdminHelper, grouped, with sliders, dropdowns and text boxes.
• Rules tab hidden. The game's Rules tab is hidden. ShowRulesTab brings it back.
• Compact labels. A Mods tab switch shortens labels to the player's name.
• Reset to defaults in the Mods tab puts every setting back to its default.
• Minimap.
  • The Map tab is renamed Minimap.
  • Its image is 8192 pixels, covers only the play terrains, and leaves out players, horses and ships.
  • Battle Area frames the current spawns and capture points, including spawns moved by a map mod.
• American spelling. ClusterNearMetres, ClusterFarMetres, AfkMoveMetres and MeleeChainMetres are now ...Meters. Values in an existing config file carry over.
• Needs RyLib 1.1.0.

1.2.0

Now built on RyLib, a shared UI library, so AdminHelper and other mods can add to the P menu without breaking each other. Mod managers install it automatically; by hand, it goes in BepInEx\plugins\RyLib\.

The overlay is drawn in the world, not on a HUD. Watched players glow through walls and terrain, with a ring at their feet and a label that sits under the P menu rather than over it. The corner list and your own score readout are gone, and with them ShowCornerList, ShowOwnScore and StartHudVisible. New ShowGlow.

Rambo UI modes. A Rambo UI button under the players list steps between Always On, Freeflight (only in free roam) and Off, like the game's Admin Raygun, and the mode is remembered between launches. F6 still hides and restores it. New RamboUi.

Colors say how bad it is. Isolation alone runs green to yellow; any danger turns the mark orange, deepening to red. FIGHT stays blue and AFK gray.

Spectate rambos with [ and ]. Steps through watched players worst first, and the game's own key bar shows a Spectate Rambos entry in free roam and while spectating. New SpectatePrevKey and SpectateNextKey.

All settings in the P menu, under a shared Mods tab: Mods > AdminHelper, grouped into Rambo Detection, Flags, Players Tab, Kill Log and Map.

Kill log. A melee kill is marked with crossed swords, explained by a line under the heading; the old IN MELEE / NO MELEE text is gone. While Rambo UI is on, names are colored by their rambo mark at the moment of the kill. Clicking a row opens actions for the killer and the victim.

Reg TP prefers the same class. It sends a player to the middle of their regiment's players of the same class, and to the closest friendly player when there are none.

Flags glow in their faction's color instead of a ring and beam, and follow the game's minimap reveal rules, with FlagMinimapAlways letting admins see all of them. New ShowFlagLabels. Every flag setting is now off by default, including FlagMinimapMarkers.

A battle map. A Map tab with an overhead picture of the battle, every player drawn by class in their faction's color, a class legend, search, zoom, rambo outlines and flags, and admin actions that only fire after a button is pressed. Turn it off with MapEnabled or Mods > AdminHelper > Map.

1.1.2

The player search reads factions and sides. french, allied, austrian and the country names behind them all filter the players tab, and attackers or defenders resolve to whichever faction is attacking or defending this round. They combine with a class, so french cav is French hussars and dragoons and def surgeon is the defending side's surgeons, and plurals are understood throughout. Class groups grew too: skirmishers, rank & file, infantry, support and horse. Anything the mod cannot read is handed straight back to the stock name and tag search, so nothing that worked before stopped working. New FactionSearchEnabled.

Two new buttons on a player's admin row. Reg TP teleports that player to their own regiment - to the mate standing nearest the middle of the group, so they land in the line rather than on a straggler - and Rez + Reg TP revives a dead player first, waits for them to come back, then sends them. Both go through the game's own admin plumbing, and both live in the admin block, so they only exist once you are logged in. New RowActionsEnabled.

Source files are now grouped into Core, Game, Tracking, Overlay and PMenu folders. No behavior change, but build.ps1 now recurses.

1.1.1

Three additions for CTF events.

Flags are highlighted. With the overlay up, every flag in the round gets a cyan ring and a beam, either at the carrier's feet or where the flag is lying, a label saying who has it, and a line at the top of the corner list with the distance. On the minimap the carrier's own pointer is tinted rather than doubled up, and a flag on the ground gets a marker of its own, named by its faction. Every flag carryable the game has counts, so this is not tied to one CTF mod. It ships off, since it only matters on a flag game mode - turn on FlagHighlightEnabled under the new [CTF] section.

Players standing still are grayed out. Anyone who has not moved for AfkSeconds is drawn gray with an AFK tag, so a parked player is not read as someone worth flying to. They keep their ring and their place in the list. New [AFK] settings.

Melee grace. A player who enters a melee without already being flagged is not flagged while it lasts, plus the usual window afterwards, and the label reads FIGHT. The last one or two left alive in a fight their mates started no longer read as rambos, while a player who runs in alone still flags. Their dwell keeps building underneath, so nothing is lost if they really are out on their own. Turn it off with MeleeGrace.

1.1.0

Two additions, both inside the game's own P menu rather than a separate window.

Find players by class or regiment. The players tab search box now also matches class names and shorthands, so rifleman, rifle, line, sgt and cavalry all narrow the list, with the count above it. Regiment tags are matched with punctuation and accents stripped from both sides, so [45e] is found by 45e or 45, and 7.Fuß by 7fus. Searching by name or ID is unchanged.

Kill log. Every kill is marked with whether the victim was in a melee when they died, so a teamkill in a scrum can be told apart from a clean one. A player counts as being in a melee once they hit, block, or are blocked by the other side, and that spreads to everyone standing within MeleeChainMeters of them. A blank mark means the mod was not tracking and does not know, which is never to be read as a clean kill. A square toggle beside the heading switches the log to teamkills only, and typing tk in its search box does the same.

New settings live under [PMenu] and [KillLog].

1.0.1

Fixed the BepInEx dependency. 1.0.0 depended on BepInEx-BepInExPack, which is not published in the Holdfast community, so mod managers could not resolve it and installed no loader. Now depends on HoldfastModding-BepInExPack_Holdfast. No code changes.

1.0.0

First release. Built for BepInEx 5.