RogueTop

Online and offline PokeRogue client for Windows, Linux and MacOS.
https://discord.gg/agQ9mRdHMZ

Installation

Quick Links

• Windows
  • Installer Download | Offline Version
  • Portable Download | Offline Version
• Linux
  • Debian-based Download | Offline Version
  • Portable Download | Offline Version
• MacOS
  • Intel-based Download | Offline Version
  • M-series-based Download | Offline Version

Note

MacOS Users: If opening the app gives you "PokeRogue.app is damaged and cannot be opened", MacOS is lying to you and you may just need to run sudo xattr -rd com.apple.quarantine /Applications/PokeRogue.app.

Windows Users: Defender may think RogueTop is a virus. This just happens sometimes, and if SmartScreen blocks it from running, click "More Info" and "Run Anyways". Feel free to scan RogueTop with Virustotal!

Other Architectures

The file you download depends on your operating system:

• For Windows, download the .msi installer file, or the pc-windows ZIP file. Builds are also provided for arm64.
• For Linux, download the .deb installer files, or the unknown-linux ZIP file. Builds are also provided for armv7 and arm64.
• For MacOS, download the .dmg installer file, or the apple-darwin ZIP file. Builds are provided for both Intel-based (x86_64) and M-series-based MacOS systems (arm64).

Releases also come in two flavors, regular and "offline". Regular versions are very lightweight, and will load the online version of PokeRogue. Offline versions are larger, but contain the entirety of PokeRogue within the binary, and can be run without an internet connection!

Alternative Installation Methods

You can also download the latest build from GitHub Actions. Or, if you're feeling brave, you can build it yourself!

Table of Contents

• Installation
  • Quick Links
  • Other Architectures
  • Alternative Installation Methods
• Building
  • Prerequisites
  • Steps
• TODO
• Contributing

Features

• Full offline mode
• Mod support - see the examples and documentation
• Discord RPC
• Small binaries, not resource-heavy
• Builds for platforms such as the Raspberry Pi - see the releases for a full list
• Always up-to-date, in online mode at least :P

Building

Prerequisites

• NodeJS (or Bun, or whatever)
  • If using NodeJS, this project prefers pnpm as a package manager.
• Rust and Cargo
• Tauri prerequisites (these depend on what OS you are running)

Steps

1. Clone the repository:

git clone [email protected]:SpikeHD/RogueTop.git

2. Install the dependencies:

cd RogueTop
pnpm install

3. (If bundling for offline mode, NOT required) run the bootstrap script

# This will clone and build the entirety of PokeRogue into ./src-ext
./bootstrap_pokerogue[.sh|.cmd]

4. (If NOT bundling for offline mode) create a fake game.dat file (ie. run touch game.dat) in the root of the repository, to prevent build issues
5. Build it!

pnpm tauri build
# Or if you have tauri CLI installed
cargo tauri build

# If bundling for offline mode, add the "offline" feature
cargo tauri build --features offline

Your built files will be in the src-tauri/target directory.

TODO

• Bundled offline mode (directly in the binary, eg. should work on an airgapped machine)
  • Maybe move to bundled (eg. Tauri resource) but external/read from FS, no need for a 500mb binary lol
  • TODO finish this
• Downloadable offline mode (update-able without redownloading a new binary every time)
• Separate "lite" builds that are online-only
• Hotkeys
  • Fullscreen
  • TBD
• Mobile support
• Add .plist for MacOS to solve HTTP issue
• Mod system/support?
  • Binding of Isaac-like texture replacements?
  • JS-based mods?
  • Config in UI
  • Load from ZIP (mods could get quite big, would make them easier to distribute)
• Theme system/support? This is basically just the mod system

Contributing

Issues, PRs, etc. are all welcome!