Raphtalia/DungeonGenerationPlus_LethalCompany_Mod
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update DunGenExtender

Raphtalia 2025-01-21 21:32:42 +00:00
parent 0b4f452eab
commit 356b6f6a57
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
DunGenExtender.md

@ -16,7 +16,7 @@ If the generation fails to fully create any of the main paths for any reason, it
`MainRoomTilePrefab` can be used in conjunction with the `MainRoomDoorwayGroups` component for more control in which doorways that the alternate main paths choose. See [here](https://git.touhou.dev/Raphtalia/DungeonGenerationPlus_LethalCompany_Mod/wiki/Components#user-content-main-room-doorway-groups) for details.
> **NOTE:** Adding an additional main path is effectively adding an entirely separate dungeon to your interior. This is due to the fact that it not only adds a set amount of main tiles, but also branching paths with their tiles. It is highly recommended to decrease the length of the dungeon as you increase `MainPathCount`.
> **NOTE** Adding an additional main path is effectively adding an entirely separate dungeon to your interior. This is due to the fact that it not only adds a set amount of main tiles, but also branching paths with their tiles. It is highly recommended to decrease the length of the dungeon as you increase `MainPathCount`.
The `DungeonFlow's` node list is replicated onto the alternate main paths. The starting index is based on the `MainPathCopyNodeBehaviour` selected. Any nodes before the starting index will be ignored and not be generated. Injection tiles will not duplicated.
@ -45,7 +45,9 @@ You can override the following values of `DungeonFlow`:
- Nodes
- Lines
> **:warning: WARNING: :warning:** If you are using the `CopyFromNodeList` behaviour and you are overriding the nodes list, then that list **MUST** still contain some node whose tileset contains `MainRoomTilePrefab`.
> :warning: **WARNING** :warning:
>
> If you are using the `CopyFromNodeList` behaviour and you are overriding the nodes list, then that list **MUST** still contain some node whose tileset contains `MainRoomTilePrefab`.
#### Local Global Prop Settings
@ -53,16 +55,22 @@ You can override the following values of `DungeonFlow`:
* The `DungeonFlow` global limit
* The `LocalGlobalProp` local limit if it exists.
If the global limit wasn't reached, any remaining,non-spawned Global Props will used to spawn the remaining props to reach the global limit. The Global Props considered are from main paths without a specified `LocalGlobalProp` local limit **OR** its `UseToReachGlobalPropLimit` boolean is toggled,
If the global limit wasn't reached, any remaining, non-spawned Global Props will used to spawn the remaining props to reach the global limit. The Global Props considered are from main paths without a specified `LocalGlobalProp` local limit **OR** its `UseToReachGlobalPropLimit` boolean is toggled,
`ID` specifies the corresponding `ID` on `DungeonFlow's` global props list. `Count` represents the range of Global Props that can only spawn inside that main path. `UseToReachGlobalPropLimit` specifies if that remaining, not spawned Global Props can be used to reach `DungeonFlow' global limit.
### Detailed Global Prop Settings
A list of additional modifications for how Global Props spawn. `ID` specifies the corresponding `ID` on `DungeonFlow's` global props list.
`MinimumDistance` specifics the minimum distance that each Global Prop must spawn from each other.
## Archetypes on Normal Nodes
Enable this feature by toggling `AddArchetypesToNormalNodes`. This allows normal nodes in `DungeonFlow` to create branching paths by attaching an archetype to it.
Each element of the `NormalNodeArchetypes` list represents which node receives an archetype. The `Label` describes which normal node of the same `Label` will receive one of the archetypes in the `Archetypes` list. If the `Label` is empty or white-spaced, then it becomes the default target for any normal node who did not have a corresponding `Label` in the `NormalNodeArchetypes` list. If a normal node does not have any corresponding target, then it's spawned tile will not create branching paths like normal.
> **NOTE:** Start and End nodes cannot receive archetypes.
> **NOTE** Start and End nodes cannot receive archetypes.
<br/><br/>
# Nice to Have Features
@ -70,7 +78,7 @@ Each element of the `NormalNodeArchetypes` list represents which node receives a
## Dungeon Bounds
Enable this feature by toggling `UseDungeonBounds`. This adds a bounds to your interior where the dungeon generation cannot place tiles outside of. This can help preventing the dungeon from creating paths all the way to Narnia.
> **NOTE:** This feature also increases the chance of the dungeon generation failing, and therefore increasing dungeon generation times. This can even make dungeon generation impossible if the bounds is too small or mispositioned.
> **NOTE** This feature also increases the chance of the dungeon generation failing, and therefore increasing dungeon generation times. This can even make dungeon generation impossible if the bounds is too small or mispositioned.
`DungeonSizeBase` is the base size of the bounds. This influences how `DungeonSizeFactor` work. Otherwise it's self-explanatory.
@ -94,7 +102,7 @@ Enable this feature by toggling `UseAdditionalTiles`. This attempts to generate
The dungeon generation will attempt to generate the tile on every main and branch tile (excluding tiles generated from the Additional Tiles feature). This feature does not guarantee that that tile will generate. If the tile cannot generate for whatever reason, it will simply proceed as normal.
> **NOTE**: This feature may be replicated with injection rules however they are a few key differences.
> **NOTE** This feature is somewhere similar to injection rules however they are a few key differences.
>
> Injection rules replace main or branch tiles with one of its own tiles when the main and branch paths are being generated. Additional Tiles adds extra tiles after the main and branch paths are generated.
>
@ -135,12 +143,12 @@ These weight scales prioritize branch paths that connect back to other main path
`DiffPathNormalizedDepthWeightScale` is the weight scale for the branch path's number of connections to other main paths. For each possible connection, the main path normalized depth difference is multiplied by the scale and is added to the branch path's weight. Increasing this value will prioritize branch paths who make generally deep path loops to other main paths.
> **NOTE**: This feature can encourages the dungeon generation to generate circular/looping paths. However if your interior does not create looping paths naturally by sheer chance, this feature will have very little to no effect.
> **NOTE** This feature can encourages the dungeon generation to generate circular/looping paths. However if your interior does not create looping paths naturally by sheer chance, this feature will have very little to no effect.
## Max Shadows Request
Enable this feature by toggling `UseMaxShadowsRequestUpdate`. This prevents the `Max shadow requests count reached` warning spam that can appear if the interior has too many lights in close proximity. `MaxShadowsRequestAmount` will become the new amount of shadow requests.
> **NOTE**: By default, Lethal Company uses 4 shadow requests. I find from my experience that 8-16 shadow requests is more than enough to stop the warning spam.
> **NOTE** By default, Lethal Company uses 4 shadow requests. I find from my experience that 8-16 shadow requests is more than enough to stop the warning spam.
<br/><br/>
# Niche Features
@ -152,7 +160,7 @@ When the dungeon is generating, two tiles may generate right next to each other
This features adds the slightest bit of slowdown to the dungeon generation times, whether or not the `DoorwaySisters` component is used. As such, if you don't plan to use this feature, it is advised to disable this feature.
> **NOTE**: This feature is probably not necessary for your interior. My interior was designed to pack my tiles very closely and for their doorways to have a high chance of intersecting. As such, my interior developed the issue of having too many unnecessary doorways and required this feature to fix it. Most interiors won't have this same issue.
> **NOTE** This feature is probably not necessary for your interior. My interior was designed to pack my tiles very closely and for their doorways to have a high chance of intersecting. As such, my interior developed the issue of having too many unnecessary doorways and required this feature to fix it. Most interiors won't have this same issue.
## Line Randomizer
Enable this feature by toggling `UseLineRandomizer`. This helps dungeons with the combination of a large amount of tiles and/or large amount of doorways for each tile to generate a bit faster while maintaining some of the dungeon generation randomness.
@ -163,6 +171,6 @@ This feature modifies the list of archetypes in `LineRandomizerArchetypes` to re
`LineRandomizerArchetypes` is the archetypes whose list of tilesets will be modified. Ideally these archetypes will be used in the lines section of `DungeonFlow`. The last `LineRandomizerTakeCount` amount of elements of both the archetype's `TileSets` and `BranchCapTileSets` list will be exchanged by a random set of tilesets from `LineRandomizerTileSets`. As such, the length of those lists must be equal or greater than the value of `LineRandomizerTakeCount`. This goes without saying but be prepared the archetypes' elements to be swapped around all willynilly-ing.
> **NOTE**: This feature is probably not necessary for your interior. My interior was reaching up to 2000 potential doorway pairs for each tile injection and needed a way to reduce it. And even with this fix, the doorway pairs bubble sort rewrite was probably the bigger performance boost anyway. Still, I needed a way to future-proof my dungeon generation times and such this feature still exists.
> **NOTE** This feature is probably not necessary for your interior. My interior was reaching up to 2000 potential doorway pairs for each tile injection and needed a way to reduce it. And even with this fix, the doorway pairs bubble sort rewrite was probably the bigger performance boost anyway. Still, I needed a way to future-proof my dungeon generation times and such this feature still exists.