ParkourMod

# Parkour Mod

Adds parkour-style traversal to Minecraft: wall grab, wall kick, ledge hang, and swing jump. A single dedicated action key context-sensitively handles wall grabbing, ledge hanging, and mantling depending on the situation.

## Features

- **Wall grab**: Hold the action key while airborne near a wall to grab on. Use W/S to climb up/down and A/D to shimmy sideways.
- **Wall kick**: Jump while wall-grabbing to kick off away from the wall with real momentum. Kicking off one wall doesn't block immediately grabbing a different one, so you can zig-zag up a narrow shaft.
- **Ledge hang**: Jump towards an overhead ledge (a wall with open space above it) to grab and hang from it. Detection reaches up to a block above your head, so you can grab a ledge one block above where you jumped from.
- **Swing jump**: While hanging, alternate forward/back input to actually swing your body like a pendulum. The swing's angular velocity (centrifugal force) at the moment you jump determines your launch speed and direction — let go at the right moment for a big, momentum-driven leap. Not enough swing built up? Jumping instead does a plain mantle (climb-up) onto the ledge.
- Grabbing and launching play sound cues, and an arm-reaching hang pose (via Player Animator) while attached.

## Controls

| Key | Action |
|---|---|
| Parkour action key (default: `R`) | Grab/hold a wall or ledge |
| Jump | Wall kick / mantle / swing jump |
| W / S | Climb a wall up/down; pump the swing while hanging |
| A / D | Shimmy sideways along a wall or ledge |
| Sneak | Let go |

The keybind can be changed in Controls under the "Parkour Mod" category.

## Configuration

`config/parkourmod-common.toml` exposes grab range, wall kick strength, swing gravity/damping, launch multiplier, and more, so you can tune the feel to your liking.

## Required dependency

- [Player Animator](https://www.curseforge.com/minecraft/mc-mods/playeranimator) (needed for the hang pose animation)

## Supported versions

- Minecraft 1.20.1 / Minecraft Forge 47.4.10+

## Known limitations

- In multiplayer, only your own movement is applied instantly client-side; the server re-runs the same physics to stay in sync.
- This is an early build — the exact hang position/pose is still being tuned.