mirror of
https://github.com/AverageConsumer/kanto-gear.git
synced 2026-08-28 18:24:42 +02:00
AverageConsumer
201 lines
11 KiB
Markdown
201 lines
11 KiB
Markdown
<div align="center">
|
||
|
||
# Kanto Gear
|
||
|
||
### A second screen when you have one. A better layout when you do not.
|
||
|
||
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/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="screenshots/kanto-gear-hero-game.png" width="63%" alt="Pokémon Gold running at night on the primary AYN Thor display">
|
||
<img src="screenshots/kanto-gear-hero-local.png" width="35%" alt="Kanto Gear showing a terrain-colored local map on the secondary AYN Thor display">
|
||
</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>
|
||
|
||
## More than a second map
|
||
|
||
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.
|
||
|
||
| 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 |
|
||
|
||
| Party at a glance | Know the opponent | Find what lives here |
|
||
| --- | --- | --- |
|
||
| <img src="screenshots/kanto-gear-party.png" alt="Kanto Gear party screen with native-color Pokémon and a correctly hidden Egg"> | <img src="screenshots/kanto-gear-enemy-info.png" alt="Kanto Gear Enemy Info showing known opponent data and type matchups"> | <img src="screenshots/kanto-gear-guide.png" alt="Kanto Gear area guide showing encounters and time-of-day availability"> |
|
||
| Native-color sprites, HP, EXP, status and Eggs without revealing what will hatch. | Optional Pokédex identity and base type matchups while the original battle UI stays intact. | Encounter rates, levels, caught state and morning, day or night availability. |
|
||
|
||
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 |
|
||
| --- | --- | --- |
|
||
| **Fullscreen Swap** | 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. |
|
||
| **Separate Screens** | 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="screenshots/kanto-gear-combined-side-by-side.png" width="49%" alt="Pokémon Gold and Kanto Gear sharing one Android display side by side">
|
||
<img src="screenshots/kanto-gear-combined-overlay.png" width="49%" alt="Kanto Gear local map displayed as a resizable overlay over Pokémon Gold">
|
||
</p>
|
||
|
||
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
|
||
|
||
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. 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 **Fullscreen Swap**,
|
||
**Combined Screen** or **Separate Screens**.
|
||
|
||
You need your own supported game ROM. Kanto Gear contains no ROM, ROM-derived
|
||
game data or save file.
|
||
|
||
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).
|
||
|
||
## Games and host requirements
|
||
|
||
| 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 |
|
||
|
||
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.
|
||
|
||
<details>
|
||
<summary><strong>Migrating from the former Kanto host</strong></summary>
|
||
|
||
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.
|
||
|
||
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.
|
||
|
||
</details>
|
||
|
||
## Platform and device support
|
||
|
||
| 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. |
|
||
|
||
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.
|
||
|
||
## Controls and useful settings
|
||
|
||
| Action | Control |
|
||
| --- | --- |
|
||
| Change Kanto Gear page | Swipe left/right or tap the header arrows |
|
||
| Swap the two views | Enable **QUICK 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 settings with Modern UI | **MOD MENUS → KANTO GEAR** |
|
||
|
||
<details>
|
||
<summary><strong>Battle and information modes</strong></summary>
|
||
|
||
- **BATTLE VIEW → STANDARD** keeps the original battle HUD.
|
||
- **BATTLE VIEW → GEAR** moves duplicated battle controls to Kanto Gear.
|
||
- **BATTLE VIEW → FULL GEAR** also moves HP and status panels.
|
||
- **BATTLE VIEW → 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 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.
|
||
|
||
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.
|
||
|
||
For Kanto Gear display, touch or companion-UI problems, open an
|
||
[issue](https://github.com/AverageConsumer/kanto-gear/issues) and include:
|
||
|
||
- 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.
|
||
|
||
General startup and host problems belong to the
|
||
[Gen1Recomp issue tracker](https://github.com/bryanthaboi/gen1recomp/issues).
|
||
|
||
## 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) translation was contributed by **Desierto La Espada**.
|
||
|
||
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.
|