From 4b83846c399174667aa27306e19943d956032f74 Mon Sep 17 00:00:00 2001 From: NotAKidoS <37721153+NotAKidOnSteam@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:48:09 -0500 Subject: [PATCH] [OriginShift] Update README --- OriginShift/README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/OriginShift/README.md b/OriginShift/README.md index 531e3d2..35bb285 100644 --- a/OriginShift/README.md +++ b/OriginShift/README.md @@ -20,10 +20,25 @@ Experimental mod that allows world origin to be shifted to prevent floating poin - This is because the voice server dictates who can hear who based on distance from each other and the world origin shift messes with that. - Teleports past 50k units will not work. - BetterBetterCharacterController prevents teleports past 50k units. +- Magica Cloth. ## Mod Incompatibilities - PlayerRagdollMod will freak out when you ragdoll between chunk boundaries. - - Partial conflict with RelativeSyncs experimental Spawnable Sync Fix. + +## Provided Components +- `OriginShiftController` - World script to configure origin shift. +- `OriginShiftEventReceiver` - Event receiver for OriginShift events. +- `OriginShiftTransformReceiver` - Shifts the transform of the GameObject it is attached to. +- `OriginShiftRigidbodyReceiver` - Shifts the rigidbody of the GameObject it is attached to. +- `OriginShiftTrailRendererReceiver` - Shifts the positions of the Trail Renderer of the GameObject it is attached to. +- `OriginShiftParticleSystemReceiver` - Shifts the positions of the Particle System of the GameObject it is attached to. + +The provided receiver components are automatically added to Props, Players, and Object Syncs. + +## Provided Shader Globals +- `_OriginShiftChunkOffset` - The current amount of chunks offset from the origin. +- `_OriginShiftChunkThreshold` - The size of a chunk in world units. +- `_OriginShiftChunkPosition` - The chunk offset multiplied by the chunk threshold. ---