Skip to main content

Quickstart

Prepare the local environment​

The documentation is mainly designed for Linux, which should be fairly compatible with macOS and Windows (with WSL).

  1. Install SDKMAN! by following the instructions in: https://sdkman.io/install/ or:

    curl -s "https://get.sdkman.io" | bash
    source "$HOME/.sdkman/bin/sdkman-init.sh"
    sdk version

  2. Install Java 25+:

    sdk install java 25.0.2-tem

  3. Create and configure the file $HOME/.gradle/gradle.properties:

    mkdir $HOME/.gradle
    cat <<EOL >> $HOME/.gradle/gradle.properties
    etherealStudioMavenRepoUrl=https://gitlab.com/api/v4/projects/67011212/packages/maven
    etherealStudioMavenRepoAuthHeaderName=Private-Token
    etherealStudioMavenRepoAuthHeaderValue=<token_value>
    EOL

    Replacing <token_value> with a valid token.

    If you don't have a token, you can generate it by going to your User preferences > Access Tokens: https://gitlab.com/-/user_settings/personal_access_tokens and create one with the following scopes: read_api, read_repository, write_repository, read_registry.

    An additional recommended setting to be added to the file is: org.gradle.parallel=true

    warning

    Do not add these credentials at project level

Download the example project​

Now that all environment preparations are ready, we can setup our game example:

  1. Reproduce the structure for the game:

    mkdir -p games/example

  2. Change to the game directory:

    cd games/example

  3. Download the example projects:

    git clone [email protected]:ethereal-partners/partner/example_studio/games/example/example-be.git

  4. Confirm a correct setup (run simulations)

    cd example-be
    ./gradlew studioRunSim