PokéClicker

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

NOTE: PokéClicker is still in development!

You can try out the current state at https://www.pokeclicker.com/

You can reach out on discord to discuss your ideas and how to implement them: https://discord.gg/a6DFe4p

Developer instructions

Rules

Make sure the build script is a success. We won't test PRs that fail the building script.
We won't accept balance PRs, unless it's from a developer or Code Contributor (discord roles).
Don't submit any changes within the /docs folder.

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.

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 clean-install

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

npm start

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

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

npm run website

After this command completes, push the changed files in the 'docs' directory to Github.