pagefaultgames/pokerogue

★ 5,664TypeScriptAudience · generalComplexity · 3/5LicenseSetup · moderate

Mindmap

mindmap
  root((PokeRogue))
    Gameplay
      Pokemon battles
      Roguelite runs
      Stacking items
      Procedural content
    Tech
      TypeScript
      Browser-based
    Contributing
      Open source
      AGPL license
      Contributor guide
    Community
      Discord
      Fan project

mindmap root((PokeRogue)) Gameplay Pokemon battles Roguelite runs Stacking items Procedural content Tech TypeScript Browser-based Contributing Open source AGPL license Contributor guide Community Discord Fan project

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Play the roguelite Pokemon game directly in a browser with no download or account required

USE CASE 2

Contribute new features or bug fixes by forking the TypeScript codebase and following the contributor setup guide

USE CASE 3

Study the game architecture as a real-world example of a complex browser-based game written in TypeScript

Tech stack

TypeScriptJavaScript

Getting it running

Difficulty · moderate Time to first run · 30min

Fan project with no Nintendo or Pokemon Company affiliation, commercial use is restricted by the AGPL and Creative Commons licenses.

Source code is AGPL-v3: you can use and modify it freely but must share your changes publicly if you distribute or host the game. Documentation uses Creative Commons with no commercial use.

In plain English

PokeRogue is a fan-made Pokemon game that runs in a web browser. It takes the core idea of Pokemon battles and remixes it with the roguelite genre, a style of game where you run through procedurally generated content, collecting items that stack on each other, and try to survive as long as possible before starting over. The game has you battling through many different environments, facing trainers and bosses, while building up increasingly unusual combinations of stacking items. The game is free to play in the browser and does not require any download or installation. It is an unofficial fan project and has no affiliation with Nintendo or the Pokemon Company. The project has an active community on Discord where players discuss the game and provide feedback. The code is open source and written in TypeScript. Anyone who wants to contribute to development can follow setup instructions in a separate contributing guide. The README on the main repository page is intentionally brief and points contributors toward that document for everything they need to get started locally. Licensing is handled carefully to track the copyright of each file individually. The source code is under the AGPL-v3 license, which means modifications must also be shared publicly. Documentation uses a Creative Commons license that restricts commercial use. Some game assets in the repository do not have explicit licensing information and are noted as such. The project credits a large number of community contributors and asks anyone who created assets that appear in the game but is not listed to reach out via GitHub or Discord.

Copy-paste prompts

Prompt 1

How do I set up a local development environment for PokeRogue from the pagefaultgames/pokerogue GitHub repo, what do I install and how do I run it?

Prompt 2

I want to add a new stacking item to PokeRogue, where in the TypeScript codebase are items defined and what do I need to implement?

Prompt 3

Explain how PokeRogue's roguelite run system works based on the source code, how does it handle floors, encounters, and item persistence between battles?

Prompt 4

What does AGPL-v3 mean in practice if I want to fork PokeRogue and host my own version, what am I required to do?

Prompt 5

How does PokeRogue handle procedural generation of encounters and environments, walk me through the relevant TypeScript modules

Open on GitHub → Explain another repo

← pagefaultgames on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.