Readme updates

DayDreamMods · May 21, 2024 · dbcc5b2 · dbcc5b2
1 parent 59c6627
commit dbcc5b2
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+## MultiplayerModRestrictor
+A Last Train Outta' Wormtown plugin that facilitates other plugins restricting multiplayer access by mod versioning.
+
+Plugins wishing to implement this should depend on it in their manifest.json `www_Day_Dream-MultiplayerModRestrictor-0.3.0` and `[BepInDependency("wwwDayDream.MultiplayerModRestrictor")]` attribute.
+
+Create an internal class attribute of the name 'MMReqVersion' or 'MMReqExist' and apply it to your `BaseUnityPlugin`.
+
+* MMReqVersion: Requires versions to match in order for clients to be in the same lobby.
+* MMReqExist: Requires the mod to be present on both clients but without version checking.
diff --git a/ts-assets/TS-README.md b/ts-assets/TS-README.md
@@ -1 +1,9 @@
+## MultiplayerModRestrictor
+A Last Train Outta' Wormtown plugin that facilitates other plugins restricting multiplayer access by mod versioning.
 
+Plugins wishing to implement this should depend on it in their manifest.json `www_Day_Dream-MultiplayerModRestrictor-0.3.0` and `[BepInDependency("wwwDayDream.MultiplayerModRestrictor")]` attribute.
+
+Create an internal class attribute of the name 'MMReqVersion' or 'MMReqExist' and apply it to your `BaseUnityPlugin`.
+
+* MMReqVersion: Requires versions to match in order for clients to be in the same lobby.
+* MMReqExist: Requires the mod to be present on both clients but without version checking.
diff --git a/ts-assets/icon.png b/ts-assets/icon.png