RaidForge Mod - README

This mod is actively maintained and will continue to receive improvements and optimizations. Some issues may occur due to its complexity and the specific conditions it requires. For issues, requests, or support, please feel free to DM me inility#4118 on Discord, reach out on the VArena Discord, or The Modding Community Discord (resources available at https://wiki.vrisingmods.com/).

• For shard raiding , I recommend using a mod like Kindred Commands and configuing options for how long shards can stay on the ground , so players do not drop them in their base and log off to prevent being offline raided.

Work in Progress / Future Plans

• Adding Raiding with Weapons (not just Golems/Explosives ill add it soon).
• Further optimizations, especially around raid interference checks.
• Possibly more changes to the opt in and out system for shards , will wait for feedback.

Patch Notes

(3.0.0) - Shards & Choices

• Shard Vulnerability: Holding a Soul Shard now matters! If EnableOfflineProtection is true, bases belonging to offline players/clans will become vulnerable if they are storing a Soul Shard in a pedestal when the last member logs off. Taking the shard might make them safe again... or maybe not? You decide! (Currently, protection doesn't automatically re-enable if the shard is stolen while offline).
• Opt-In Raiding System: Added a completely new, alternative raiding mode!
  • Enable via OptInRaiding.cfg. IMPORTANT: This mode is MUTUALLY EXCLUSIVE with the standard EnableOfflineProtection. If Opt-In is enabled, standard ORP is ignored.
  • Players/clans use .raidoptin to make their base raidable.
  • Players can use .raidoptout to become protected again (after a configurable time lock).
  • Check status with .raidoptstatus.
  • Admins can use .forceopt <PlayerName> <in|out> to override status.
  • Includes an optional daily schedule (OptInSchedule.cfg) to force raiding on specific days, regardless of opt-in status.
• Admin Immunity: Sorry admin vamps for letting you burn! Admins interfering in raids they aren't part of will no longer receive the 'Interloper' debuff. Go cause chaos (or just observe peacefully, do this and dont admin abuse)!
• Code Cleanup: Removed unnecessary logging and cleaned up some code for better stability.

(2.2.0) - OakVeil

Right, so about those decayed bases...

• Fixed an issue where you could not raid decayed bases. You can now raid them.
• Added a new toggle for notifications when someone is raiding a decayed base (AnnounceDecayedBaseRaid in OfflineProtection.cfg).
• Fixed teleport issues for new players; those with the PvP protection buff can now use teleports freely during raids (meaning they can leave spawn also).
• Fixed an issue that prevented players from leaving with the teleporter after beating Dracula.
• Added improved persistence for reboots. Players who disconnect from the game (if you're in a clan, only the last clan member to log off will be recorded) will be put into the offline grace period, and their status will be saved to disk. However, due to optimization considerations, if the server reboots while a player is online, their base will automatically go into full offline protection mode (will no longer be on connect).
• Changed the interference debuff visual to something not so loud.

(2.1.0)

• Added a global announcement for when a raidable, offline player's base is being raided (AnnounceOfflineRaidDuringGrace in OfflineProtection.cfg).
• Added Timezone configuration (RaidScheduleTimeZoneForDisplay in RaidScheduleAndGeneral.cfg) so that when using .raiddays, players can see the server's timezone.
• Fixed an issue with raid prevention on minor and major explosives.

(2.0.2)

• Fixed issues with not all doors being protected while being offline-raided.
• Added a configuration option for the grace period (GracePeriodMinutes in OfflineProtection.cfg).

Description

RaidForge is a comprehensive V Rising mod designed to give server administrators enhanced control over raid mechanics, offline base protection, and raid participation. It allows for custom raid schedules, automated Siege Golem health adjustments, protection for offline players' bases (including grace periods and shard vulnerability), an alternative Opt-In Raiding mode, and management of interference during active sieges.

With RaidForge, you can:

• Manually enable or disable raiding periods instantly.
• Configure specific daily raid windows using the server's local time.
• Automate Siege Golem health adjustments based on server runtime.
• Manually set and persist Siege Golem health levels.
• Protect offline players' bases from damage with a configurable grace period system... unless they're holding a Soul Shard!
• Alternatively, implement an Opt-In system where players choose when they are raidable.
• Discourage third-party interference during active Golem sieges (Admins are immune!).
• Allow players to view raid schedules, upcoming raid times, and detailed base vulnerability status.
• Restrict Waygate usage during active raid windows.

🚨 IMPORTANT Setup & Conflicts 🚨

1. DISABLE DEFAULT RAID HOURS: To prevent conflicts and ensure RaidForge can fully manage raid windows, you MUST disable your server's default raid hour configurations found within your ServerHostSettings.json. Leaving default game raid hours active WILL cause overlapping schedules and raids starting/stopping at unexpected times. Set CastleDamageMode to Never or TimeRestricted (with no time specified) in your server settings, and let RaidForge handle it.
2. CHOOSE YOUR PROTECTION MODE: RaidForge offers two main protection systems, but only ONE can be active at a time:
   • Standard Offline Raid Protection (ORP): Enabled via EnableOfflineProtection = true in OfflineProtection.cfg. This protects bases when owners are offline (after a grace period), BUT makes them vulnerable if they hold a Soul Shard.
   • Opt-In Raiding: Enabled via EnableOptInRaiding = true in OptInRaiding.cfg. With this, bases are always protected by default, unless the player/clan uses .raidoptin.
   • CONFLICT: If EnableOptInRaiding is set to true, the EnableOfflineProtection setting (including Shard Vulnerability and Grace Period) is COMPLETELY IGNORED. Choose the system that fits your server best.

Features

• Manual Raid Control: Instantly enable (.raidon) or disable (.raidoff) raids, overriding any schedule.
• Scheduled Raids: Define custom start and end times for raiding for each day of the week via RaidScheduleAndGeneral.cfg. Raids automatically toggle based on this schedule.
• Advanced Offline Raid Protection (ORP): (Only active if Opt-In Raiding is disabled)
  • Shields bases from damage when all associated defenders (clan members or solo owner) are offline.
  • Includes a configurable grace period (default 15 minutes) defining a window of vulnerability after the last defender logs off.
  • Soul Shard Vulnerability: If enabled, offline bases holding a Soul Shard in a pedestal will remain vulnerable even after the grace period expires.
  • Global enable/disable via EnableOfflineProtection in OfflineProtection.cfg.
• Opt-In Raiding System: (Alternative to ORP; Ignored if ORP is enabled)
  • Bases are protected by default.
  • Players/Clans use .raidoptin to become raidable.
  • Configurable lock duration prevents immediate opt-out (OptInLockDurationHours in OptInRaiding.cfg).
  • Players use .raidoptout to become protected again after the lock expires.
  • Optional daily schedule (OptInSchedule.cfg) can force all players to be raidable on specific days.
  • Global enable/disable via EnableOptInRaiding in OptInRaiding.cfg.
• Dynamic Raid Interference System:
  • Discourages third-party interference during active Golem sieges.
  • Automatically applies a debuff ("Interloper") to players in siege territory who aren't attacking/defending.
  • Admin Immunity: Players flagged as admin are immune to this debuff.
  • Global enable/disable via EnableRaidInterference in RaidInterference.cfg.
• Automated Golem Health:
  • Set a "server start date" for automation (.golemstartdate).
  • Configure Golem health levels to activate automatically based on days passed (GolemSettings.cfg).
  • Enable/disable day-based automation.
• Manual & Persistent Golem Control:
  • Check current Golem health settings (.golemcurrent).
  • Manually set and persist a Golem health level (.golemsethp <LevelName>), overriding automation.
  • Clear manual overrides (.golemauto).
  • List available levels (.golemlist).
• Player Information Commands:
  • Check raid times (.raidt).
  • View weekly schedule (.raiddays).
  • Check base vulnerability status (.raidstatus <PlayerName>).
  • Check Opt-In status (.raidoptstatus).
• Configurable Waygate Restrictions: Optionally prevent Waygate use during active raid windows (RaidScheduleAndGeneral.cfg).
• Configuration Reload: Admins can reload all mod configs live (.reloadraidforge).

Commands

Note on Displayed Times: All times shown by RaidForge commands (e.g., .raiddays, .raidt) are based on the server's local timezone and clock, not your individual client's timezone.

Admin-Only Commands:

• .reloadraidforge: Reloads all RaidForge configuration files.
• .raidon: Forces raids ON immediately.
• .raidoff: Forces raids OFF immediately.
• .golemstartdate: Sets the Golem Automation start date to now.
• .golemcurrent: Shows current Golem health settings.
• .golemsethp <LevelName>: Manually sets a persistent Golem health level (overrides automation).
• .golemauto: Clears manual Golem health override.
• .golemlist: Lists available Golem health levels.
• .forceopt <PlayerName> <in|out>: (Opt-In Mode Only) Forces a player/clan's opt-in status.

Player-Accessible Commands:

• .raidt: Shows time until the next raid or current status.
• .raiddays: Displays the weekly raid schedule.
• .raidstatus <PlayerName>: Shows raid vulnerability status for the player's base(s).
• .raidoptin: (Opt-In Mode Only) Opts you/your clan IN to being raidable.
• .raidoptout: (Opt-In Mode Only) Opts you/your clan OUT of being raidable (if time lock expired).
• .raidoptstatus: (Opt-In Mode Only) Checks your current opt-in status and time lock.

Configuration

All RaidForge configuration files are generated in BepInEx/config/RaidForge/ after the first server run. Remember to use .reloadraidforge after making changes!

1. RaidScheduleAndGeneral.cfg

• [DailyRaidSchedule]: Define raid start/end times (HH:mm format, 24-hour clock) for each day.
  • Use 00:00 for both start/end if no raid is scheduled.
  • Times spanning midnight are supported (e.g., Fri 22:00 to Sat 02:00). Set Fri end to 00:00 or 24:00, Sat start/end normally.
• [General]:
  • AllowWaygateTeleportsDuringRaid (true/false): Allow/disallow Waygate use during active scheduled/forced raids.
  • RaidScheduleTimeZoneForDisplay (string, e.g., "EST", "Server Time"): Text shown next to times in .raiddays.

2. GolemSettings.cfg

• [GolemMainControls]:
  • EnableDayBasedAutomation (true/false): Toggle Golem health automation.
  • ServerStartDateForAutomation (yyyy-MM-dd HH:mm:ss): Start date for automation. Set via .golemstartdate.
  • ManualOverrideSiegeLevel (string, e.g., Normal): Manually sets Golem health, overriding automation. Set via .golemsethp, cleared by .golemauto.
• [GolemDayBasedAutomationSchedule]: Configure when each health level activates based on days passed since the start date.

3. OfflineProtection.cfg

• [OfflineRaidProtection]: (Ignored if Opt-In Raiding is enabled)
  • EnableOfflineProtection (true/false): Toggle the standard ORP system (Grace Period + Shard Vulnerability).
  • GracePeriodMinutes (float, e.g., 15.0): Duration (minutes) a base remains vulnerable after the last defender logs off. 0 for immediate protection (unless shard vuln.).
  • AnnounceOfflineRaidDuringGrace (true/false): Global chat announcement when an offline (but in grace period) base is damaged by siege.
  • AnnounceDecayedBaseRaid (true/false): Global chat announcement when a decayed base is damaged by a player.

4. RaidInterference.cfg

• [Raid Interference]:
  • EnableRaidInterference (true/false): Toggle the system that debuffs non-admin interlopers during active Golem sieges.

5. OptInRaiding.cfg

• [Opt-In Raiding]: (Only active if enabled)
  • EnableOptInRaiding (true/false): Globally enables the Opt-In system. If true, OfflineProtection.cfg settings are ignored.
  • OptInLockDurationHours (integer, e.g., 24): Hours a player/clan must remain opted-in before they can .raidoptout.

6. OptInSchedule.cfg

• [Opt-In Schedule]: (Only active if EnableOptInRaiding is true)
  • EnableOptInSchedule (true/false): If true, uses the daily settings below. If false, the standard opt-in logic applies every day.
  • {Day}AllowOptInSystem (true/false for each day): If true, opt-in/out works normally. If false, everyone is forced raidable on that day, regardless of their opt-in status.

7. Troubleshooting.cfg

• [Logging]:
  • EnableVerboseLogging (true/false): Enable detailed logs (may impact performance).

Installation Instructions

1. Ensure BepInEx is correctly installed on your V Rising server.
2. Download the latest RaidForge.dll from the releases page.
3. Place RaidForge.dll into your server’s BepInEx/plugins directory.
4. Start the server once. RaidForge will generate its default configuration files in the BepInEx/config/RaidForge/ folder. Configure as needed.
5. Use .reloadraidforge in-game (as admin) after making config changes, or restart the server.

Dependencies

• deca-VampireCommandFramework: Required for chat command functionality. Ensure it's installed.

Support & Community

For support, questions, feature requests, or to join the community:

• DM me on Discord: Darrean (inility#4118)
• Join the VArena Discord: https://discord.gg/varena
• Join The Modding Community Discord.
• For general V Rising modding discussions and finding other mods, visit the V Rising Modding Wiki: https://wiki.vrisingmods.com

Acknowledgements

Special thanks to the V Rising Modding community and the developers of the underlying frameworks that make mods like this possible.

Developer

• Darrean (inility#4118)

Contributors

• helskog - Feature for preventing Waygate usage during a raid window.
• Mitch (zfolmt) - Inspiration and concepts from their "Raid Guard" mod for the Raid Interference feature.
• Rendy - For help with addressing complex tasks such as offline raiding retention periods.
• Fingledobe - For testing and reporting impactful bugs clearly.

License

This RaidForge mod is licensed under the MIT License with a non-commercial clause.

Summary:

• You ARE free to use, copy, modify, merge, publish, and distribute copies of this software.
• You MUST include the original copyright notice and this permission notice in all copies or substantial portions of the software.
• You MAY NOT sell copies of the Software or derivative works based on the Software for profit.
• THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Disclaimer: RaidForge is a third-party mod and is not affiliated with Stunlock Studios or the official V Rising development team. Use at your own risk.