JavaSteam

Java port of SteamKit2. JavaSteam targets Java 11.

Download

Latest version is available through Maven

Snapshots may be available through Maven central repository

If you get a java.security.InvalidKeyException: Illegal key size or default parameters exception when trying to encrypt a message you need to download the Unlimited Strength Jurisdiction Policy Files and place them under ${java.home}/jre/lib/security/.

See this stackoverflow question.

1. Add the repository to your build.

Gradle

repositories {
    mavenCentral()
}

Maven


<repository>
    <id>central</id>
    <url>https://repo.maven.apache.org/maven2</url>
</repository>

2. Add the JavaSteam dependency to your project.

Gradle

implementation 'in.dragonbra:javasteam:x.y.z'

Maven


<dependency>
    <groupId>in.dragonbra</groupId>
    <artifactId>javasteam</artifactId>
    <version>x.y.z</version>
</dependency>

3. Add the appropriate cryptography dependency to your project. JavaSteam depends on this.

Android (Deprecated) | Spongy Castle

Android and Non-Android | Bouncy Castle

4. Optional dependencies.

Protobufs:
- If you plan on working with protobuf builders directly to perform actions a handler doesn't support, you will need to add the protobuf-java dependency.
- Note: To eliminate any errors or warnings, you should try and match the same version JavaSteam uses.
Content Downloading:
- If you plan on working with Content Downloading, Depot files may be compressed with Zstd (Zstandard).
- You will need to implement the correct type of ztd implementation if using JVM or Android.
- Android uses aar for the library type.

You can find the latest version of these dependencies JavaSteam supports here.

Getting Started

You can head to the very short Getting Started page or take a look at the samples to get you started with using this library.

There some open-source projects too you can check out.

The wiki may also be useful to check out for other info.

Build

Full build:

./gradlew build -x signMavenJavaPublication

Generated classes:

./gradlew generateProto generateSteamLanguage generateProjectVersion

Contributing

Contributions to the repository are always welcome! Checkout the contribution guidelines to get started.

Other

Join the discord server if you have any questions related or unrelated to this repo or just want to chat!

License

This project is licensed under the MIT License - see the LICENSE file for details