<!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="./public/images/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><h1><ahref="#md:contributing">Contributing</a></h1><aid="md:🛠️-development"class="tsd-anchor"></a><h2><ahref="#md:🛠️-development">🛠️ Development</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>
<li>Clone the repo and in the root directory run <code>npm install</code><ul>
<li><em>if you run into any errors, reach out in the <strong>#dev-corner</strong> channel in discord</em></li>
</ul>
</li>
<li>Run <code>npm run start:dev</code> to locally run the project in <code>localhost:8000</code></li>
</ol>
<aid="md:linting"class="tsd-anchor"></a><h4><ahref="#md:linting">Linting</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. </p>
<aid="md:❔-faq"class="tsd-anchor"></a><h3><ahref="#md:❔-faq">❔ FAQ</a></h3><p><strong>How do I test a new _______?</strong></p>
<ul>
<li>In the <code>src/overrides.ts</code> file there are overrides for most values you'll need to change for testing</li>
</ul>
<aid="md:🪧-to-do"class="tsd-anchor"></a><h2><ahref="#md:🪧-to-do">🪧 To Do</a></h2><p>Check out <ahref="https://github.com/pagefaultgames/pokerogue/issues">Github Issues</a> to see how can you help us!</p>
<aid="md:🎨-pokemon-sprites-and-animation"class="tsd-anchor"></a><h3><ahref="#md:🎨-pokemon-sprites-and-animation">🎨 Pokemon Sprites and Animation</a></h3><ul>
