From 06c07ea4d9f20b386457d5f2a2f4e4d6e684707e Mon Sep 17 00:00:00 2001 From: zombieb Date: Sat, 9 Aug 2025 05:07:38 -0400 Subject: [PATCH] fix readme --- README.md | 82 ++++++++++++++++++++++--------------------------------- 1 file changed, 33 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 33b5876..0f669e5 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ If you're unsure how to start your build on linux: * Use protontricks to add the doorstop DLL * Start Rec Room through Steam -### AGRoomRuntimeConfig Patches -Properties of the object in the patch file will be used to set the properties of the respective object type in the game's assembly. +### (AssetChanges) and (GameManager Patches) +Properties of the object in the patch file will be used to set the properties of the respective object in the game's assembly. Each object type can be configured as follows: * `AGRoomRuntimeConfig.Room` or `AGRoomRuntimeConfig.RoomScene` or `AGRoomRuntimeConfig.Location` @@ -57,54 +57,38 @@ Each object type can be configured as follows: ]} ``` will prevent you from loading into the dorm, because you can't go to editor-only rooms. - - Although you can set rooms with ReleaseStatus:0 to 2 if you'd like to go to those rooms. + You can set rooms with ReleaseStatus:0 to 2 if you'd like to go to those rooms. + This isn't very useful for most people. You *should* set this when using `TeamConfiguration` below. * `GameConfigurationAsset` - - Set the key to the name of the object you want to change + - List of changes to the game configurations + - See the example for syntax * Ex. "Crescendo Of The Blood Moon" (CrescendoOfTheBloodMoon_Config, 20200306) - - Value must match a certain schema (example): - ```json - { - "Name": "Crescendo Of The Blood Moon", - "TeamConfigurations": [ - { - "MaxTeamSize": 1 - }, - { - "MaxTeamSize": 2 - }, - { - "MaxTeamSize": 3 - } - ], - "TeamSelectionMethod": 0, - "ManualGameStartRequirement": { - "MinPlayerCount": 1, - "MinTeamCount": 1, - "MinTeamSize": 1 - }, - "AutomaticGameStartSupported": false, - "AutomaticGameStartRequirement": { - "MinPlayerCount": -1, - "MinTeamCount": -1, - "MinTeamSize": -1 - }, - "GameStartDelay": 10.0, - "EndGameResultsDuration": 15.0 - } - ``` - * You must set every property. - * Only `MaxTeamSize` is supported for every team in `TeamConfigurations`. - * See `TeamSelectionMethod` enum members for more information. - * Changes to arrays (lists) are made in order. To change the value of a team size in the middle of an array, you must duplicate the previous data. - Example: ```json - { "Crescendo Of The Blood Moon": { - "AutomaticGameStartSupported": true, - "TeamConfigurations": [ - { - "MaxTeamSize": 18 - } - ] - } } - ``` \ No newline at end of file + [ + { + "GameName": "Crescendo Of The Blood Moon", + "TeamConfigurations": [ + {"Size":6}, + {"Size":6} + ] + }, + { + "GameName": "Paintball Capture The Flag", + "TeamConfigurations": [ + {"Size":1}, + {"Size":1}, + {"Size":1}, + ] + } + ] + ``` + * Some games have issues with spawning players from other teams into regular spawnpoints. Use `GameFreeSpawns` to remedy this. +* GameFreeSpawns + - Sets every current playing spawnpoint to be available to any team + - Allows more than 4 players to spawn in correctly in quests like Crescendo + - List the game names (strings) to enable the patch for + - Example: + ```json + ["Crescendo Of The Blood Moon", "Paintball Capture The Flag"] + ``` \ No newline at end of file