Skip to content

Commit

Permalink
README.md update in regard to release 5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mcpiroman committed Mar 2, 2019
1 parent ebfbcdb commit 1e63802
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ These options are editable via `DllManipulator` script.
+ _Lazy_ - All DLLs and functions are loaded as they're first called. This allows them to be easily unloaded and loaded within game execution.
+ _Preloaded_ - Slight preformance benefit over _Lazy_ mode. All DLLs and functions are loaded at startup. Calls to unloaded DLLs lead to crash, so mid-execution it's safest to manipulate DLLs if game is paused.
* __dlopen flags [Linux and Mac only]__ - Flags used in dlopen() P/Invoke on Linux and OSX systems. Has minor meaning unless library is large.
* __Crash logs__ - Logs each native call to file. In case of crash or hang caused by native function, you can than see what function was that, along with arguments and, optionally, stack trace. In multi-threaded scenario there will be one file for each thread and you'll have to guess the right one (call index will be a hint). Note that existence of log files doesn't mean the crash was caused by any tracked native function. Overhead is HIGH and depends on OS and disk (on poor PC there might be just few native calls per update to disturb 60 fps.)
* __Thread safe__ - When true, ensures synchronization required for native calls from any other than Unity main thread. Overhead might be few times higher, with uncontended locks. Available only in Preloaded mode.
* __Mock all native functions__ - If true, all native functions in current assembly will be mocked.
* __Mock native calls in all types__ - If true, calls of native funcions in all methods in current assembly will be mocked. This however can cause significant preformance issues at startup in big code base.
Expand Down Expand Up @@ -131,4 +132,4 @@ class AllInOne : MonoBehaviour
- Improved interthread synchronization
- Pausing on dll/function load error, allowing to fix depencency without restarting game
- Possibly break depencency on Harmony
- Better names
- Better names

0 comments on commit 1e63802

Please sign in to comment.