RevealForge Mod - README

This mod aims to enhance server transparency by announcing various and most admin actions to prevent the term "admin abuse" from being called out. ideal for admins playing on their server. This mod gives limited config options(currently none) to make sure that the most impactful commands are announced and cannot be disabled.

Description

RevealForge is a V Rising server-side mod designed to provide real-time visibility into administrative actions and significant server events. By announcing these actions in the global chat, it helps maintain transparency and build trust within the player community, allowing everyone to be aware of administrative interventions or spawned items/events.

What RevealForge Announces

RevealForge monitors and announces the following admin-triggered events and commands in the global chat from the command console not VCF(All admin VCF commands are announced currently):

• Player Health Adjustments: When an admin changes the health of an entity using debug tools.

  • Example Format: Admin <AdminName> increased health by 100 using a console command.

• Achievement Completion: When an admin completes achievements for a player.

  • Example Format: Admin <AdminName> completed current achievement for <PlayerName>.

• Admin Blood Consumption: When an admin uses a command to change their blood type/quality.

  • Example Format: Admin <AdminName> consumed Scholar Blood (Quality: 100%, Amount: Full).

• Item Spawning & Creation:

  • General 'give' command usage: Admin <AdminName> used 'give' for <ItemName> (Amount: X).
  • Jewel creation (debug event & console command): Admin <AdminName> created a Tier <X> jewel: <JewelAbilityName> (Stats: Y).
  • Legendary weapon creation (debug event & console command): Admin <AdminName> created legendary Tier <X> <WeaponName> (Stats: Y).
  • Blood Potion generation: Admin <AdminName> generated a <BloodPotionName> Potion (Quality: X%).
  • Item Set/Combat Preset spawning (via giveset or debug event): Admin <AdminName> spawned Combat Preset: <PresetName>. or Admin <AdminName> created Tier X jewels for all slots (Stats: Y).

• Player Rename Events: When an admin renames a player.

  • Example Format: Admin <AdminName> renamed <OldPlayerName> to <NewPlayerName>.

• General Chat Command Announcements (via VampireCommandFramework Integration):

  • For VCF not the command console, admin-only chat commands that are processed through the VampireCommandFramework are announced.

• Enhanced Transparency: Keeps players informed about administrative actions on the server.

• Event Awareness: Notifies the server population when significant items or events are triggered by admins.

• Core Transparency by Design: RevealForge intentionally offers minimal configuration for disabling specific announcements to ensure its primary goal of server transparency is maintained by default. Admins cannot selectively turn off visibility for these logged events.

• Lightweight: Focuses solely on announcing events without adding complex systems or commands.

Future Development / Todo

• Granular Command Filtering: Enhance the VCF integration to allow server owners to refine a more limited of commands that could not be considered "abuse"
• Expanded Event Coverage: Investigate and add announcements for other relevant admin actions or server events where appropriate.
• Player-Accessible Log: Consider adding a feature for players to check a recent history of announced admin actions (e.g., via an in-game command).
• Configuration for Impactful Commands: Introduce options to toggle announcements for commands or events that are deemed less impactful by server administrators.

Dependencies

• BepInEx: Required to load any V Rising mods.
• VampireCommandFramework (VCF): Required for the middleware that announces generic admin commands executed via VCF. Ensure it's installed on your server.

Installation Instructions

1. Ensure BepInEx is correctly installed on your V Rising server.
2. Download the latest RevealForge.dll from its source (e.g., GitHub releases, modding community post).
3. Place RevealForge.dll into your server’s BepInEx/plugins directory.
4. Start the server. No additional configuration files are created or strictly needed by RevealForge for its core announcement functionality, as event hooks are active by default.

Support & Community

For support, questions, or to join the community:

• Join the VArena Discord: https://discord.gg/varena
• Join The Modding Community Discord (often found via 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

Developer

• Darrean (inility#4118)

License

This RevealForge mod is licensed under the MIT License.

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. 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

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