<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="assets/style.css"/><linkrel="stylesheet"href="assets/highlight.css"/><scriptdefersrc="assets/main.js"></script><scriptasyncsrc="assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="assets/navigation.js"id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os";document.body.style.display="none";setTimeout(()=>app?app.showPage():document.body.style.removeProperty("display"),500)</script><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base="."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><h2>pokemon-rogue-battle</h2></div><divclass="tsd-panel tsd-typography"><p><picture><imgsrc="media/logo.png"width="300"alt="PokéRogue"></picture></p>
<p>PokéRogue is a browser based Pokémon fangame heavily inspired by the roguelite genre. Battle endlessly while gathering stacking items, exploring many different biomes, fighting trainers, bosses, and more!</p>
<aid="md:contributing"class="tsd-anchor"></a><h1class="tsd-anchor-link">Contributing<ahref="#md:contributing"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="assets/icons.svg#icon-anchor"></use></svg></a></h1><aid="md:🛠️-development"class="tsd-anchor"></a><h2class="tsd-anchor-link">🛠️ Development<ahref="#md:🛠️-development"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>If you have the motivation and experience with Typescript/Javascript (or are willing to learn) please feel free to fork the repository and make pull requests with contributions. If you don't know what to work on but want to help, reference the below <strong>To-Do</strong> section or the <strong>#feature-vote</strong> channel in the discord.</p>
<aid="md:linting"class="tsd-anchor"></a><h4class="tsd-anchor-link">Linting<ahref="#md:linting"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the <code>npm run eslint</code> script. To view the complete rules, check out the <ahref="media/eslint.config.js">eslint.config.js</a> file.</p>
<aid="md:📚-documentation"class="tsd-anchor"></a><h3class="tsd-anchor-link">📚 Documentation<ahref="#md:📚-documentation"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>You can find the auto-generated documentation <ahref="https://pagefaultgames.github.io/pokerogue/main/index.html">here</a>.
For information on enemy AI, check out the <ahref="media/enemy-ai.md">enemy-ai.md</a> file.
For detailed guidelines on documenting your code, refer to the <ahref="media/comments.md">comments.md</a> file.</p>
<aid="md:❔-faq"class="tsd-anchor"></a><h3class="tsd-anchor-link">❔ FAQ<ahref="#md:❔-faq"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>How do I test a new _______?</strong></p>
<p><strong>How do I retrieve the translations?</strong></p>
<ul>
<li>The translations were moved to the <ahref="https://github.com/pagefaultgames/pokerogue-locales">dedicated translation repository</a> and are now applied as a submodule in this project.</li>
<li>The command to retrieve the translations is <code>git submodule update --init --recursive</code>. If you still struggle to get it working, please reach out to #dev-corner channel in Discord.</li>
<aid="md:🪧-to-do"class="tsd-anchor"></a><h2class="tsd-anchor-link">🪧 To Do<ahref="#md:🪧-to-do"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Check out <ahref="https://github.com/pagefaultgames/pokerogue/issues">Github Issues</a> to see how can you help us!</p>
