Installing APIAPI's Replicated Rope & Physics-Carry Kit
Supported engines and platforms, installing the kit, and what each module contains.
Supported engines and platforms
- Unreal Engine 5.6, 5.7 and 5.8.
- Platforms: Windows (Win64) for the editor, clients and servers; Linux for clients and dedicated servers (the kit is compiled for Linux clients and servers; our tests run the editor and its sessions on Windows). Every module of the kit is limited to these two platforms.
- Network modes: standalone, listen server and dedicated server.
Install and enable
- Install the kit to your engine from Fab (the Epic Games Launcher's Fab Library › Install to Engine).
- Open your project, then Edit › Plugins, search for Replicated Rope, tick Enabled on APIAPI's Replicated Rope & Physics-Carry Kit.
- Restart the editor when it asks.
Keep one copy of the kit: either the engine's copy from Fab or a copy in your project's Plugins/ folder, never both. Two copies of one plugin make the editor load one of them unpredictably.
The kit enables the engine plugin Online Subsystem Utils with itself; it depends on no other plugin, including APIAPI's other kits.
You can install this kit and APIAPI's Interaction Kit in the same project: checked against Interaction Kit version 1.0.1, the two kits share no type, header, namespace or log-category name, and both build and load side by side. Each release of this kit is checked again against the newest release of that kit.
What is in the kit
| Module | Type | What it contains |
|---|---|---|
UKRope | Runtime | Ropes, presets, ziplines, the interactor (requests), carrying, the movement bridge and the default bridge, Project Settings. Server and client. |
UKRopeCMCAdapter | Runtime | The Character Movement adapter: AUKRopeCharacter, UUKRopeCharacterMovement, the rope hook for your own movement components. |
UKRopeClient | ClientOnly | The rope visual (UUKRopeVisualSubsystem, UUKRopeSplineVisualComponent) and the network debug overlay (UUKRopeOverlaySubsystem, compiled out of Shipping). Loaded on clients, listen hosts and standalone games; never on a dedicated server. See api.md. |
UKRopeTests | UncookedOnly | The kit's automation suite (see testing.md). Never compiled into a cooked game, client or server. |
Packaging and dedicated servers
The kit never needs a client-only class on a dedicated server: its runtime modules load on servers and clients alike, and the test module is never cooked.
Next steps
- quick-start.md - a networked carry (and, once the demo content ships, a networked rope) in your own level.
- api.md - every feature, event and setting.
- network-model.md - what the server decides, what clients show, and the known limits.
- testing.md - run the kit's own suite in your project.