122 lines
15 KiB
HTML
122 lines
15 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="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><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>pokemon-rogue-battle</h2></div><div class="tsd-panel tsd-typography"><p><picture><img src="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>
|
|
<a id="md:contributing" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Contributing<a href="#md:contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><a id="md:🛠️-development" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🛠️ Development<a href="#md:🛠️-development" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="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>
|
|
<a id="md:💻-environment-setup" class="tsd-anchor"></a><h3 class="tsd-anchor-link">💻 Environment Setup<a href="#md:💻-environment-setup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><a id="md:prerequisites" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Prerequisites<a href="#md:prerequisites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
<li>node: 20.13.1</li>
|
|
<li>npm: <a href="https://docs.npmjs.com/downloading-and-installing-node-js-and-npm">how to install</a></li>
|
|
</ul>
|
|
<a id="md:running-locally" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Running Locally<a href="#md:running-locally" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ol>
|
|
<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>
|
|
<a id="md:linting" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Linting<a href="#md:linting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="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.</p>
|
|
<a id="md:❔-faq" class="tsd-anchor"></a><h3 class="tsd-anchor-link">❔ FAQ<a href="#md:❔-faq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
<a id="md:🪧-to-do" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🪧 To Do<a href="#md:🪧-to-do" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Check out <a href="https://github.com/pagefaultgames/pokerogue/issues">Github Issues</a> to see how can you help us!</p>
|
|
<a id="md:📝-credits" class="tsd-anchor"></a><h1 class="tsd-anchor-link">📝 Credits<a href="#md:📝-credits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><blockquote>
|
|
<p>If this project contains assets you have produced and you do not see your name here, <strong>please</strong> reach out.</p>
|
|
</blockquote>
|
|
<a id="md:🎵-bgm" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎵 BGM<a href="#md:🎵-bgm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>Pokémon Mystery Dungeon: Explorers of Sky
|
|
<ul>
|
|
<li>Arata Iiyoshi</li>
|
|
<li>Hideki Sakamoto</li>
|
|
<li>Keisuke Ito</li>
|
|
<li>Ken-ichi Saito</li>
|
|
<li>Yoshihiro Maeda</li>
|
|
</ul>
|
|
</li>
|
|
<li>Pokémon Black/White
|
|
<ul>
|
|
<li>Go Ichinose</li>
|
|
<li>Hitomi Sato</li>
|
|
<li>Shota Kageyama</li>
|
|
</ul>
|
|
</li>
|
|
<li>Pokémon Mystery Dungeon: Rescue Team DX
|
|
<ul>
|
|
<li>Keisuke Ito</li>
|
|
<li>Arata Iiyoshi</li>
|
|
<li>Atsuhiro Ishizuna</li>
|
|
</ul>
|
|
</li>
|
|
<li>Pokémon HeartGold/SoulSilver</li>
|
|
<li>Pokémon Black/White 2</li>
|
|
<li>Pokémon X/Y</li>
|
|
<li>Pokémon Omega Ruby/Alpha Sapphire</li>
|
|
<li>Pokémon Sun/Moon</li>
|
|
<li>Pokémon Ultra Sun/Ultra Moon</li>
|
|
<li>Pokémon Sword/Shield</li>
|
|
<li>Pokémon Scarlet/Violet</li>
|
|
<li>Firel (Custom Laboratory, Metropolis, Seabed, and Space biome music)</li>
|
|
<li>Lmz (Custom Jungle biome music)</li>
|
|
<li>Andr06 (Custom Slum and Sea biome music)</li>
|
|
</ul>
|
|
<a id="md:🎵-sound-effects" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎵 Sound Effects<a href="#md:🎵-sound-effects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>Pokémon Emerald</li>
|
|
<li>Pokémon Black/White</li>
|
|
</ul>
|
|
<a id="md:🎨-backgrounds" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Backgrounds<a href="#md:🎨-backgrounds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>Squip (Paid Commissions)</li>
|
|
<li>Contributions by Someonealive-QN</li>
|
|
</ul>
|
|
<a id="md:🎨-ui" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 UI<a href="#md:🎨-ui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>GAMEFREAK</li>
|
|
<li>LJ Birdman</li>
|
|
</ul>
|
|
<a id="md:🎨-pagefault-games-intro" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Pagefault Games Intro<a href="#md:🎨-pagefault-games-intro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>Spectremint</li>
|
|
</ul>
|
|
<a id="md:🎨-game-logo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Game Logo<a href="#md:🎨-game-logo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>Gonstar (Paid Commission)</li>
|
|
</ul>
|
|
<a id="md:🎨-trainer-sprites" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Trainer Sprites<a href="#md:🎨-trainer-sprites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>GAMEFREAK (Pokémon Black/White 2, Pokémon Diamond/Pearl)</li>
|
|
<li>kyledove</li>
|
|
<li>Brumirage</li>
|
|
<li>pkmn_realidea (Paid Commissions)</li>
|
|
<li>IceJkai</li>
|
|
</ul>
|
|
<a id="md:🎨-trainer-portraits" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Trainer Portraits<a href="#md:🎨-trainer-portraits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>pkmn_realidea (Paid Commissions)</li>
|
|
</ul>
|
|
<a id="md:🎨-pokemon-sprites-and-animation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Pokemon Sprites and Animation<a href="#md:🎨-pokemon-sprites-and-animation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>GAMEFREAK (Pokémon Black/White 2)</li>
|
|
<li>Smogon Sprite Project (Various Artists)</li>
|
|
<li>Skyflyer</li>
|
|
<li>Nolo33</li>
|
|
<li>Ebaru</li>
|
|
<li>EricLostie</li>
|
|
<li>KingOfThe-X-Roads</li>
|
|
<li>kiriaura</li>
|
|
<li>Caruban</li>
|
|
<li>Sopita_Yorita</li>
|
|
<li>Azrita</li>
|
|
<li>AshnixsLaw</li>
|
|
<li>Hellfire0raptor</li>
|
|
<li>RetroNC</li>
|
|
<li>Franark122k</li>
|
|
<li>OldSoulja</li>
|
|
<li>PKMarioG</li>
|
|
<li>ItsYugen</li>
|
|
<li>lucasomi</li>
|
|
<li>Pkm Sinfonia</li>
|
|
<li>Poki Papillon</li>
|
|
<li>Fleimer_</li>
|
|
<li>bizcoeindoloro</li>
|
|
<li>mangalos810</li>
|
|
<li>Involuntary-Twitch</li>
|
|
<li>selstar</li>
|
|
<li>koda_want_to_sleep</li>
|
|
</ul>
|
|
<a id="md:🎨-move-animations" class="tsd-anchor"></a><h3 class="tsd-anchor-link">🎨 Move Animations<a href="#md:🎨-move-animations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
|
|
<li>Pokémon Reborn</li>
|
|
</ul>
|
|
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:contributing"><span>Contributing</span></a><ul><li><a href="#md:🛠️-development"><span>🛠️ <wbr/>Development</span></a></li><li><ul><li><a href="#md:💻-environment-setup"><span>💻 <wbr/>Environment <wbr/>Setup</span></a></li><li><ul><li><a href="#md:prerequisites"><span>Prerequisites</span></a></li><li><a href="#md:running-locally"><span>Running <wbr/>Locally</span></a></li><li><a href="#md:linting"><span>Linting</span></a></li></ul></li><li><a href="#md:❔-faq"><span>❔ FAQ</span></a></li></ul></li><li><a href="#md:🪧-to-do"><span>🪧 <wbr/>To <wbr/>Do</span></a></li></ul><a href="#md:📝-credits"><span>📝 <wbr/>Credits</span></a><ul><li><a href="#md:🎵-bgm"><span>🎵 BGM</span></a></li><li><a href="#md:🎵-sound-effects"><span>🎵 <wbr/>Sound <wbr/>Effects</span></a></li><li><a href="#md:🎨-backgrounds"><span>🎨 <wbr/>Backgrounds</span></a></li><li><a href="#md:🎨-ui"><span>🎨 UI</span></a></li><li><a href="#md:🎨-pagefault-games-intro"><span>🎨 <wbr/>Pagefault <wbr/>Games <wbr/>Intro</span></a></li><li><a href="#md:🎨-game-logo"><span>🎨 <wbr/>Game <wbr/>Logo</span></a></li><li><a href="#md:🎨-trainer-sprites"><span>🎨 <wbr/>Trainer <wbr/>Sprites</span></a></li><li><a href="#md:🎨-trainer-portraits"><span>🎨 <wbr/>Trainer <wbr/>Portraits</span></a></li><li><a href="#md:🎨-pokemon-sprites-and-animation"><span>🎨 <wbr/>Pokemon <wbr/>Sprites and <wbr/>Animation</span></a></li><li><a href="#md:🎨-move-animations"><span>🎨 <wbr/>Move <wbr/>Animations</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|