# Documentation

These docs cover the port itself. Guides for modding, link play, the save
editor, and developer setup live on the
[project wiki](https://github.com/bryanthaboi/gen1recomp/wiki).

## Guides

- [Rulesets](guides/rulesets.md): gen1_faithful vs modern_clean battle rules
- [Online play](guides/online-play.md): lobby, battles, tournaments, trading
- [Launch options](guides/launch-options.md): CLI flags and `gen1recomp++://` URLs
- [Portable mode](guides/portable-mode.md): keep saves and cache next to the game
- [Running from source](guides/running-from-source.md)
- [New features](new-features.md): what this port adds over the originals

## Platforms

- [Linux (AppImage / Flatpak)](platforms/linux.md)
- [iOS](platforms/ios.md)
- [Xbox Dev Mode](platforms/xbox.md)
- [Handhelds](platforms/handhelds.md)
- [Nintendo Switch](platforms/switch.md)

## Modding

- [Modding overview](modding-overview.md)

## Internals

- [Architecture](architecture.md)
- [Link security](link-security.md)