Skip to content

Hamatti/ptcgo-card-viewer-extension

Repository files navigation

Pokemon TCG Card Viewer Extension

Mozilla Add-on v.1.2.0

Hover over a Pokemon TCG card ID to see the card image – anywhere in the web

Install & Usage

Get the add-on from AMO

Install it from the addons.mozilla.org.

To use it on a website, click the extension icon.

How it works?

By clicking the extension icon, the script searches for Pokemon TCG Online codes (for example: ASR 65) and adds a <span> wrapper around them. Once the user either hovers over the span or focuses on it with keyboard, an API call is made to pokemontcg.io API to get the image URL for that card. That is then injected into the DOM.

Develop

When developing, you can test it with

npx web-ext run

which opens up a Firefox instance with this extension loaded.

To debug it while running, open about:debugging into a new window, choose "This Firefox" from menu and "Inspect" under this extension.

Running tests

Tests that live in tests/ are for development only and won't be packaged into the extension.

make test

This will install mocha as a development dependency into tests/ and run the tests.

Visual & functional tests

In addition to automated tests above, there's a system for manual verification of base and special case cards.

make test-visual

This command will start a local http server in the tests/ folder to localhost:9000 and open a new Firefox instance on that URL with the extension loaded.

You should then run the extension by clicking the icon and manually verify that all card codes were identified and the hover shows the correct card.

Building the extension

If you have GNU Make and zip installed, you can run

make build

to build an extension. This command excludes tests/, makefile and dist/ from the build.

This creates an .xpi file in dist/ folder.

Optionally, you can create a zip file manually. Exclude the files above to avoid sending extra files and artefacts that doesn't need to be inside the extension.

About

A browser extension for viewing Pokemon TCG cards by hovering over their PTCGO codes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published