Git Product home page Git Product logo

roguedex's Introduction

Rogue Dex Browser Extension

Description

Rogue Dex is a browser extension that connects to Pokerogue and uses PokeAPI to show information about Pokemon weaknesses, immunities, and resistances for each round.

Features

  • Displays Pokemon weaknesses, immunities, and resistances in real-time during gameplay.
  • Enhances the Pokerogue experience by providing valuable Pokemon information.

Installation

  • Clone this repository to your local machine.
  • Load the extension in developer mode in your browser.
    • Load unpacked -> select src folder of this repository if using development code, or dist if using distribution code (if available).
  • Launch Pokerogue and start playing to see Pokemon data in action.

Usage

  • Start a new game or load a saved game in Pokerogue.
  • The extension will display Pokemon information for each round.
  • Use the data to strategize your gameplay effectively.

Development

  • After cloning the repository, run npm install in a console/terminal (after navigating to the repo directory).
  • Husky will run pre-commit hooks if enabled, read more: https://typicode.github.io/husky/how-to.html, currently disabled.
  • Package.json has a bunch of scripts to lint and format code, css and html files. These can be run by a pre-commit hook or manually, for example npm run <script name>.
  • Eslint: for linting javascript code, config file in root dir.
  • Stylelint: for linting stylesheets, config file in root dir.
  • Prettier: for beautifying / formatting js, css and html, config file in root dir.
  • Development files should be in src directory.
  • Distribution code and zip files can be created with the npm run package script, output will be in the dist directory. This includes file minifying.
  • npm run build-test can be used to build the dist files while skipping some processes (terser, babel).

Contribution

Feel free to contribute to this project by forking the repository, making changes, and submitting pull requests.

Credits

PokeAPI for various pokemon-related assets

Policy

No user data is transferred to any external servers by this extension. All the traffic is analyzed on each browser only and there is no server component that acts upon this data.

roguedex's People

Contributors

eruyome avatar devingearing avatar roguedex-dev avatar gsajith avatar archowlen avatar thechillcheetah avatar

Stargazers

Paulo Batista avatar  avatar  avatar

Watchers

Paulo Batista avatar  avatar  avatar

Forkers

sirzento

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.