Rippleheart

Rippleheart 0.1.4 Changelog

Update Overview

• Fixes and Improvements: Updated the descriptions for validation paths to enhance usability and clarity, added a setting to manage the log reset interval for better log management, and optimized the explanation for the periodic check functionality.

Main Features

1. Overview
2. Configuration

• Server Validation Path
• Client Validation Path
• Periodic Check
• Custom Relative Path
• Logging Functionality
• Log Switch
• Debug Switch
• Reset Log Switch
• Reset Log Interval

1. Overview

The main features of Rippleheart include:

• File Validation: Provides a validation mechanism to ensure consistency between server and client files 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 setting an interval for regular validation to ensure files on both ends remain synchronized.
• Custom Path Support: Supports custom relative paths to flexibly adapt to different directory structures.
• Logging Functionality: Records detailed logs and debug information, helping developers gain 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: Allows for periodic resetting of logs to prevent log files from becoming too large, keeping the log records concise and readable.

2. Configuration

Server Validation Path

# Server (Validation Directory): F:\GSM\servers\2\serverfiles\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, and *.filetype,*.filetype to match multiple file types.

Client Validation Path

# Client (Validation Directory): \BepInEx\plugins\*

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

Periodic Check

# Periodic Check Interval: 3000

• Parameter Name: Periodic Check Interval
• 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.

Custom Relative Path

# Custom Relative Path: BepInEx

• Parameter Name: Custom Relative Path
• Function: When enabled, the program calculates the relative path between the client and server based on specified breakpoints to facilitate cross-platform file consistency checks.
• Example: If the full 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.

Logging Functionality

# Log Switch: true

• Parameter Name: Log Switch
• Function: Enables or disables validation logs.

Debug Switch

# Debug Switch: true

• Parameter Name: Debug Switch
• Function: Enables or disables debug logs, recording detailed debugging information.

Reset Log Switch

# Reset Logs: true

• Parameter Name: Reset Logs
• Function: Determines whether to reset the log file each time the game starts.

Reset Log Interval

# Reset Log Interval: 24 # In hours

• Parameter Name: Reset Log Interval
• Function: Sets the time interval for resetting logs in hours. The default value is 24 hours.

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 Feedback Link

Changelog

| Version | Update Notes | |-----------|--------------------------------------------------------------------------------------------------| | 0.1.4 | - Updated the description for validation paths to enhance usability and clarity.
- Added a setting for the log reset interval to optimize log management.
- Optimized the explanation for the periodic check functionality. | | 0.1.3 | - Fixed BepInEx warning error by downgrading BepInEx version to 5.4.2202. | | 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 |