open-index/open-npm huggingface dataset:
npm package: @radnyx/crystal
Description: Pokemon Crystal battle simulator.
Latest version: 0.9.0

# Crystal Battle Simulator

[![npm version](https://badge.fury.io/js/@radnyx%2Fcrystal.svg)](https://badge.fury.io/js/@radnyx%2Fcrystal)

![Simulator in action!](https://i.imgur.com/BlcxUHm.gif)

This is a playable browser simulation of the Pokemon Cystal battle engine.

This uses [modular Pokemon Showdown](https://github.com/pkmn/ps) as the backend and [PIXI.js](https://github.com/pixijs/pixijs) for rendering.

The battle experience is mostly complete. Not all moves are finished and items aren't supported yet.

## Quick start ##

From the root directory, install all required packages:

```bash
npm install
```

### Battle demo ###

```bash
cd demo/menus
npm run dev
```

Visit `localhost:8001/menus.html` to play a battle.

### Animation demo ###

```bash
cd demo/moves
npm run dev
```

Visit `localhost:8000/moves.html` to try out move animations.

## Want to contribute? ##

Right now, the best way to help is to animate moves.

Full contribution instructions are in the [CONTRIBUTING.md](CONTRIBUTING.md).

## Contact ##

Please contact me with any suggestions or bug reports.

[![Discord Server](https://dcbadge.vercel.app/api/server/v4P6N77bP3)](https://discord.gg/v4P6N77bP3)

[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/radnyx.svg?style=social&label=Follow%20%40radnyx)](https://twitter.com/radnyx)

[Smogon Forum Thread](https://www.smogon.com/forums/threads/browser-playable-gen-2-team-editor.3704581/)