Skip to content
martin2844Public

About

Unofficial community Android port of Megabonk

Resources

Stars

49 stars

Watchers

0 watching

Forks

Latest commit

 

History

782 Commits

Folders and files

Repository files navigation

OpenBonk

Release Status: beta Android 8.0+ Content mods: experimental Lua mods: experimental Buy Me a Coffee

Play Megabonk on Android with a native launcher, controller or touch input, a PC-style 16:9 render mode and a mod catalog with maps, bosses, characters and Lua weapons.

OpenBonk is an unofficial community project in beta. Bring your own compatible Steam copy of Megabonk: the launcher prepares its data on your Android device.

Download the beta · Installation guides · Install with an AI agent · Mods · Display and performance · Build from source · Report a problem · Support

Support the project

If you enjoy OpenBonk and would like to support its development, you can buy Martin a coffee.

Launcher

OpenBonk's Game tab showing verified game files, profile import and export, and the installed version

Controls Mod catalog
The Controls tab with touch and controller options The paginated mod catalog in the OpenBonk launcher

Game resolution, scale and PC-style 16:9 aspect settings

The launcher handles the whole device-side flow: it verifies and migrates the prepared game data, keeps a save profile you can export and restore, applies the display and performance settings before the game starts, and manages mods from a curated catalog.

What's in the beta

  • Native Android launcher in English and Spanish, with game-data import and migration, profile export/import, update checks and mod management.
  • Touch or controller: on-screen sticks and buttons with a layout editor (visibility, opacity, snapping and saved profiles) or a gamepad.
  • Render resolution and PC aspect: choose a scale or a fixed height, plus a 16:9 (PC) mode that keeps the desktop framing on tall 20:9 phones.
  • Mod catalog: installed first, one-tap Update when a newer version exists, and content mods are enabled automatically after installing or updating.
  • Content mods (API 4): procedural maps with streetscapes, stage environments, custom enemies and bosses, rewards and level-4 attack options such as elemental volleys.
  • Lua mods (API 1–3): stat hooks, items, characters and weapons, including the charged Thunderbolt in the Pikachu mod.
  • Built-in QA probes: intent-gated checks that drive real runs and verify encounters, bosses, rewards, saves, mods and rendering on an emulator.

Start playing

  1. Download OpenBonk.apk from the newest beta release.
  2. Create a ZIP containing the Megabonk_Data folder from your own compatible Steam installation. The ZIP must be no larger than 1 GiB; the guide explains how to create a smaller ZIP if necessary.
  3. Copy OpenBonk.apk and your private game-data ZIP to Android. Install and open the APK, choose Megabonk game files ZIP, and wait for Data ready.
  4. Choose Touch or Controller in Controls, then return to Game and press Play.

OpenBonk requires 64-bit Android 8 or later. It has been tested on a Retroid Pocket 5, an iPlay 70 mini Pro and a Xiaomi phone. Device compatibility is still being established. Back up existing progress before replacing or uninstalling an app.

Install newer official APKs over your existing app to keep your profile. The launcher migrates the previous version's game data and clears the Unity metadata cache on the normal Play path, so always start the game from the launcher after an update. A ZIP saved with Export profile can also be restored with Import profile ZIP on a newer release. Keep a pre-update export if you plan to return to an older build.

OpenBonk gameplay in Forest using touch controls

Installation guides

Choose a guide for detailed instructions on Steam data, installation, progress backups and troubleshooting. The guides may link to an older helper ZIP: install the APK from the newest release above. Translations other than English and Spanish are machine-generated from the English guide; please report unclear instructions.

English Español Español (Latinoamérica)
Čeština Deutsch Français
Italiano 日本語 한국어
Polski Português Русский
ไทย Türkçe Українська
简体中文 繁體中文

Install with an AI agent

Have a coding agent on your computer? Connect your Android device by USB and paste the prompt below into your agent. USB debugging is optional: the agent can guide you through enabling it, or help you install using file transfer without it. What it can automate depends on your computer, device and agent permissions.

Help me install and launch OpenBonk on my Android device. Work through the
steps with me and do whatever you can directly on this computer.

Read https://github.com/martin2844/OpenBonk and the installation guide for my
language. Detect my operating system, find my own compatible Megabonk Steam
installation and download the official beta package linked by the project.
Use the guide to create the game-data ZIP, including the size-limited helper
if needed. Keep my game files, ZIPs, profile and account details private;
do not upload or share them.

Check for a connected Android device. If ADB is available and my device has
authorized USB debugging, use it where appropriate to transfer the APK and
ZIP and install or launch the app. If authorization is pending, explain the
on-device prompt. Do not assume debugging is enabled or try to bypass it.

