Skip to content

Commit

Permalink
docs: update docs for 1.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
RobynLlama committed Aug 24, 2024
1 parent ce55f99 commit df92fa3
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

- Correctly determines the patching assembly for harmony patches. (No more blaming mscorlib for everything, whoops!)
- The exception broker will now send up to 3 exceptions each frame to the handler for processing. This should result in faster responses to exceptions without a substantial increase in overhead.
- Split whitelist into exception whitelist and frame whitelist
- Added exception blacklist and frame blacklist

## v1.4.0

Expand Down
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,37 @@ This mod has been dedicated to the [Lethal Company Modding community repo](https

## Configuration

- EnableWhiteList
- Enables or disables the built in whitelist for exceptions
> **Note**
>
> The blacklist works for either stage by matching the given string with the start of the assembly name that either produced the exception (in the exception context) or defined the method (in the frame context). This means that e.g. `Unity.Engine` will match any assembly name that begins with `Unity.Engine` such as `Unity.Engine.CoreModule`
- Exception Filter

> **Note**
>
> Any match at this level discards the entire stack without writing it. This is for filtering whole mods or assemblies that produce useless or ignorable errors.
- Whitelist
- Enable Whitelist: enables or disables the whitelist on an exception basis
- The whitelist cannot be configured but comes pre-loaded with common game assemblies. Enable this to substantially reduce log spam from UDA. Enabled by default
- Blacklist
- Enable Blacklist: enables or disables the blacklist on an exception basis
- The exception blacklist is a comma separated list of assembly names that will be pattern matched against the assembly that threw the exception. Disabled by default.

- Frame Filter

(those parts of the log that say `---FrameX`)

> **Note**
>
> Any match at this level discards only the single frame. This is mostly intended for filtering system or engine assemblies that never seem to have anything useful to say inside a stack frame.
- Whitelist
- Enable Whitelist: enables or disables the whitelist on a frame basis
- The whitelist cannot be configured but comes pre-loaded with common game assemblies. Enable this to slightly reduce log spam from UDA at the cost of less complete frame output when an error occurs. Disabled by default.
- Blacklist
- Enable Blacklist: enables or disables the blacklist on a frame basis
- The black list is a comma separated list of assembly names that will be pattern matched from the start of each frame's method's defining assembly. This is rarely useful except for filtering out specific system assemblies e.g. UnityEngine or mscorlib from your the stack. Disabled by default.

## How Does This Help Me?

Expand Down

0 comments on commit df92fa3

Please sign in to comment.