gen1recomp/docs/README.md

Documentation

These docs cover the port itself. Guides for modding, link play, the save editor, and developer setup live on the project wiki.

Guides

• Rulesets: gen1_faithful vs modern_clean battle rules
• Online play: lobby, battles, tournaments, trading
• Launch options: CLI flags and gen1recomp++:// URLs
• Portable mode: keep saves and cache next to the game
• Running from source
• New features: what this port adds over the originals

Platforms

• Linux (AppImage / Flatpak)
• iOS
• Xbox Dev Mode
• Handhelds
• Nintendo Switch

Modding

• Modding overview

Internals

• Architecture
• Link security