A bot for Pokemon Showdown written in TypeScript.
Truth Untold 2.O requires Node.js version 10.13.0 (latest LTS) 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:
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
The remaining steps will take place in the root directory of your Truth Untold 2.O files. Navigate there with the command:
cd DIRECTORY
Replace DIRECTORY with the filepath to your cloned directory
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.
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.
From this point on, you can start the bot by running the following command:
node app.js
Issues and pull requests will be welcomed once Truth Untold 2.O 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 Truth Untold 2.O.
- Quinton Lee (@sirDonovan) - Lead developer
- Zerapium (Pokem9n) (@Zerapium) - Owner | Lead developer
- [Contributors](https://github.com/Zerapium/Truth Untold 2.O/graphs/contributors)
- Pokemon Showdown
Truth Untold 2.O is distributed under the terms of the [MIT License](https://github.com/Zerapium/Truth Untold 2.O/blob/master/LICENSE).