BountyForge Mod - README

This mod is actively maintained and will continue to receive improvements and optimizations. For issues or support or mod abuse in anyway, please reach out to Darreaninility#4118 on the VArena Discord or The Modding Community Discord (link usually found at V Rising Modding Wiki).

Description

BountyForge is a mod that introduces a player-driven bounty system and an engaging assassin contract mechanic to your server. It allows players to place bounties on others using configurable items, hunt down targets for rewards, and compete on a leaderboard. Additionally, the assassin contract system randomly assigns timed kill missions to players. The mod also features a clan betrayal system to prevent users for leaving clans to claim bounties. With BountyForge, you can:

• Enable players to place bounties on each other.
• Allow players to claim bounties by defeating their targets.
• Offer random, timed assassination contracts to players with specific kill objectives.
• Implement a "clan betrayal" cooldown, preventing players from immediately claiming bounties on or getting contract credit for killing recent former clanmates.
• Display map icons for players who have bounties on them.
• Maintain a leaderboard tracking the most successful bounty hunters.
• Customize all aspects of the bounty and contract systems through detailed configuration.

##TODO

• Make the text more attractive.

Features

Player-Placed Bounties

• Players can place bounties on others using a configurable item and amount (.addbounty).
• Successful kills on bountied targets reward the killer.

Assassin Contract System

• Randomly assigns timed assassination contracts to eligible online players.
• Contracts require eliminating a specified number of any other players within a time limit.
• Successful contract completion yields a configurable reward.
• Players can check their contract status (.contract).

Clan Betrayal Prevention

• When a player leaves a clan, a configurable cooldown period is initiated between the leaver and their former clanmates.
• During this cooldown, attempting to claim a bounty on a recent former clanmate will be voided.
• Killing a recent former clanmate will not count towards assassin contract progress.

Bounty Claiming & Self-Claim

• Bounties are typically claimed upon downing the target.
• Optional: Bountied players can "self-claim" their own bounty by achieving a configurable number of PvP kills while bountied.

Leaderboard

• Tracks total bounty values claimed by players (.bountytop).

Map Icons

• Displays a configurable map icon on players who have an active player-placed bounty on them.

Player Information Commands

• List all active player-placed bounties (.bountylist).
• Check personal bounty status and self-claim progress (.bountyme).
• Check current assassin contract status (.contract).

Configuration

• Extensive settings for payment items, minimum amounts, contract parameters, betrayal cooldown, feature toggles, and more via BountyForge.cfg.

Admin Commands

• Reload mod configuration (.reloadbountyforge).
• Clear map icons (.bfclearicons).

Commands

Note on Player Names: When using commands that require a player name, ensure you use their current in-game character name.

Admin-Only Commands:

• .reloadbountyforge: Reloads the BountyForge configuration and data from disk.
• .bfclearicons <all|PlayerName>: Clears bounty map icons. Use "all" to attempt to clear all tracked icons, or a player's name to clear icons specifically for that player and perform a more aggressive scan for their icons.

Player-Accessible Commands:

• .addbounty <PlayerName> <Amount> (alias: .ab): Places a bounty of a specified amount on a player. Requires the configured payment item and amount in your inventory.
• .bountylist (alias: .bl): Lists all active player-placed bounties, ordered by reward amount.
• .bountyme: Shows your current bounty status (if you are a target), your self-claim progress, and your total bounty rewards claimed on the leaderboard.
• .contract (alias: .ac): Shows your current assassin contract status, including objective, progress, time remaining, and reward.
• .bountytop (alias: .bt): Displays the top bounty hunters by total bounty value claimed.

Configuration

All BountyForge configuration settings are located in the BepInEx/config/BountyForge.cfg file (created automatically after the first server run with the mod). Data files (like active bounties, contracts, and betrayal cache) are stored in BepInEx/config/BountyForge/Data/.

Key configuration sections in BountyForge.cfg:

• [General]:
  • Enabled (true/false): Enable or disable the entire BountyForge mod.
  • DebugLogging (true/false): Enable detailed debug logging. (Most BountyManager logging is now removed, but other parts might use this).
• [Bounty.Placement]:
  • PaymentItemGUID (integer): Prefab GUID of the item used for bounty payments (e.g., Thistle).
  • PaymentItemName (string): Display name for the payment item.
  • MinimumBountyAmount (integer): The minimum amount required to place a bounty.
• [Bounty.Claiming]:
  • ForbidPlacerReclaimingPayment (true/false): If true, the bounty placer does not get their items back if they kill their own target.
  • EnableTargetSelfClaimViaKills (true/false): Allows bountied players to self-claim by getting kills.
  • KillsForTargetSelfClaim (integer): Number of kills needed for self-claim.
• [Leaderboard]:
  • TargetSelfClaimAddsToScore (true/false): If self-claims add to the leaderboard.
  • PlacerReclaimAddsToScore (true/false): If placer reclaiming their bounty (if allowed) adds to their score.
• [MapIcons]:
  • EnableMapIcons (true/false): Toggle map icons for player-placed bounties.
  • BountyMapIconGUID (integer): Prefab GUID for the map icon.
• [AssassinContractSystem]:
  • EnableAssassinContracts (true/false): Enable the assassin contract system.
  • OfferMinIntervalSeconds / OfferMaxIntervalSeconds (integer): Min/max time between contract offers.
  • MinKillsRequired / MaxKillsRequired (integer): Range for kills needed per contract.
  • TimeLimitSeconds (integer): Duration player has to complete a contract.
  • MinRewardAmount / MaxRewardAmount (integer): Range for contract reward amounts.
  • MaxActiveContracts (integer): Maximum number of concurrent assassin contracts server-wide (0 for unlimited).
• [Social]:
  • EnableClanBetrayalPrevention (true/false): Enable the clan betrayal system.
  • ClanBetrayalCooldownSeconds (integer): Duration (e.g., 86400 for 24 hours) the "can't claim on ex-clanmate" rule lasts.

Installation Instructions

1. Ensure BepInEx is correctly installed on your V Rising server.
2. Download the latest BountyForge.dll from the releases page (or your build location).
3. Place BountyForge.dll into your server’s BepInEx/plugins directory.
4. Start the server once. BountyForge will generate its default configuration file (BountyForge.cfg) in the BepInEx/config/ folder and data subfolder BepInEx/config/BountyForge/Data/.
5. Adjust the configuration as needed and use .reloadbountyforge or restart the server.

Dependencies

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

Support & Community

For support, questions, or to join the community:

• Join the VArena Discord: https://discord.gg/varena
• Join The Modding Community Discord (often linked from the V Rising Modding Wiki).
• 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)

Credit

• Gator for publishing to original bounty mod (GatorBounty) for the public.

License

This BountyForge 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: BountyForge is a third-party mod and is not affiliated with Stunlock Studios or the official V Rising development team. Use at your own risk.