PokéClicker Platinum

A game about catching Pokémon, defeating gym leaders, and watching numbers get bigger.

Fork Purpose

The purpose of this fork is to enhance the base version of PokéClicker with features and adjustments that better align with the spirit of an idle game. While the upstream project labels itself as an idle game, some recent design choices have moved away from that core philosophy.

This fork aims to stay true to idle-friendly mechanics while remaining as up-to-date with the upstream repository as reasonably possible.
If upstream finds any of these changes valuable, they're welcome to incorporate them into the main project.

Notable Changes

• You can automatically sell dug up items in the Underground.
• Experts in the Underground can automatically sell dug up items.
• The player and experts in the Underground have a decreasing chance to destroy exposed items using a bomb as you/they level up.
• Battles are faster as damage is now applied three times per second instead of once per second. Damage dealt has been adjusted so damage per second remains the same.

Try Platinum at https://www.pokeclickerplatinum.com/
Try the original at https://www.pokeclicker.com/

Note

PokéClicker is still in development!

Developer instructions

Guidelines

• Make sure the build script is a success. We won't test Pull Requests that fail the building script.
• Pull Requests adding new translatable content should link to a Pull Request in the translation repo adding your new strings. See the Developer instructions on that repo for more info.
• Split Pull Requests into smaller Pull Requests when possible. It will make it easier for us to review, and easier for you if something's needs to be changed or is rejected.

Editor/IDE setup

We have an EditorConfig and linting configured, to help everyone write similar code. You will find our recommended plugins for VSCode below, however you should be able to find a plugin for other IDEs as well.

• EditorConfig
• ESLint
• Stylelint

Building from Source

First make sure you have git and npm available as command-line utilities (so you should install Git and NodeJS if you don't have them already).

Open a command line interface in the directory that contains this README file, and use the following command to install PokéClicker's other dependencies locally:

npm run clean

Then finally, run the following command in the command line interface to start a browser running PokéClicker.

npm start

Tip

Changes to the sourcecode will automatically cause the browser to refresh.
This means you don't need to compile TypeScript yourself. Gulp will do this for you 👍

Use Google cloud shell (alternative)

npm clean-install
npm start

Click the Web Preview Button and select port 3001 from the displayed menu.
Cloud Shell opens the preview URL on its proxy service in a new browser window.

Deploying a new version to Github Pages

Important

Before deploying, check that the game compiles and starts up without errors.

Then run the following:

npm run website

This will populate the /docs folder.

After this command completes you can now publish this to your GitHub pages branch using:

npm run publish

Which by default will push to the master branch