Skip to content
This repository has been archived by the owner on Apr 6, 2021. It is now read-only.
/ Cassius Public archive

A bot for Pokemon Showdown written in JavaScript

License

Notifications You must be signed in to change notification settings

sirDonovan/Cassius

Repository files navigation

Cassius

Build Status

A bot for Pokemon Showdown.

Inactivity notice - November 5, 2018

Cassius has been succeeded by Lanette and is no longer actively developed.

Installation

Cassius requires Node.js version 10.13.0 or later and a command line (e.g. Command Prompt on Windows or Terminal on Mac OS/Linux) to run. Once you have compatible software, complete installation by following these steps:

  1. Obtain a copy of Cassius

You can do this through the GitHub client by clicking the "Clone or download" button on the home page of the repository and then clicking "Open in Desktop". You can also use the following Git command:

git clone https://github.com/sirDonovan/Cassius.git

  1. Navigate to the root directory

The remaining steps will take place in the root directory of your Cassius files. Navigate there with the command:

cd DIRECTORY

Replace DIRECTORY with the filepath to your directory (e.g. C:\Users\sirDonovan\Documents\GitHub\Cassius).

  1. Install dependencies

Run the following command to install required dependencies:

npm install --production

If you plan to contribute to development, run the command without the --production flag to also install dependencies used for testing.

  1. Set up the config file

Copy and paste the config-example.js file, rename it to config.js, and open it in your text editor to enter your desired information.

From this point on, you can start the bot by running the following command:

node app.js

Credits

License

Cassius is distributed under the terms of the MIT License.