Skip to content

Commit 7f8a71d

Browse files
authored
Merge pull request #19 from sunnamed434/dev
Update READMEs and appsettings
2 parents daf5474 + c779203 commit 7f8a71d

3 files changed

Lines changed: 19 additions & 3 deletions

File tree

BitMono/BitMono.Host/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Imporving obfuscation process for everyone
2+
`criticals.json` - something which cannot be protected because this is a critical thing in Third-Party or somewhere else
3+
* CriticalMethods - add the methods which are critical, eg Unity Methods (Awake, Update etc) which couldn`t be renamed or protected.
4+
* CriticalInterfaces - add the interfaces which are critical, eg Third-Party interfaces which couldn`t be renamed or protected.
5+
* CriticalBaseTypes - add the base types which are critical, eg Third-Party base types which couldn`t be renamed or protected.
6+
7+
`protections.json` - depends how protections will execute, in what order
8+
* Sort protections as it should be better, to improve BitMono usage experience for others.
9+
10+
`appsettings.json` - something kinda BitMono global config

BitMono/BitMono.Host/appsettings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
// if you got error that says you don`t have needed dependency first of all atleast try to add this dependency
1414
// otherwise if this is deprecated - you can set this to false to ignore error and continue obfuscation
1515
// NB! but be aware of kind a weird errors and issues that breaking you app and it stop working after that
16-
"FailOnNoRequiredDependency": false,
16+
// Stay it true if it possible!
17+
"FailOnNoRequiredDependency": true,
1718

1819
"Logging": {
1920
"LogsFile": "logs.txt"

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,13 @@ _Executing of protections depends how they are located in `protections.json` (pr
5757

5858
Lets look at this example, first will be executed `AntiILdasm` then `AntiDe4dot` and `ControlFlow` and `BitDotNet` and `FieldsHiding`.
5959
Always you could write in `protections.json` - protections which are doesnt mentioned here or if you create protection by yourself.
60+
61+
How to **[edit](https://raw.githubusercontent.com/sunnamed434/BitMono/blob/main/BitMono/BitMono.Host/README.MD#imporving-obfuscation-process-for-everyone)**
6062
```json
6163
{
6264
"Protections": [
6365
{
64-
"Name": "BitDotNet", // Executing always after all protections because of Calling Condition
66+
"Name": "BitDotNet", // Executing always after all protections
6567
"Enabled": true,
6668
}
6769
{
@@ -77,7 +79,7 @@ Always you could write in `protections.json` - protections which are doesnt ment
7779
"Enabled": true
7880
},
7981
{
80-
"Name": "FieldsHiding", // Executing always after all protections because of Calling Condition
82+
"Name": "FieldsHiding", // Executing always after all protections
8183
"Enabled": true
8284
}
8385
]
@@ -109,6 +111,8 @@ public class ProductModel
109111
## No required dependency (Deprecated file for obfuscation)
110112
Failed to resolve dependency Assembly-CSharp-firstpass, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null
111113
<br>Use `appsettings.json` and set `FailOnNoRequiredDependency` to false, be careful with this parameter, change it in cases when file truly deprecated
114+
115+
How to [edit](https://raw.githubusercontent.com/sunnamed434/BitMono/blob/main/BitMono/BitMono.Host/README.MD#imporving-obfuscation-process-for-everyone)
112116
```json
113117
{
114118
// Adding visible things that shows you have been used BitMono to protect your app
@@ -140,6 +144,7 @@ Use `criticals.json`
140144
Add to `CriticalMethods`, `CriticalInterfaces` or `CriticalBaseTypes` your potential critical things if you have it.
141145
<br>There is already supported all `Unity` methods and third-party frameworks as `RocketMod`, `rust-oxide-umod`, `OpenMod`.
142146

147+
How to [edit](https://raw.githubusercontent.com/sunnamed434/BitMono/blob/main/BitMono/BitMono.Host/README.MD#imporving-obfuscation-process-for-everyone)
143148
```json
144149
{
145150
"CriticalMethods": [

0 commit comments

Comments
 (0)