If debugging is off, offer me a choice: guide me through enabling Developer
options and USB debugging on my Android device and authorizing this computer,
or continue without debugging. Explain that the settings can vary by device.
If ADB is missing, help me install Android platform tools if I choose that route.

Without debugging, use USB file transfer (MTP) if accessible and walk me through
unlocking the device, selecting File transfer, copying the files if necessary,
installing the APK and approving Android's prompts. If USB transfer is
unavailable, suggest a local transfer method and guide me.

Help me choose touch or controller, import the Steam ZIP in the launcher, wait
for Data ready and start the game. Ask me to perform any step that requires
interaction on the device. Preserve existing installations and saves: help me
back up progress before any replacement or uninstall, and ask before removing
anything. If a step fails, explain what happened and help me troubleshoot.

Touch controls

The beta includes an in-game layout editor with individual visibility and opacity, grid snapping, saved profiles and optional auto-run. Tap Edit at the bottom of the game screen to open it, then tap Done to return to play. See the touch controls guide.

Touch controls follow the same actions as a controller, including Aim, which the charged weapons use. The overlay hides while menus or reward windows are open.

Display and performance

Open Settings → Game resolution in the launcher:

  • Game keeps the game's own resolution selection; Native, 75% and 50% scale the whole screen, and 540p / 720p / 1080p / 1440p set a fixed height. A custom height from 240 to 2160 is also available.
  • Screen / 16:9 (PC) / 4:3 chooses the render aspect. 16:9 (PC) renders a 16:9 backbuffer at the selected height (for example 1280×720) and lets the display stretch it to fill a tall phone, so menus, HUD and gameplay keep the desktop framing instead of looking small on a 20:9 panel.

The launcher applies these settings before the first scene. Lower heights help on weaker GPUs; the 16:9 mode trades a little horizontal stretch for the PC layout.

Mods

Open Mods in the launcher and choose Browse mods or Import ZIP.

  • The catalog lists installed mods first. An installed mod with a newer catalog version shows Update; one tap downloads, verifies the size and SHA-256, replaces it and leaves it enabled.
  • Content mods (maps, enemies, bosses, characters) are enabled automatically when installed or updated. Lua mods keep the default declared in their manifest; legacy packages without a version show ✓ Installed and can be replaced from the mod details dialog.
  • Manage mods still lets you enable or disable any installed mod and restore the previous version.

Examples in this repository:

  • Distrito Nimbo / Nimbo District — a procedurally generated Japanese neighborhood with hillside streets, shops, vending machines, gachapon, lanterns, moai shrines, Mewtwo bald-head statues, ten animated Pokémon species and three huge bosses that throw elemental volleys.
  • Pikachu — an API 3 character with the charged Thunderbolt: five seconds of charge, then press Aim to discharge blue lightning around Pikachu.
  • Retry, Lucky Tome, Offer Tools and other small stat and item mods.

Nimbo District's Shrine of Balance using the stone Mewtwo statue

The Lua interface is under development. It offers specific stat hooks and experimental content callbacks; it does not yet expose every game system or provide automatic compatibility with other recomp projects. Package IDs, supported hooks and limits are documented in the modding guide. Install mods from sources you trust: the current sandbox is not a security boundary.

Source and development

The repository contains reconstructed C# game scripts, the Android launcher and import code, a native Lua bridge, shaders, authoring tools and 250+ intent-gated QA probes. The code is a reconstruction, not a byte-for-byte decompilation.

Building Android requires a compatible local Steam installation, Unity 2023.2 with Android support, AssetRipper, the NDK and other dependencies; generated game data, the game OBB and signing keys are not included. A fresh clone has produced a playable Android build, but the exact published APK has not yet been independently rebuilt from scratch. See Android build instructions.

Privacy and attribution

Keep your Steam game-data ZIP, profile, signing keys and account information private. The launcher requests Internet access to check the OpenBonk update manifest and mod catalog on GitHub, and downloads only what you choose to install. It checks for updates periodically; Android asks for confirmation before installing an APK. Steam game data and profiles are not uploaded. Android system backup may include app data depending on device settings. A Feedback button opens GitHub Issues in your browser; it does not send a report automatically.

OpenBonk is not affiliated with or endorsed by Megabonk or its developer. Game-derived code, shaders, assets and third-party components have differing provenance; distribution rights and a complete license inventory have not yet been established. Pokémon and Pikachu belong to their respective rights holders. See the Pikachu notes for model attribution and provenance.

About

Unofficial community Android port of Megabonk

Resources

Stars

49 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages