Rippleheart

Updated 2 weeks ago

Rippleheart

Rippleheart is a plugin for validating server and client data in Valheim, ensuring consistency between the server and client files.

Features

  1. Overview
  2. Configuration

1. Overview

The main features of Rippleheart include:

  • File Validation:Rippleheart provides a validation mechanism for ensuring file consistency between the server and client by checking the validity of files in specified paths.
  • Automatic Multilingual Switching:Automatically switches between Chinese and English interfaces based on the game environment.
  • Periodic Check:Allows you to set an interval for regular validation to ensure files on both ends remain synchronized.
  • Custom Path Support:Rippleheart supports custom relative paths, enabling flexible adaptation to different directory structures.
  • Logging Feature:Detailed logs and debug information are recorded, allowing developers to have a comprehensive understanding of the validation process.
  • Debug Mode:When debug logging is enabled, Rippleheart provides more detailed log information, which is helpful for troubleshooting.
  • Log Reset:Rippleheart allows for periodic resetting of logs to prevent log files from becoming too large, keeping the log records concise and readable.

2. Configuration

ServerValidationDirectory

Server(Validation Directory): C:\SteamLibrary\steamapps\common\Valheim\BepInEx\plugins*
  • Parameter Name: Server(Validation Directory)
  • Function: Specifies the file path on the server that needs validation.
  • Format: Use * to match all types, *.filetype to match specific file types, *.filetype,*.filetype to match multiple types of files.

ClientValidationDirectory

Client(Validation Directory): \BepInEx\plugins*
  • Parameter Name: Client(Validation Directory)
  • Function: Specifies the file directory on the client that needs validation.
  • Format: Same as the server validation directory, supports wildcards and file type matching.

PeriodicCheck

PeriodicCheck: 10
  • Parameter Name: PeriodicCheck
  • Function: Sets the time interval for performing periodic validation, in seconds. This time is calculated based on Unity game frame rates, which may have slight deviations.
  • Default Value: 10

CustomRelativePath

RelativePath: BepInEx
  • Parameter Name: RelativePath
  • Function: When enabled, the program calculates the relative path between the client and server based on specified breakpoints, facilitating cross-platform file consistency checks.
  • Example: If the client file path is "C:\Projects\BepInEx\File.txt" and the server file path is "D:\hsnm\BepInEx\File.txt", then the relative path would be BepInEx.

LoggingFeature

EnableLogs: true
  • Parameter Name: EnableLogs
  • Function: Enables or disables validation logs.
  • Default Value: true/false

DebugLoggingSwitch

EnableDebugLogs: true
  • Parameter Name: EnableDebugLogs
  • Function: Enables or disables debug logs, recording detailed debugging information.
  • Default Value: true/false

LogResetSwitch

ResetLogs: true
  • Parameter Name: ResetLogs
  • Function: Determines whether to reset the log file each time the game starts.
  • Default Value: true/false

LogResetInterval

Resetloginterval: 3600000
  • Parameter Name: Resetloginterval
  • Function: Sets the time interval for resetting logs, in milliseconds. The default value is one hour (3600000 milliseconds).

Instructions

Installation Steps

  1. Install using BepInEx.
  2. Copy Rippleheart.dll to the BepInEx/plugins folder on both server and client.

Feedback

Click here to access the feedback link

Changelog

Version Update Notes
0.1.2 - Added log switch and log reset functionality, as well as multilingual support.
0.1.1 - Fixed: Server overload when there are too many validators.
0.1.0 -
0.0.9 - Fixed: Description error
0.0.8 -
0.0.7 - Initial Release
Pages