docs: refresh project presentation

This commit is contained in:
AverageConsumer
2026-08-23 19:02:59 +02:00
parent 4492599bce
commit 02f9a0fd55
10 changed files with 136 additions and 174 deletions
+136 -174
View File
@@ -4,234 +4,196 @@
### A second screen when you have one. A better layout when you do not.
Kanto Gear adds maps, party data, battle controls and touch-friendly tools to
[Gen1Recomp](https://github.com/bryanthaboi/gen1recomp). It works on one screen,
inside a combined layout, or on a dedicated second display.
Kanto Gear is a single- and dual-screen companion UI for Pokémon Red, Blue,
Yellow, Gold and Silver in
[Gen1Recomp](https://github.com/bryanthaboi/gen1recomp). It adds live maps,
party and Pokédex data, battle controls and touch-friendly tools on Android,
Windows and Linux—without requiring a custom host or 3D renderer.
<p>
<a href="https://github.com/AverageConsumer/kanto-gear/releases/tag/v2.3.3"><img src="https://img.shields.io/badge/release-v2.3.3-5c8a3c" alt="Latest release: v2.3.3"></a>
<a href="#display-mode-reference"><img src="https://img.shields.io/badge/platform-Android%20%7C%20Windows%20%7C%20Linux-3DDC84" alt="Platforms: Android, Windows and Linux"></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/code-MIT-blue.svg" alt="Code license: MIT"></a>
<a href="https://github.com/AverageConsumer/kanto-gear/releases/latest"><img src="https://img.shields.io/github/v/release/AverageConsumer/kanto-gear?label=release&color=5c8a3c" alt="Latest Kanto Gear release"></a>
<a href="https://bryanthaboi.github.io/gen1recomp-mod-index/"><img src="https://img.shields.io/badge/official-Mod%20Index-6f42c1" alt="Available in the official Gen1Recomp Mod Index"></a>
<img src="https://img.shields.io/badge/games-Gen%201%20%2B%20Gen%202-e8b923" alt="Supports Pokémon Gen 1 and Gen 2">
<a href="#platform-and-device-support"><img src="https://img.shields.io/badge/platform-Android%20%7C%20Windows%20%7C%20Linux-3DDC84" alt="Platforms: Android, Windows and Linux"></a>
<a href="https://github.com/AverageConsumer/kanto-gear/releases"><img src="https://img.shields.io/github/downloads/AverageConsumer/kanto-gear/total?label=downloads&color=2f81f7" alt="Total Kanto Gear downloads"></a>
</p>
<p>
<img src="kanto-gear-local-map.png" width="32%" alt="Kanto Gear detailed local map with exits and item markers">
<img src="kanto-gear-party.png" width="32%" alt="Kanto Gear Pokémon party with sprites, HP and EXP">
<img src="kanto-gear-full-gear-battle.png" width="32%" alt="Kanto Gear Full Gear battle controls and status panels">
<img src="docs/images/kanto-gear-dual-screen-local-color.png" width="48%" alt="Pokémon Red and Kanto Gear showing a terrain-colored local map on an AYN Thor">
<img src="docs/images/kanto-gear-dual-screen-map-color.png" width="48%" alt="Pokémon Red with Kanto Gear's full-color Route 10 map on an AYN Thor">
</p>
<p><strong><a href="https://github.com/AverageConsumer/kanto-gear/releases/tag/v2.3.3">Download Kanto Gear</a></strong> · <strong><a href="#install">Install</a></strong> · <strong><a href="https://github.com/AverageConsumer/kanto-gear/issues">Report a problem</a></strong></p>
<p>
<strong><a href="https://bryanthaboi.github.io/gen1recomp-mod-index/">Install from the official Mod Index</a></strong>
· <strong><a href="https://github.com/AverageConsumer/kanto-gear/releases/latest">Download ZIP</a></strong>
· <strong><a href="#install">Setup</a></strong>
· <strong><a href="https://github.com/AverageConsumer/kanto-gear/issues">Report a problem</a></strong>
</p>
</div>
## Pick your setup
## More than a second map
Kanto Gear is not tied to one handheld or one screen arrangement. Choose the
layout that fits the device in front of you.
Kanto Gear follows the game and turns otherwise unused screen space into a
companion interface. Assistance is optional: **Purist** keeps the experience
close to the original games, while **Enhanced** exposes useful information the
game already knows.
| Your setup | Use this mode | What you get |
| Explore | Manage | Battle | Adapt |
| --- | --- | --- | --- |
| Region map, detailed local map, exits, visible items and hidden items | Party, Trainer Card, badges, Pokédex progress, area guide and step counter | Standard HUD, touch controls, Full Gear HUD and optional Enemy Info | Single screen, combined layouts, overlays and independent second displays |
<p align="center">
<img src="docs/images/kanto-gear-party.png" width="60%" alt="Kanto Gear party screen with native-color Pokémon sprites, HP and EXP">
</p>
Kanto Gear uses native game palettes where the host exposes them, keeps unknown
Pokémon as silhouettes and renders LOCAL terrain with consistent cartographic
colors. The interface supports classic Game Boy-inspired themes as well as
Modern Light and Modern Dark.
## One mod, three display modes
| Display mode | Best for | Behavior |
| --- | --- | --- |
| **Phone or small one-screen handheld** | **Single Screen** | Keep the game fullscreen and swap to Kanto Gear only when you need it. |
| **Steam Deck, desktop or larger one-screen device** | **Combined Screen** | Put both views side by side, stack them, or use a movable overlay. |
| **AYN Thor, RG DS or another dual-screen handheld** | **Dual Screen** | Keep the game on one display and give Kanto Gear the other. |
| **Retroid Dual Screen Add-on, monitor, dock or TV** | **Dual Screen** | Route Kanto Gear to the selected Android display or move its desktop window wherever you want. |
### A real companion display
| **Single Screen** | Phones and small one-screen handhelds | Keeps one view fullscreen and swaps between the game and Kanto Gear on demand. |
| **Combined Screen** | Steam Deck-style devices, tablets and larger displays | Places both views side by side, stacked or in a movable, resizable overlay. |
| **Dual Screen** | AYN Thor, RG DS, Retroid add-ons, desktops and multi-monitor setups | Routes Kanto Gear to a selected Android display or opens a normal movable desktop window. |
<p align="center">
<img src="kanto-gear-dual-screen-game.png" width="57%" alt="Pokémon Red running on the primary AYN Thor display">
<img src="kanto-gear-dual-screen-companion.png" width="38%" alt="Kanto Gear map running on the secondary AYN Thor display">
<img src="docs/images/kanto-gear-combined-side-by-side.png" width="49%" alt="Pokémon Red and Kanto Gear sharing one Android display in Combined Screen mode">
<img src="docs/images/kanto-gear-desktop-dual-window.png" width="49%" alt="Pokémon Red and the Kanto Gear companion window running separately on Windows 11">
</p>
The two images above are direct captures from the primary and secondary
displays of an AYN Thor running the official Gen1Recomp host. On Android, Kanto
Gear can follow a selected physical display and recover live if that display is
disconnected.
### A normal companion window on desktop
<p align="center">
<img src="kanto-gear-desktop-dual-window.png" width="100%" alt="Pokémon Red and Kanto Gear running in separate movable windows on Windows 11">
</p>
On desktop, Dual Screen mode opens Kanto Gear as a normal companion window.
Keep it beside the game, move it to another monitor or size both windows around
the rest of your desktop. Windows 11 is tested; Linux packages use the same
desktop-window path and welcome real-device reports.
### One screen still gets both views
<p align="center">
<img src="kanto-gear-combined-side-by-side.png" width="100%" alt="Pokémon Red and the Kanto Gear local map sharing one Android display in Combined Screen mode">
</p>
Single Screen mode gives the entire display to one view and swaps on demand.
Combined Screen mode keeps both visible with side-by-side, stacked and overlay
layouts. The game viewport and Android touch controls adapt with the layout,
and the companion size can be tuned without stretching its UI.
## What Kanto Gear adds
Kanto Gear gives Pokémon Red, Blue, Yellow, Gold and Silver a configurable
companion display without changing the game underneath it.
- Explore with a live region map, detailed local maps, exits and item markers.
- Check your party, Trainer Card, badges, Pokédex progress, steps and area data.
- Use contextual touch controls for battles, bags, dialogue, PC boxes and moves.
- Move battle controls—or the complete battle HUD—to the second screen.
- Swap views, hide an overlay or move the companion between displays.
- Choose classic Game Boy-inspired or modern light and dark themes.
Display changes and disconnects are handled live, so the game remains reachable
when a second display disappears.
## What you need
Kanto Gear 2.3 works with the official Gen1Recomp 0.1.99 release or newer. No
custom host or Voxel renderer is required for new installations.
Pokémon Silver requires Gen1Recomp 0.2.10 or newer.
| Download | Required | Purpose |
| --- | :---: | --- |
| [Gen1Recomp 0.1.99 or newer](https://github.com/bryanthaboi/gen1recomp/releases/latest) | **Yes** | Official host and platform packages |
| [Kanto Gear 2.3.3](https://github.com/AverageConsumer/kanto-gear/releases/tag/v2.3.3) | **Yes** | Companion UI and display modes |
| [Kanto Gear Deutsch 0.2.5](https://github.com/AverageConsumer/kanto-gear/releases/tag/v2.3.3) | No | German text for the Kanto Gear interface |
| [Kanto Gear Español (España) 0.2.5](https://github.com/AverageConsumer/kanto-gear/releases/tag/v2.3.3) | No | Spanish (Spain) text for the Kanto Gear interface |
> [!IMPORTANT]
> Gen1Recomp 0.1.99 is the first official release containing Kanto Gear's full
> display and mod API requirements. The exact legacy Android host
> `0.1.94-kanto.22` remains accepted only as a save-migration bridge.
The game viewport and Android touch controls adapt when a combined layout makes
the main view smaller. Display changes and disconnects are handled live so the
game remains reachable when a second display disappears.
## Install
You need your own supported Pokémon Red, Blue, Yellow, Gold or Silver ROM. No
ROM or ROM-extracted game data is included.
Kanto Gear works with the **official Gen1Recomp host**. New installations do
not need the former Kanto host or any Voxel renderer.
1. Install the [latest official Gen1Recomp release](https://github.com/bryanthaboi/gen1recomp/releases/latest)
for your platform.
2. Download [Kanto Gear 2.3.3](https://github.com/AverageConsumer/kanto-gear/releases/tag/v2.3.3).
3. Open the host's **MODS → Import mod .zip** screen and select the Kanto Gear
ZIP.
4. Enable **Kanto Gear** and start the game. Choose a display mode in Kanto
Gear's settings.
2. Open Gen1Recomp's **MODS** screen and install **Kanto Gear** from the official
Mod Index, or import `kanto_gear-*.zip` from the
[latest Kanto Gear release](https://github.com/AverageConsumer/kanto-gear/releases/latest).
3. Enable Kanto Gear and start Pokémon Red, Blue, Yellow, Gold or Silver.
4. Open Kanto Gear's settings and choose **Single Screen**, **Combined Screen**
or **Dual Screen**.
For a German or Spanish Kanto Gear interface, import the matching optional
`kanto_gear_de-0.2.5.zip` or `kanto_gear_es-0.2.5.zip` from the same release.
Other translations can use the small
[language-pack template](translations/README.md).
You need your own supported game ROM. Kanto Gear contains no ROM, ROM-derived
game data or save file.
Use Gen1Recomp's normal update path for later official releases. Keep an
exported save backup before changing hosts or operating systems.
Optional German and Spanish (Spain) interface packs are attached to every
release. Import one only if you want that language. Other translations can use
the small [language-pack template](translations/README.md).
> [!WARNING]
> The former **Gen1Recomp Kanto host** and the official Android app use separate
> app identities, so the official app installs beside it and cannot see its
> private saves or installed mods. Export your save from the old host first,
> then import the ROM, save and Kanto Gear into the official app. Do not remove
> the old host until the migrated save has been verified.
>
> Gen1Recomp cannot export Pokémon Gold or Silver cartridge `.sav` files yet.
> Gen 2 players should keep the legacy host installed and continue there until
> an upstream Gen 2 transfer path is available. Kanto Gear 2.1 remains compatible
> with the final legacy host for this reason; the host itself is frozen and
> will receive no further feature releases.
## Games and host requirements
### Voxel renderers
| Game | Kanto Gear support | Minimum official host |
| --- | --- | --- |
| Pokémon Red, Blue and Yellow | Full Gen 1 companion UI | Gen1Recomp 0.1.99 |
| Pokémon Gold | Full Gen 2 companion UI | Gen1Recomp 0.1.99 |
| Pokémon Silver | Full Gen 2 companion UI | Gen1Recomp 0.2.10 |
Kanto Gear does not require or bundle a Voxel renderer. Our former
[Dramatic Shape Android fork](https://github.com/AverageConsumer/DramaticShapeVoxelMod)
is frozen at `1.7.0-android.1` and no longer maintained. Its release remains
available for existing users, but it will not receive upstream, compatibility,
feature or support updates and is not part of the current matched release set.
The legacy Android host `0.1.94-kanto.22` remains accepted only as a temporary
save-migration bridge. Current users should use the official host.
Other renderer forks may work, but compatibility belongs to their current
maintainers. Do not install multiple Dramatic Shape variants together because
they intentionally share the same mod ID.
<details>
<summary><strong>Migrating from the former Kanto host</strong></summary>
## Display mode reference
The legacy and official Android hosts use separate app identities. The official
app therefore installs beside the old host and cannot automatically see its
private saves or installed mods.
- **Single Screen** keeps one view fullscreen and lets you swap to the other.
- **Combined Screen** places both views in one window: side by side, stacked or
as a movable overlay with adjustable size.
- **Dual Screen** uses Android's selected display or opens a separate desktop
companion window that can be moved like any other window.
Export your save from the old host, then import the ROM, save and Kanto Gear
into the official app. Do not remove the old host until the migrated save has
been verified. Gen1Recomp cannot currently export Pokémon Gold or Silver
cartridge `.sav` files, so Gen 2 players should keep the legacy host installed
until an upstream transfer path is available.
The game viewport and Android touch controls remain usable when a combined
layout makes the game view smaller.
</details>
## Tested devices
## Platform and device support
### Supported devices
| Platform or device | Status |
| --- | --- |
| **AYN Thor** | Primary development and test device; dual screen, touch and live display changes tested. |
| **Retroid Pocket 5 + Dual Screen Add-on** | Community tested with automatic external-display routing. |
| **Anbernic RG DS + GammaOS Nano 1.4 (Android 14)** | Community confirmed; avoid stacking multiple performance-heavy mods on this lower-power hardware. |
| **Anbernic RG DS + Rocknix** | Dual-screen and touch routing community confirmed with the diagnostic PortMaster build; current-package confirmation is still welcome. |
| **Windows 11** | Combined layouts and a separate movable companion window tested. |
| **Linux x86_64 and ARM64** | Packages use the same desktop-window path; real-device reports remain welcome. |
| **Steam Deck-style one-screen devices** | Single Screen and Combined Screen layouts are designed for this use case. |
| **External Android displays, docks and TVs** | Supported through selectable display routing. |
- **AYN Thor** — primary development and test device
- **Retroid Pocket 5 + Retroid Dual Screen Add-on** — community tested
- **Anbernic RG DS** — community confirmed specifically with GammaOS Nano 1.4
(Android 14). Avoid other performance-heavy mods on its lower-power hardware.
- **Anbernic RG DS with Rocknix** — the dual-screen and touch route was
community confirmed with the earlier diagnostic PortMaster build; the final
2.0 package remains experimental until it receives a fresh confirmation.
- **Windows 11** — combined layouts and a separate companion window tested
- **Linux x86_64 and ARM64** — packages embed the exact Android/Windows-tested
payload and pass structural verification; real-device reports are welcome
- **External Android displays, docks and TVs** — supported through selectable
display routing; hardware reports are welcome
macOS can run the universal `.love` package through the same desktop display
path, but Kanto Gear does not currently ship or claim a tested signed macOS app
bundle.
macOS uses the same desktop display path through the universal `.love` package,
but it is not presented as a tested or signed native app bundle.
## Quick controls
## Controls and useful settings
| Action | Control |
| --- | --- |
| Change Kanto Gear page | Swipe left/right or tap the header arrows |
| Swap the two displays | Enable **SCREEN SWAP (Y)**, then press **Y** |
| Cycle pages with a controller | Enable **TRIGGER TABS**, then use L2/R2 |
| Swap the two views | Enable **SCREEN SWAP (Y)**, then press **Y** |
| Cycle pages with a controller | Enable **TRIGGER TABS**, then use **L2/R2** |
| Hide or show the Combined Screen overlay | Press **R3** |
| Zoom the local map | Tap **+ / −** |
| Open Kanto Gear settings with Modern UI | **MOD MENUS → KANTO GEAR** |
| Open settings with Modern UI | **MOD MENUS → KANTO GEAR** |
Useful settings:
<details>
<summary><strong>Battle and information modes</strong></summary>
- **DISPLAY MODE → DUAL SCREEN** is recommended on dual-screen handhelds.
- **DISPLAY MODE → COMBINED SCREEN** is recommended on one-screen devices.
- **SCREEN SWAP (Y)** is off by default so other mods can use **Y**.
- **BATTLE VIEW → STANDARD** keeps the original battle HUD.
- **BATTLE VIEW → GEAR** moves duplicated battle controls.
- **BATTLE VIEW → GEAR** moves duplicated battle controls to Kanto Gear.
- **BATTLE VIEW → FULL GEAR** also moves HP and status panels.
- **BATTLE VIEW → ENEMY INFO** keeps the original HUD and shows known opponent
data on the companion screen.
- **INFO → PURIST** hides assistance; **ENHANCED** enables it.
- **SCREEN SWAP (Y)** is off by default so other mods can keep using **Y**.
</details>
## Compatibility and support
Kanto Gear 2.3 requires the official Gen1Recomp 0.1.99 release or newer. The
exact legacy host `0.1.94-kanto.22` remains supported temporarily for Android
save migration only. Keep an exported save backup while testing experimental
display layouts or platform packages.
Kanto Gear validates the data contract of game screens before mirroring or
taking them over. If another UI mod replaces a menu with an incompatible model,
Kanto Gear falls back instead of drawing mismatched controls or crashing. These
checks are generic; the project does not maintain per-mod compatibility hacks.
Open a [Kanto Gear issue](https://github.com/AverageConsumer/kanto-gear/issues)
for second-display, touch or companion-UI problems. Include your device,
operating system, display setup, installed versions and a screenshot if useful.
Kanto Gear does not require or bundle a Voxel renderer. The former
[Dramatic Shape Android fork](https://github.com/AverageConsumer/DramaticShapeVoxelMod)
is frozen at `1.7.0-android.1` and unsupported. Other renderer forks may work,
but compatibility exclusive to those projects belongs to their current
maintainers. Do not install multiple Dramatic Shape variants together because
they intentionally share a mod ID.
Include the official host version in Kanto Gear reports. General host startup
problems belong to the [Gen1Recomp issue tracker](https://github.com/bryanthaboi/gen1recomp/issues).
Problems exclusive to a third-party 3D renderer belong to its current
maintainer. Our legacy Dramatic Shape Android fork is retained only as an
unsupported historical download.
For Kanto Gear display, touch or companion-UI problems, open an
[issue](https://github.com/AverageConsumer/kanto-gear/issues) and include:
## Credits
- device and operating system;
- official host and Kanto Gear versions;
- display mode and physical display setup;
- installed mods and versions;
- a screenshot showing both views, when useful.
Kanto Gear is built on [Gen1Recomp](https://github.com/bryanthaboi/gen1recomp).
The former Android renderer fork was based on
[Dramatic Shape Voxel Mod](https://github.com/DramaticShape/DramaticShapeVoxelMod).
General startup and host problems belong to the
[Gen1Recomp issue tracker](https://github.com/bryanthaboi/gen1recomp/issues).
Special thanks to [@Rocky5150](https://github.com/Rocky5150) for more than 24
hours of Retroid Pocket 5 testing and diagnostics, and to
## Credits and license
Kanto Gear is built on [Gen1Recomp](https://github.com/bryanthaboi/gen1recomp)
and released under the [MIT License](LICENSE).
Special thanks to [@Rocky5150](https://github.com/Rocky5150) for extensive
Retroid Pocket 5 testing and diagnostics, and to
[CustCast](https://github.com/CustCast/PokeRogue-App-Android-Thor) for sharing
the artwork that inspired the optional Modern Light and Modern Dark themes.
The Spanish (Spain) Kanto Gear translation was contributed by
**Desierto La Espada**.
The Spanish (Spain) translation was contributed by **Desierto La Espada**.
Kanto Gear's code is available under the [MIT License](LICENSE). Pokémon and
related names are trademarks of their respective owners. This project is not
affiliated with Nintendo, Game Freak, The Pokémon Company, Gen1Recomp or
Dramatic Shape.
Pokémon and related names are trademarks of their respective owners. This is a
fan project and is not affiliated with Nintendo, Game Freak, The Pokémon
Company, Gen1Recomp or Dramatic Shape.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Before

Width:  |  Height:  |  Size: 248 KiB

After

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Before

Width:  |  Height:  |  Size: 224 KiB

After

Width:  |  Height:  |  Size: 224 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 261 KiB