Skip to main content

Installing the engine

Gradle​

Add StarOpenSource's maven repository to your build.gradle file first:

repositories {
    mavenCentral()
    
    // sos!engine maven repository
    maven {
        name "staropensource-engine"
        url  "https://mvn.staropensource.de/engine"
    }
}

After that declare the engine as a dependency to your project in the build.gradle file:

dependencies {
    // sos!engine base
    implementation 'de.staropensource.engine:base:' + project.dependencyStarOpenSourceEngine
    
    // sos!engine subsystems
    //implementation 'de.staropensource.engine:ansi:'         + project.dependencyStarOpenSourceEngine  // nice logging and ANSI support in your application
    //compileOnly    'de.staropensource.engine:ansi:'         + project.dependencyStarOpenSourceEngine  // nice logging only
    //compileOnly    'de.staropensource.engine:slf4j-compat:' + project.dependencyStarOpenSourceEngine  // SLF4J compatibility
    //implementation 'de.staropensource.engine:windowing:'    + project.dependencyStarOpenSourceEngine  // creating and managing windows, requires a Windowing API implementation
    //compileOnly    'de.staropensource.engine:glfw:'         + project.dependencyStarOpenSourceEngine  // Windowing API implementation using GLFW
    //implementation 'de.staropensource.engine:notification:' + project.dependencyStarOpenSourceEngine  // sending and receiving notifications inside your application
}

... and add this property to the settings.gradle file:

# Set this to the engine version you want to use
dependencyStarOpenSourceEngine=1-alpha8

Maven​

Add StarOpenSource's maven repository to your pom.xml file first:

<repositories>
    <!-- sos!engine maven repository -->
    <repository>
        <id>staropensource-engine</id>
        <name>staropensource-engine</name>
        <url>https://mvn.staropensource.de/engine</url>
    </repository>
</repositories>

After that declare the engine as a dependency in your project:

<dependencies>
    <!-- sos!engine base -->
    <dependency>
        <groupId>de.staropensource.engine</groupId>
        <artifactId>base</artifactId>
        <version>1-alpha8</version>
    </dependency>

    <!-- sos!engine subsystems -->
    <!-- nice logging and ANSI support in your application
      <dependency>
          <groupId>de.staropensource.engine</groupId>
          <artifactId>ansi</artifactId>
          <version>1-alpha8</version>
      </dependency>
    -->
    <!-- SLF4J compatibility
      <dependency>
          <groupId>de.staropensource.engine</groupId>
          <artifactId>slf4j-compat</artifactId>
          <version>1-alpha8</version>
      </dependency>
    -->
    <!-- creating and managing windows, requires a Windowing API implementation
      <dependency> 
          <groupId>de.staropensource.engine</groupId>
          <artifactId>windowing</artifactId>
          <version>1-alpha8</version>
      </dependency>
    -->
    <!-- Windowing API implementation using GLFW
      <dependency> 
          <groupId>de.staropensource.engine</groupId>
          <artifactId>glfw</artifactId>
          <version>1-alpha8</version>
      </dependency>
    -->
    <!-- sending and receiving notifications inside your application
      <dependency> 
          <groupId>de.staropensource.engine</groupId>
          <artifactId>notification</artifactId>
          <version>1-alpha8</version>
      </dependency>
    -->
</dependencies>