steamworks4j

Build instructions

Steamworks SDK

Starting with steamworks4j v1.7.0, the SDK is required to build/package from source. Download the latest Steamworks SDK, then unzip and copy the following folders into the steamworks4j/ root directory:

• steamworks4j/
  • sdk/
    • public/
    • redistributable_bin/

Java

Build development versions

Just use Maven with mvn package in the root directory to compile a jar ready to be used in your application, or mvn install to deploy it to your local Maven cache.

During the compile phase, the Maven build pulls shared libraries out of the sdk/redistributable_bin/ folder and adds them as resources to the steamworks4j module. For copyright reasons, this is not done for steamworks4j-server and the sdkencryptedappticket library. If you want to create such a package, this can be enforced manually with mvn package -Plibs.

Build snapshot or release versions

You can use these profiles to simulate the commands I use to deploy new versions:

# snapshot
mvn install -Psnapshot,libs -pl java-wrapper
mvn install -Psnapshot -pl server

# release
mvn install -Prelease,libs -pl java-wrapper
mvn install -Prelease -pl server

Native libraries

Prebuilt native libraries

You do not need to build the native libraries yourself if you don’t plan to modify the native code of steamworks4j. There are prebuilt versions provided as resources of steamworks4j and steamworks4j-server.

External dependencies

jnigen is used to generate parts of the native code, and premake4/5 to compile native code into dynamic libraries.

Build environments

• Windows

  • A Visual Studio 2017/2019/2022 command line environment must be available. It’s sufficient to use the Community editions. For Visual Studio 2022, the default script to setup the build environment is c:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat
  • premake5.exe (version 5.0.0-beta1) must be available in the path, e.g. in the steamworks4j/build-natives/ folder.

• Linux

  • GCC must be installed in a fairly recent version with C++11 support.
  • premake4 needs to be installed. It should be available through your favorite package manager, e.g. per apt-get install premake4.

• Mac OS

  • XCode must be installed.
  • premake5 needs to be available. One possible option is to install it as a Homebrew or Mac Ports package.

Build steps

The first step is to let jnigen generate C++ source files for the embedded JNI functions. The com.codedisaster.steamworks.jnigen.JNICodeGenerator class in the jnigen sub-project contains the code to do that.

• The working directory must be the steamworks4j/ root folder.
• You can just run JNICodeGenerator.main() as a plain Java application from inside your favorite IDE. No arguments are required.
• The generated code is written to steamworks4j/java-wrapper/src/main/native/ and steamworks4j/server/src/main/native/.

If everything is setup correctly, you now only need to run the right build-osx.sh, build-linux.sh or build-win.bat shell script in the steamworks4j/build-natives/ folder to compile and link the native libraries on each target platform. The scripts also copy the compiled libraries to the appropriate src/main/resources/ folder.

On Windows, the build script expects an additional parameter for the compiler version to use. For example, run with build-win.bat vs2022 to compile and link using Visual Studio 2022.

In case of errors, you should be able to open the workspace/project files created by premake4/5 in their respective IDE for troubleshooting.