Spedran (past tense of speedrun) is a simple library to interact with Speedrun.com's REST API. It uses Optionals for optional fields and CompletableFutures for asynchronous requests.
For readability and brevity, Speedrun.com will be abbreviated as SRC in the documentation.
Here's a very simple example on how to use Spedran.
public class GetUserName {
public static void main(String[] args) {
// Get a user with an ID
User user = Spedran.getUser("zx721w08").join();
// Print the user's name
System.out.println(user.getNames().getInternationalName());
}
}
<dependency>
<groupId>com.treescrub</groupId>
<artifactId>spedran</artifactId>
<version>0.29.0</version>
</dependency>
repositories {
mavenCentral()
}
dependencies {
implementation 'com.treescrub:spedran:0.29.0'
}
See the examples directory for examples.
See the Javadocs for documentation.
- Maven 3
- JDK 11
- Clone the repo
git clone https://github.com/Treescrub/Spedran.git
- Make changes in your preferred editor.
- Use
mvn test
in the project root to compile and test the library.
Distributed under the MIT license, see LICENSE.txt
.
- SRC API official documentation - Mostly up to date, missing pronoun info for users and supporter boost info for games. See issues for API quirks.