Skip to content

Commit 35a90d7

Browse files
authored
Update README.md
Updated for the 3.0 update
1 parent 01965eb commit 35a90d7

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ Example: `[ "DependencyModID" ]`
7474
- `VersionDependencies`: Just like `Dependencies`, but you can specify a version range for the needed mods.
7575
_(optional, default to `{}`)_
7676
Type: `Dictionary<string, string>`
77-
Example: `{ "SMLHelper": "2.x", "AnotherVeryImportantMod": ">1.2.3" }`
78-
**Note: The versioning system which is used is SemVer. [Here](https://github.com/adamreeve/semver.net/blob/master/README.md) is a readme file with all of the possible version range declarations. Some weird things could occurr, so it's recommended that you test out your version ranges [here](https://semver.npmjs.com/).**
77+
Example: `{ "SMLHelper": "2.0", "AnotherVeryImportantMod": "1.2.3" }`
78+
**Note that the version you specify here will be treated as the new "minimum required version".**
79+
If the dependency mod is out of data, QModManager won't load this one.
7980

8081
- `LoadBefore`: Specify mods that will be loaded after your mod. If a mod in this list isn't found, it is simply ignored.
8182
_(optional, defaults to `[]`)_
@@ -105,7 +106,9 @@ Example: `"BestMod.dll"`
105106
- `EntryMethod`: The method which is called to load the mod. The method must be public, static, and have no parameters.
106107
_(required)_
107108
Type: `string`
108-
Example: `"BestMod.QMod.Patch"`
109+
Example: `"BestMod.QMod.Patch"`
110+
**Note: This is not longer required.**
111+
See the new [wiki](https://github.com/SubnauticaModding/QModManager/wiki) for details on how you can identify your patching method without setting it in the manifest file.
109112

110113
#### The final result would look something like this:
111114

@@ -117,8 +120,8 @@ Example: `"BestMod.QMod.Patch"`
117120
"Version": "1.0.0",
118121
"Dependencies": [ "DependencyModID" ],
119122
"VersionDependencies": {
120-
"SMLHelper": "2.x",
121-
"AnotherVeryImportantMod": ">1.2.3"
123+
"SMLHelper": "2.0",
124+
"AnotherVeryImportantMod": "1.2.3"
122125
},
123126
"LoadBefore": [ "AModID", "SomeOtherModID" ],
124127
"LoadAfter": [ "AnotherModID" ],

0 commit comments

Comments
 (0)