# peilunnn/ue5parkoursystem architecture

> Architecture diagram of the GitHub repository peilunnn/ue5parkoursystem, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/peilunnn/ue5parkoursystem
- Repository: https://github.com/peilunnn/ue5parkoursystem

## Overview

UE5 Parkour System is an Unreal Engine character controller for climbing and vaulting. The player supplies movement, climb, jump, and hop input; the character delegates climb/hop requests to custom movement, which traces surfaces, manages climb physics and transitions, and uses motion-warped montages for traversal. Animation state is derived from the character and movement component. The README documents vaulting, ledge transitions, floor exits, and directional hopping. Blueprint assets and animation wiring are opaque in the supplied excerpts, so asset links are documented or left unverified rather than inferred.

Main entry points: [`Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp) (Custom Movement), [`Source/ClimbingSystem/ClimbingSystemCharacter.cpp`](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemCharacter.cpp) (Parkour Character), [`Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp`](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp) (Animation State), [`Content/ClimbingSystem/Animation`](https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Animation) (Traversal Animations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interaction["Player Interaction"]
  node_character["Parkour Character"]
  node_input_assets["Input Actions"]
  node_input_maps["Input Contexts"]
end

subgraph group_traversal["Traversal Runtime"]
  node_movement["Custom Movement"]
  node_traces["Surface Tracing"]
  node_climb_physics["Climb Physics"]
  node_vault["Vaulting"]
  node_ledge_hop["Ledge And Hop"]
  node_warp["Motion Warping"]
  node_debug["Debug Logging<br/>[DebugHelper.h]"]
end

subgraph group_animation["Animation Assets"]
  node_anim_instance["Animation State"]
  node_anim_assets["Traversal Animations"]
end

subgraph group_game["Game Setup"]
  node_character_bp["Character Blueprint"]
  node_game_mode["Game Mode"]
  node_default_bp["Default Pawn Blueprint"]
end

node_player(("Player"))

node_player -->|"controls"| node_character
node_input_assets -->|"binds actions"| node_character
node_input_maps -->|"adds contexts"| node_character
node_character -->|"requests traversal"| node_movement
node_movement -->|"notifies state"| node_character
node_movement -->|"queries surfaces"| node_traces
node_movement -->|"runs climb mode"| node_climb_physics
node_movement -->|"checks vault"| node_vault
node_movement -->|"checks ledges"| node_ledge_hop
node_movement -->|"sets warp targets"| node_warp
node_anim_instance -->|"reads state"| node_character
node_anim_instance -->|"reads movement"| node_movement
node_movement -.->|"plays montages"| node_anim_assets
node_character_bp -.->|"configures traversal"| node_anim_assets
node_game_mode -->|"selects pawn"| node_default_bp
node_movement -->|"logs diagnostics"| node_debug

click node_character "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemCharacter.cpp"
click node_input_assets "https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Input/Actions"
click node_input_maps "https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Input"
click node_movement "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp"
click node_traces "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp"
click node_climb_physics "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp"
click node_vault "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp"
click node_ledge_hop "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp"
click node_warp "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemCharacter.cpp"
click node_anim_instance "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp"
click node_anim_assets "https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Animation"
click node_character_bp "https://github.com/peilunnn/ue5parkoursystem/blob/main/Content/ClimbingSystem/BP_ClimbingSystemCharacter.uasset"
click node_game_mode "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemGameMode.cpp"
click node_default_bp "https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ThirdPerson/Blueprints"
click node_debug "https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/DebugHelper.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_character,node_input_assets,node_input_maps toneBlue
class node_movement,node_traces,node_climb_physics,node_vault,node_ledge_hop,node_warp,node_debug toneAmber
class node_anim_instance,node_anim_assets toneMint
class node_character_bp,node_game_mode,node_default_bp toneRose
class node_player toneIndigo
```

## Components

### Player Interaction

- [Parkour Character](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemCharacter.cpp): `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`
- [Input Actions](https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Input/Actions): `Content/ClimbingSystem/Input/Actions`
- [Input Contexts](https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Input): `Content/ClimbingSystem/Input`

### Traversal Runtime

- [Custom Movement](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp): `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`
- [Surface Tracing](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp): `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`
- [Climb Physics](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp): `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`
- [Vaulting](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp): `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`
- [Ledge And Hop](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp): `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`
- [Motion Warping](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemCharacter.cpp): `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`
- [Debug Logging](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/DebugHelper.h): `Source/ClimbingSystem/DebugHelper.h`

### Animation Assets

- [Animation State](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp): `Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp`
- [Traversal Animations](https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ClimbingSystem/Animation): `Content/ClimbingSystem/Animation`

### Game Setup

- [Character Blueprint](https://github.com/peilunnn/ue5parkoursystem/blob/main/Content/ClimbingSystem/BP_ClimbingSystemCharacter.uasset): `Content/ClimbingSystem/BP_ClimbingSystemCharacter.uasset`
- [Game Mode](https://github.com/peilunnn/ue5parkoursystem/blob/main/Source/ClimbingSystem/ClimbingSystemGameMode.cpp): `Source/ClimbingSystem/ClimbingSystemGameMode.cpp`
- [Default Pawn Blueprint](https://github.com/peilunnn/ue5parkoursystem/tree/main/Content/ThirdPerson/Blueprints): `Content/ThirdPerson/Blueprints`

### Other components

- **Player**

## Connections

- Player → Parkour Character: controls (evidence: `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`)
- Input Actions → Parkour Character: binds actions (evidence: `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`)
- Input Contexts → Parkour Character: adds contexts (evidence: `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`)
- Parkour Character → Custom Movement: requests traversal (evidence: `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`)
- Custom Movement → Parkour Character: notifies state (evidence: `Source/ClimbingSystem/ClimbingSystemCharacter.cpp`)
- Custom Movement → Surface Tracing: queries surfaces (evidence: `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`)
- Custom Movement → Climb Physics: runs climb mode (evidence: `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`)
- Custom Movement → Vaulting: checks vault (evidence: `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`)
- Custom Movement → Ledge And Hop: checks ledges (evidence: `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`)
- Custom Movement → Motion Warping: sets warp targets (evidence: `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`)
- Animation State → Parkour Character: reads state (evidence: `Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp`)
- Animation State → Custom Movement: reads movement (evidence: `Source/ClimbingSystem/Private/AnimInstance/CharacterAnimInstance.cpp`)
- Custom Movement → Traversal Animations: plays montages
- Character Blueprint → Traversal Animations: configures traversal
- Game Mode → Default Pawn Blueprint: selects pawn (evidence: `Source/ClimbingSystem/ClimbingSystemGameMode.cpp`)
- Custom Movement → Debug Logging: logs diagnostics (evidence: `Source/ClimbingSystem/Private/Components/CustomMovementComponent.cpp`)
