Skip to content

Latest commit

 

History

History
182 lines (157 loc) · 7.67 KB

README.md

File metadata and controls

182 lines (157 loc) · 7.67 KB
Raw


RogueTop

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

Installation

x86_64: Online-only | Offline
ARM64: Online-only | Offline
x86_64: Online-only | Offline
ARM64: Online-only | Offline

You can also download portable versions for each platform, which you can find on the releases page.

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!

Online vs Offline

RogueTop comes in two flavors, regular and "offline". Regular versions are very lightweight (usually <5mb), and will load the online version of PokeRogue. Offline versions are significantly larger (around 450mb), but contain the entirety of PokeRogue within the binary, and can be run without an internet connection! Offline versions allow access in BOTH online and offline scenarios.

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

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

Steps

  1. Clone the repository:
git clone git@github.com:SpikeHD/RogueTop.git
  1. Install the dependencies:
cd RogueTop
pnpm install
  1. (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]
  1. (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
  2. 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!