This is a wrapper of Pokemon Showdown's API for Scala. It allows developers to easily interact with Pokemon Showdown (either official or unofficial instances) to make clients, bots and other tools.
SBT:
libraryDependencies += "io.github.projectpidove" %% "scala-showdown-api" % "version"
Mill:
ivy"io.github.projectpidove::scala-showdown-api:version"
The way to connect to Showdown depends on the module you are using. Check yours here.
Information about methods and data types can be found in the API Reference
To contribute to the project, you can either create a new issue if you discovered a bug or have a feature to request, or contributing to the code by submitting a pull request and/or solving open issues
If you want to contribute to the code or just compile the project yourself, you need to build the project:
mill <module>.compile
Where <module>
is either:
main
: API's core logic and datatypescats
: Cats integrationtyrian
: Tyrian integration
You need to execute the following command:
mill docs.docJar
The documentation's target directory is out/docs/docJar.dest/