distrib-ps/lanette

A bot for Pokemon Showdown written in TypeScript

Lanette

A bot for Pokemon Showdown written in TypeScript.

Caution!

Lanette is still in the alpha phase of development so it is not yet recommended for daily use. If you do choose to use or experiment with it, please be aware that breaking changes will currently occur without warning and may require manual moving or renaming of config settings and/or data stored in database files.

Installation

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

Obtain a copy of Lanette

If you plan to make changes outside of the config file, you should create a fork. Make sure you are on the main repository and click "Fork" in the top right to create it. Then, either on your fork or the main repository if you don't plan to make changes, click the "Clone or download" button. In the popup, click either "Open in Desktop" if you're using the GitHub Desktop program or run the following command if you're using Git:

git clone [fork or main repository URL].git

Navigate to the root directory

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

cd DIRECTORY

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

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.

Set up the config file

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

Start the bot

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

node app.js

Development

Issues are welcomed but please hold off on pull requests until Lanette enters the beta phase! When submitting a pull request, be sure that you have installed development dependencies and ran npm test to check for errors in your code.

If possible, it is best to use Visual Studio Code as your text editor when working on Lanette.

Credits

• Quinton Lee (@sirDonovan) - Lead developer
• Contributors
• Pokemon Showdown
• ts-essentials

License

Lanette is distributed under the terms of the MIT License.