{"id":16620604,"url":"https://github.com/spikehd/roguetop","last_synced_at":"2025-04-05T00:22:25.311Z","repository":{"id":238792459,"uuid":"797489614","full_name":"SpikeHD/RogueTop","owner":"SpikeHD","description":"Moddable, lightweight PokeRogue Desktop App for Windows, Mac and Linux, built for x86 and ARM.","archived":false,"fork":false,"pushed_at":"2024-05-20T05:36:25.000Z","size":1414,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-20T06:25:46.297Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpikeHD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-08T00:05:15.000Z","updated_at":"2024-07-20T02:20:18.951Z","dependencies_parsed_at":"2024-05-08T06:37:45.829Z","dependency_job_id":"26ab1459-8042-4d4f-9a10-a0559252f48f","html_url":"https://github.com/SpikeHD/RogueTop","commit_stats":null,"previous_names":["spikehd/roguetop"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FRogueTop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FRogueTop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FRogueTop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FRogueTop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpikeHD","download_url":"https://codeload.github.com/SpikeHD/RogueTop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247267587,"owners_count":20911007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-12T02:44:40.745Z","updated_at":"2025-04-05T00:22:25.291Z","avatar_url":"https://github.com/SpikeHD.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n \u003cimg height=\"100px\" src=\"https://raw.githubusercontent.com/SpikeHD/roguetop/main/src-tauri/icons/icon.png\" /\u003e\n \u003cbr /\u003e\n RogueTop\n\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/SpikeHD/roguetop/build.yml\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/package-json/v/SpikeHD/roguetop\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/repo-size/SpikeHD/roguetop\" /\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/github/commit-activity/m/SpikeHD/roguetop\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/release-date/SpikeHD/roguetop\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/stars/SpikeHD/roguetop\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/downloads/SpikeHD/roguetop/total\" /\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n Online and offline \u003ca href=\"https://github.com/pagefaultgames/pokerogue\"\u003ePokeRogue\u003c/a\u003e client for Windows, Linux and MacOS.\n \u003cbr /\u003e\n https://discord.gg/agQ9mRdHMZ\n\u003c/div\u003e\n\n# Installation\n\n\u003ctable align=\"center\"\u003e\n  \u003ctr\u003e\n    \u003cth\u003e\n      \u003cimg src=\"docs/image/windows.png\" width=\"30%\" align=\"center\" /\u003e\n    \u003c/th\u003e\n    \u003cth\u003e\n      \u003cimg src=\"docs/image/apple.png\" width=\"30%\" align=\"center\" /\u003e\n    \u003c/th\u003e\n    \u003cth\u003e\n      \u003cimg src=\"docs/image/debian.png\" width=\"30%\" align=\"center\" /\u003e\n    \u003c/th\u003e\n  \u003c/tr\u003e\n\n  \u003ctr\u003e\n    \u003ctd width=\"30%\"\u003e\n      \u003cdiv align=\"center\"\u003e\n        \u003cspan\u003ex86_64:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-pc-windows-msvc-msi.msi\"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-x86_64-pc-windows-msvc-msi.msi\"\u003eOffline\u003c/a\u003e\n        \u003cbr /\u003e\n        \u003cspan\u003eARM64:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-aarch64-pc-windows-msvc-nsis.exe \"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-aarch64-pc-windows-msvc-nsis.exe\"\u003eOffline\u003c/a\u003e\n      \u003c/div\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"30%\"\u003e\n      \u003cdiv align=\"center\"\u003e\n        \u003cspan\u003ex86_64:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-apple-darwin-dmg.dmg\"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-x86_64-apple-darwin-dmg.dmg\"\u003eOffline\u003c/a\u003e\n        \u003cbr /\u003e\n        \u003cspan\u003eARM64:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-aarch64-apple-darwin-dmg.dmg\"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-aarch64-apple-darwin-dmg.dmg\"\u003eOffline\u003c/a\u003e\n      \u003c/div\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"30%\"\u003e\n      \u003cdiv align=\"center\"\u003e\n        \u003cspan\u003ex86_64:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-unknown-linux-gnu-deb.deb\"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-x86_64-unknown-linux-gnu-deb.deb\"\u003eOffline\u003c/a\u003e\n        \u003cbr /\u003e\n        \u003cspan\u003eARM64:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-aarch64-unknown-linux-gnu-deb.deb\"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-aarch64-unknown-linux-gnu-deb.deb\"\u003eOffline\u003c/a\u003e\n        \u003cbr /\u003e\n        \u003cspan\u003eARMv7:\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-armv7-unknown-linux-gnueabihf-deb.deb\"\u003eOnline-only\u003c/a\u003e\n        \u003cspan\u003e|\u003c/span\u003e\n        \u003ca href=\"https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-offline-armv7-unknown-linux-gnueabihf-deb.deb\"\u003eOffline\u003c/a\u003e\n      \u003c/div\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n*You can also download portable versions for each platform, which you can find on the [releases](https://github.com/SpikeHD/RogueTop/releases/tag/nightly) page.* \n\n\u003e [!NOTE]\n\u003e ***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`.\n\u003e\n\u003e ***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](https://www.virustotal.com/gui/home/upload)!\n\n## Online vs Offline\n\nRogueTop comes in two flavors, regular and \"offline\". Regular versions are very lightweight (usually **\u003c5mb**), 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.\n\n## Alternative Installation Methods\n\nYou can also download the latest build from [GitHub Actions](https://www.github.com/SpikeHD/RogueTop/actions). Or, if you're feeling brave, you can [build it yourself](#building)!\n\n# Table of Contents\n\n* [Installation](#installation)\n  * [Quick Links](#quick-links)\n  * [Online vs Offline](#online-vs-offline)\n  * [Alternative Installation Methods](#alternative-installation-methods)\n* [Building](#building)\n  * [Prerequisites](#prerequisites)\n  * [Steps](#steps)\n* [TODO](#todo)\n* [Contributing](#contributing)\n\n# Features\n\n* Full offline mode\n* Mod support - see the [examples and documentation](https://github.com/SpikeHD/RogueTop/tree/main/examples)\n* Discord RPC\n* Small binaries, not resource-heavy\n* Builds for platforms such as the Raspberry Pi - see the [releases](https://github.com/SpikeHD/RogueTop/releases/latest/) for a full list\n* Always up-to-date, in online mode at least :P\n\n# Building\n\n## Prerequisites\n\n* [NodeJS](https://nodejs.org/en) (or Bun, or whatever)\n  * If using NodeJS, this project prefers [pnpm](https://pnpm.io) as a package manager.\n* [Rust and Cargo](https://www.rust-lang.org/)\n* [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) (these depend on what OS you are running)\n\n## Steps\n\n1. Clone the repository:\n  ```sh\n  git clone git@github.com:SpikeHD/RogueTop.git\n  ```\n2. Install the dependencies:\n  ```sh\n  cd RogueTop\n  pnpm install\n  ```\n3. (If bundling for offline mode, NOT required) run the bootstrap script\n  ```sh\n  # This will clone and build the entirety of PokeRogue into ./src-ext\n  ./bootstrap_pokerogue[.sh|.cmd]\n  ```\n4. (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\n5. Build it!\n  ```sh\n  pnpm tauri build\n  # Or if you have tauri CLI installed\n  cargo tauri build\n\n  # If bundling for offline mode, add the \"offline\" feature\n  cargo tauri build --features offline\n  ```\n\nYour built files will be in the `src-tauri/target` directory.\n\n# TODO\n\n- [x] Bundled offline mode (directly in the binary, eg. should work on an airgapped machine)\n  - [x] Maybe move to bundled (eg. Tauri resource) but external/read from FS, no need for a 500mb binary lol\n  - [x] TODO finish this\n- [ ] Downloadable offline mode (update-able without redownloading a new binary every time)\n- [x] Separate \"lite\" builds that are online-only\n- [x] Hotkeys\n  - [x] Fullscreen\n  - [ ] TBD\n- [ ] Mobile support\n- [x] Add `.plist` for MacOS to solve HTTP issue\n- [x] Mod system/support?\n  - [x] Binding of Isaac-like texture replacements?\n  - [x] JS-based mods?\n  - [ ] Config in UI\n  - [ ] Load from ZIP (mods could get quite big, would make them easier to distribute)\n- [ ] ~~Theme system/support?~~ This is basically just the mod system\n\n# Contributing\n\nIssues, PRs, etc. are all welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Froguetop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspikehd%2Froguetop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Froguetop/lists"}