HLGroups
Player groups and guilds for servers: invites, member bars, map and direction markers, group and guild chat, teleport to members, target marking, combat meter, group finder, duels with an arena, no friendly fire. Works alongside ValheimPlus.HL Groups
Player groups for Valheim servers: invite friends, see their health and where they are, and stop hitting each other by accident. Works alongside ValheimPlus.
This is an early release. Please report anything that misbehaves.
Features
- Invite by looking. Look at a player and press
G. A prompt under the crosshair shows who you are about to invite. - Group menu. Press
F6to see your group, invite any online player, remove members, hand over leadership or leave. It is drawn with the game's own wood panel, buttons, text boxes and fonts. - Invitations. An invitation appears at the top of the screen; accept with
Y, decline withN, or use the menu. It expires after 60 seconds. - Member list. Group members are listed on screen with name, health bar, stamina bar and distance, in the game's own font. The leader is shown in gold, offline members in grey.
- Status at a glance. An eitr bar for members who have eitr, and icons for their active status effects such as poison, burning or wet.
- Members on the map. Group members are marked on the map and minimap at any distance.
- Direction markers. A tag floats over group members who are too far for the game's name plate, and an arrow at the edge of the screen points to those out of view.
- Group chat. Type
/g your message(or/p) in the chat box to talk to your group only. - Group ping. Hold
Left Altwhile pinging the map and only your group sees the ping. - Ping what you look at. Press the middle mouse button while looking at a creature, a chest, an object or just a spot: your group sees a marker there, in the world and on the map, with the name of what you pinged.
- Danger alerts. A member's health bar flashes red and a message appears when their health gets low, and the group is told when a member dies. No sounds.
- No friendly fire. Members of the same group cannot damage each other unless the server allows it.
- Death markers. The map shows where each member last died, until they collect their tombstone.
- Shared exploration. Members reveal the map for each other as they move, if the server allows it.
- Skill bonus. Skills grow a little faster while another member is nearby. The server sets how much.
- Ready check. The leader asks, everyone answers with one key, and the result is announced.
- Group name and colour. The leader names the group and picks its colour.
- Teleport to a member. Ask from the group menu and travel once the other side agrees. The leader can also call a member over. The portal rule for ores applies unless the server lifts it.
- Group wards and chests. A ward lets its builder's group through, and the server can open private chests to the group as well.
- Target marking. Look at a creature and press
H: the whole group sees a pointer over it, with its name, distance and health, and a marker on the map. - Combat meter. The damage each member dealt in the current fight, with damage per second.
- Group finder. A leader can list the group with a short note; players without a group can ask to join.
- Movable panels. While the group menu is open, drag the group panel and the combat meter anywhere on screen.
- The game's own bars. Health, stamina and eitr of members are drawn with the bar the game itself uses, so they match the rest of the HUD.
- Guilds. Lasting communities with a name and tag, a leader, officers and members, their own chat (
/gu), tags in front of names, shared wards and vault chests. - Duels and arena. A leader challenges another group; PvP is on for both sides and every death is a point for the other. An admin can set an arena where PvP is always on.
- Each group's own boss list. The bosses a group beats together are remembered and each adds a little to the group's skill bonus.
- Group scaling. If the server turns it on: tougher enemies and more drops for each extra member around a fight.
- Admin tools. Server admins get a tab listing every group and guild, with disband and remove.
- Discord announcements. The server can announce guilds, duels, first boss kills and groups looking for members to a Discord webhook.
- Groups that last. The server keeps the groups, so a group survives a dropped connection, a relog and a server restart.
- Up to 6 members by default (2 to 10, set by the server).
- Your language. The interface follows the language the game is set to. English, Turkish, German, French, Spanish and Russian are built in; any other can be added as a file.
Installation
Install with your mod manager, or put HLGroups.dll into BepInEx/plugins.
Install it on the server and on every player who wants to use groups. It is the same file for both.
A player without the mod can still join and play normally. They cannot be invited, and other players see a note saying so instead of the invite prompt.
Keys
| Action | Default |
|---|---|
| Invite the player you are looking at | G |
| Open or close the group menu | F6 |
| Accept an invitation | Y |
| Decline an invitation | N |
| Ping the map for the group only | hold Left Alt while pinging |
| Ping what you look at for the group | middle mouse button: a creature, a chest, an object or just the spot |
| Group chat | type /g message or /p message in chat |
| Mark the creature you are looking at | H (again, or looking at nothing, clears it) |
| Answer a teleport, summon or join request | Y / N |
| Move the group panel or the combat meter | open the group menu and drag them |
| Guild chat | type /gu message in chat |
| Make a chest a guild vault, or undo it | look at a chest you built and type /gvault in chat |
Keys do nothing while you are typing in chat, the console or any text box.
Configuration
Settings are in BepInEx/config/com.hephaestuslabs.groups.cfg.
| Section | Setting | Default | What it does |
|---|---|---|---|
| General | Enabled | true | Master switch. |
| General | Language | auto | auto follows the game's language. To force one, write the game's name for it, such as German. |
| Keys | Invite key, Menu key, Accept key, Decline key | G, F6, Y, N | See above. |
| Keys | Group ping modifier | LeftAlt | Hold while pinging the map to ping the group only. |
| Keys | Ping what you look at | Mouse2 | Middle mouse button. Pings what is under your crosshair for the group. The game uses the same button for the secondary attack, so with a weapon in hand both happen: pick another key or set the held key below. Not used while building. |
| Keys | Ping what you look at: held key | None | If set, the ping key only works while this key is held, for example LeftAlt. |
| Keys | Invite range | 30 | How close, in meters, a player must be for the invite prompt. |
| Display | Show group members | true | The on-screen member list. |
| Display | Member list X / Y | 24 / 260 | Position of the list, in pixels at 1080p. |
| Display | Scale | 1 | Size of the group interface. |
| Display | Show members on map | true | Map and minimap markers. |
| Display | Show stamina | true | The thin stamina bar under each health bar. |
| Display | Use game font | true | Draw the interface with the game's font. |
| Display | Show eitr | true | The thin eitr bar. |
| Display | Show status effects | true | Status effect icons next to each member. |
| Display | Show direction markers | true | Tags and screen-edge arrows for distant members. |
| Display | Direction marker distance | 25 | Members closer than this get no marker. |
| Display | Low health alert | true | Flashing bar and message for a member in danger. |
| Display | Low health percent | 25 | Health below this share counts as low. |
| Server | Maximum group size | 6 | Only the server's value counts. |
| Server | Any member can invite | true | If off, only the leader invites. Only the server's value counts. |
| Server | Invite timeout seconds | 60 | Only the server's value counts. |
| Server | Friendly fire in groups | false | Only the server's value counts. |
| Server | Skill bonus percent | 10 | Extra skill gain near another member; 0 turns it off. Only the server's value counts. |
| Server | Skill bonus range | 30 | Meters. Only the server's value counts. |
| Server | Share exploration | true | Members reveal the map for each other. Only the server's value counts. |
| Server | Shared exploration radius | 100 | Meters around a member. Only the server's value counts. |
| Display | Show death markers | true | Where members last died, on the map. |
| Keys | Mark target key | H | Marks the creature you look at for the group. |
| Display | Use game bars | true | Draws member bars with the game's own bar; plain bars if off or unavailable. |
| Display | Show marked target | true | The pointer and edge arrow for the group's target. |
| Display | Show marked target on map | true | A map marker on the group's target. |
| Display | Show combat meter | true | Damage per member in the current fight. |
| Display | Combat meter X / Y | 24 / 640 | Position of the meter; can also be dragged. |
| Display | Combat meter linger seconds | 30 | How long the meter stays after the last hit. |
| Server | Teleport to members | true | Only the server's value counts. |
| Server | Teleport cooldown seconds | 120 | Wait between group teleports for one player. Only the server's value counts. |
| Server | Teleport with any items | false | If off, the portal rule for ores applies. Only the server's value counts. |
| Server | Group wards | true | A ward lets its builder's group through. Only the server's value counts. |
| Server | Group private chests | false | Private chests open for the builder's group. Only the server's value counts. |
| Server | Group finder | true | Listing groups and asking to join. Only the server's value counts. |
| Display | Menu background tint | #8F5C3D | Colour laid over the wood panel of the menu and the prompt boxes. #FFFFFF leaves the game's light wood. |
| Display | Show tags on names | true | Guild tags in front of names, group members in the group's colour. |
| Display | Show duel score | true | Score and time left at the top of the screen during a duel. |
| Server | Teleport cost item / amount | (empty) / 0 | An item a group teleport costs, by prefab name such as Coins. Whoever travels pays. |
| Server | Guilds | true | Founding and joining guilds. |
| Server | Maximum guild size | 30 | 2 to 200. |
| Server | Friendly fire in guilds | false | If off, guild members cannot hurt each other except in a duel between their groups. |
| Server | Guild wards | true | A ward lets its builder's guild through. |
| Server | Group duels | true | Leaders can challenge other groups. |
| Server | Duel length seconds | 600 | The longest a duel lasts. |
| Server | Duel point target | 10 | The duel ends when one side reaches it; 0 leaves it to the clock. |
| Server | Duel points only in arena | true | With an arena set, deaths outside it score nothing. |
| Server | Group scaling | false | Tougher enemies and more drops for groups. Off by default. |
| Server | Scaling enemy health / damage / loot percent | 20 / 5 / 10 | Per extra group member near the fight. |
| Server | Scaling range | 50 | Meters from the fight within which a member counts. |
| Server | Group boss list | true | Groups and guilds remember the bosses they beat. |
| Server | Skill bonus percent per boss | 2 | Added to the group's skill bonus for each boss on its list; 0 keeps the list without the reward. |
| Outside | Discord webhook URL | (empty) | Server only. Empty turns announcements off. Only Discord webhook addresses are accepted. |
| Outside | Discord announcements | guilds,duels,bosses,finder | Server only. Which news is announced. |
| Outside | Write status file | false | Server only. Writes BepInEx/config/HLGroups/status.json every 30 seconds. |
All Server settings are read on the server; a player's own copy of them does nothing.
The server stores its groups in BepInEx/config/HLGroups/<world name>.groups.txt and its guilds and arena in <world name>.guilds.txt beside it.
Discord announcements are written in the server's language. Set Language in the server's copy of the settings to choose, for example Turkish.
Languages
The interface follows the language the game is set to. English, Turkish, German, French, Spanish and Russian are built in. To add another, open BepInEx/config/HLGroups/lang/_template.txt (written the first time the group menu is opened), save a copy named after the game's name for the language, such as Polish.txt, and translate the part after each =. A text left out is shown in English. A file named like a built-in language replaces single texts of it.
Compatibility
- ValheimPlus: works alongside it. HL Groups uses its own network messages and does not touch the game's chat or ping code.
- Requires BepInEx only. No other mods are needed.
- Built for dedicated servers and Valheim 1.0.21.
- A member who has turned on their public position is already shown by the game, so HL Groups does not add a second marker for them.
- Combat meter: damage is counted by the game that controls the creature at that moment, which is usually a nearby player. If that player does not have HL Groups, those hits are not counted. Fire and poison carry no name in the game, so their damage goes to whoever hit the creature last.
- Group private chests: whether a chest opens is also decided by the game that controls it at that moment. If that is a player without HL Groups, the chest stays closed to the group.
- Guild vaults: the same goes for vaults, the other way round too: a player without HL Groups does not see the mark and is held to the chest's ordinary rule. Keep vaults inside a ward on a server where not everyone has the mod. Whoever built the chest can always open it, in or out of the guild.
- Duels and the arena switch the game's own PvP setting on for the players involved and put it back afterwards. While it is on, any other player with PvP on can hurt them as well.
- Group scaling multiplies what the game already does for the number of players nearby, and what ValheimPlus's difficulty settings do, if you use those. Start with small numbers.
- The group boss list is a record with a small reward. It does not change which bosses count as defeated for the world, for raids or for traders.
Planned
Healing and deaths in the combat meter, and the admin tools as a tab inside Advanced Admin Panel.
