V5.5.0

Please back up your older version before updating to the new version!
If you have any question, please let me know on the Discord server
(and if applicable, pull up an issue on GitHub).

---

[V5.5.0]

Fixed

• A bug that could cause PlayerDisplay to send hint after it was destructed.
• A bug that caused HintCollection not to remove key from the collection when its corresponding List<Hint> was empty.
• A bug that caused AbstractHint not to unbind AbstractHint::OnContentUpdate from AbstractHint::content::ContentUpdated.
• A bug that caused unnecessary delay in hint update.
• A bug that caused AutoContent to keep calling the function when AutoContent::autoText kept throwing exceptions.
• A bug that could potentially cause NullReferenceException in PlayerDisplay::Destruct().
• Bugs that could cause thread issues in TaskScheduler.
• A bug in AbstractHint, Hint, and DynamicHint that caused deadlock when multiple instances in the same PlayerDisplay were updated at the same time.
• A bug that caused some methods in common hint to use wrong default display time.

Changed

• Set CompatibilityAdaptor to disabled by default to ensure safety.
• Moved dependencies to the GitHub repo.
• Improved code style based on code style restrictions.
• Improved performance of PlayerDisplay::ScheduleUpdate(float, AbstractHint?).
• Replaced Hints.HintEffectPresets.TrailingPulseAlpha(1, 1, 1) with Hints.AlphaEffect(1) to improve performance.
• Rewrote DefaultDisplayOutput and Patches to ensure compatibility with the new version.
• Made minor adjustments in PlayerDisplay to prevent critical stability issues.
• Improved tests naming and code style in HintServiceMeow.Test.
• Replaced MEC with ICoroutine in PlayerDisplay and CompatibilityAdaptor to remove the Unity dependency.
• Made RichTextParserPool to clear status before returning a RichTextParser.
• Made HintParser independent of Mirror.
• Improved HintParser's performance. Achieved up to 32% faster execution and reducing memory allocation by up to 76%.
• Improved HintServiceExample for a more detailed and comprehensive demonstration.
• Improved performance of HintExtension and PlayerDisplayExtension.

Added

• PlayerDisplay::AddHint(params AbstractHint[]), RemoveHint(params AbstractHint[]), SetMinUpdateInterval(TimeSpan), AddHint(AbstractHint?, string), RemoveHint(AbstractHint?, string), ShowHint(AbstractHint, float, AfterShowAction), and ShowHint(IEnumerable<AbstractHint>, float, AfterShowAction).
• Mandatory code style restrictions when using Release mode. (Thanks to @Someone)
• Bug report template, feature request template, and Code of Conduct file.
• Cache in HintCollection::AllGroups and HintCollection::AllHints.
• Debug log to PlayerDisplay.
• Unit tests to PlayerDisplay, Cache, PeriodicRunner, UpdateAnalyzer, DynamicHint, HintCollection, Hint, CompatibilityAdaptor, HintParser, RichTextParser, ConcurrentTaskDispatcher, CoordinateTools, AutoContent, StringContent, Patcher (not activated yet), Patches (not activated yet), RichTextParserTool, and StringBuilderPool. Tests related to Harmony patches are not activated since Harmony cannot run in a test environment.
• HintServiceMeow.Benchmark to measure the performance of HintServiceMeow.

V5.4.4

Please back up your older version before updating to the new version!
If you have any issues, please let me know on the Discord server
(and if applicable, pull up an issue on GitHub).

V5.4.2

V5.4.2

• Fix a bug that cause CA not to clear the hint correctly

Please back up your older version before updating to the new version! If you have any issues, please let me know on the Discord server (and if applicable, pull up an issue on GitHub).

V5.4.1

V5.4.1

• Centralized multithread actions to improve performance
• Removed YamlDotNet for better compatibility

Please back up your older version before updating to the new version! If you have any issues, please let me know on the Discord server (and if applicable, pull up an issue on GitHub).

V5.4.0

!!!!!!!!!!!!!!!!BREAKING CHANGES!!!!!!!!!!!!!!!!
Update your plugin that depends on HintServiceMeow before updating to this version

This version is made for SCP: SL 14.1.0

Please back up your older version before updating to the new version! If you have any issues, please let me know on the Discord server (and if applicable, pull up an issue on GitHub).

V5.4.0 Beta 2

!!!!!!!!!!!!!!!!BREAKING CHANGES!!!!!!!!!!!!!!!!
Install this version only when LabAPI is available on your server.

Please back up your older version before updating to the new version! If you have any issues, please let me know on the Discord server(and if applicable, pull up an issue on GitHub).

What’s fixed

• Overflow crash in CompatibilityAdaptor (long‐duration hints)
• LINQ crash in CoordinateTool
• “Collection was modified” crash in HintParser
• Server-startup error reported on GitHub

What’s changed

• Patcher made public
• Parameters moved into separate model classes
• Supported default AutoText refresh rate
• PlayerDisplay methods added: HasHint, TryGetHint(...), etc.
• PlayerDisplay.DisplayOutputs rewritten
• Plugin class now calls base.OnEnabled() / base.OnDisabled()
• Required EXILED version bumped

Improvements

• Improved HintCollection and TaskScheduler stability and performance
• New Cache class added
• UpdateAnalyzer performance refined
• TextWidth data compressed for lower memory use

V5.4.0 Beta 1

Install this version only when LabAPI is available on your server.

• Support for LabAPI
• Remove support for NWAPI
• Remove hint update frequency limitation
• Bug Fixing

V5.3.14

Please back up your older version before updating to the new version! If you have any issues, please let me know on the Discord server.

V5.3.14

• Fix the bug that the AutoText will continue to call after PlayerDisplay is being destructed

V5.2.5 Compatibility Adapter.

V5.2.0

• Add Compatibility Adapter.
• Improve performance.

V5.2.1

• Fix the bug that the config might not apply for the compatibility adapter.

V5.2.2

• Bug fixing.
• Performance improvement.
• Improve code quality.

V5.2.3

• Improve compatibility adapter's accuracy. Fixed the font size issue.

V5.2.4

• Add support for color, b, and i tags in the compatibility adapter.
• Add more methods to player display.

V5.2.5

• Fix the problem that the compatibility adapter's cache might cause high memory usage

V5.1.2

Add support for \n in text
Improve Dynamic Hint's performance

V5.1.1

• Fix the bug that causes text length to be calculated incorrectly

V5.1.2

• Adjust sync speed to improve display performance
• Add LineHeight property for all hints