# AutoFollow / AutoUnfollow

A Foundry VTT **v14** module that lets tokens follow other tokens, and automatically breaks the follow when combat starts or a token teleports.

This is a single, self-contained replacement for two older modules that no longer work on v14:

- [Follow Me!](https://github.com/oOve/FollowMe) by **o_Ove** / Brunhine — the token-following behaviour.
- [Auto Unfollow for Follow Me!](https://github.com/sagefather/auto-unfollow-followme) by **SageFather** — the auto-unfollow-on-combat/teleport behaviour.

Both feature sets are merged here and updated for the v13/v14 API. You do **not** need Follow Me! installed; in fact it conflicts (both bind the follow key), so disable it.

## Features

- **Follow a target** — select one or more tokens, hover the leader, press **F**. Followers trail the leader at the distance they started at, along a smooth path.
- **Stop following** — select the followers and press **Shift+F**.
- **Snap to grid**, **orient to movement direction**, and **wall-collision** options.
- **Auto-unfollow on combat start** — every follower stops when combat begins.
- **Auto-unfollow on teleport** — a follower that jumps farther than a configurable distance stops following.
- **GM whisper** when a token is auto-unfollowed.

## Controls

| Action | Default key |
| --- | --- |
| Follow the hovered token | `F` |
| Stop following | `Shift` + `F` |

Both are rebindable in **Configure Controls**.

## Settings

Found under **Configure Settings → AutoFollow / AutoUnfollow** (GM, world-scoped):

| Setting | Default | What it does |
| --- | --- | --- |
| Snap to grid | Off | Snap followers to grid cells instead of preserving exact spacing. |
| Test for collisions | Off | Stop a follower that would cross a wall. |
| Orient following tokens | Off | Rotate followers to face their travel direction. |
| Stop following when manually moved | On | Classic Follow Me! behaviour — any hand-move breaks the follow. |
| Stop following when combat starts | On | All followers stop when combat begins. |
| Stop following on teleport | On | Used when "manually moved" is off; breaks the follow on a big jump. |
| Teleport distance | 60 | Distance (grid units) that counts as a teleport. |
| Notify GM on auto-unfollow | On | Whisper the GM on combat/teleport auto-unfollow. |

## Installation

Manifest URL:

```
https://raw.githubusercontent.com/sagefather/auto-follow-unfollow/main/module.json
```

## Compatibility

- Foundry VTT **v12 – v14** (verified on v14).
- Disable **Follow Me!** if it is installed — this module replaces it.

## Credits

- Token-following logic and spline math: **o_Ove** and **Brunhine** (Follow Me!).
- Auto-unfollow features and v14 port: **SageFather**.

## License

MIT