Add as a Gradle dependency

In order to use BuildVu in a Gradle project, you will need to add the jar to the project as a dependency. This process is the same for both HTML and SVG versions.

To do this you have two options:

Manually

This section assumes that the BuildVu jar file is named “buildvu.jar”, if you’re using the trial jar, make sure to rename the file to “buildvu.jar” before following this step.

You will need to first download the BuildVu jar by signing up for a BuildVu trial or by visiting the customer download page.

First add BuildVu jar into your project lib folder, and then either:

Option 1

Add a flatDir repository and a dependency to the build.gradle file.

repositories {
    flatDir {
        dirs 'lib'
    }
}

dependencies {
    implementation 'idrsolutions:buildvu'
}

Option 2

Add a file dependency to the build.gradle file.

dependencies {
    implementation files('lib/buildvu.jar')
}

(Version tested: Gradle 7.5.1)

Using Our Remote Maven Repository

1. Add our repository to repositories with your login information in your build.gradle:

   repositories {
       maven {
          url = "https://files.idrsolutions.com/dl/maven/"
          credentials {
            username "{Your username}"
            password "{Your password}"
          }
       }
   }
   

   Trial

   If you want to get the trial through the maven repository, you will instead need to setup your repositories as so:

   repositories {
       maven {
          url = "https://files.idrsolutions.com/dl/maven/"
          credentials {
            username "{Your Token}"
            password "{Your Token}"
          }
      }
   }
   

   Alternative Credentials

   Alternatively, as it is very insecure to add your login details to your main gradle file, you can instead add the repository with:

   repositories {
       maven {
           url = "https://maven.idrsolutions.com"
           name = 'IDRsolutions'
           credentials(PasswordCredentials)
       }
   }
   

   Then, in a gradle.properties file (you can either use one in your project root directory, or in your GRADLE_USER_HOME directory), add the following:

   IDRsolutionsUsername={Your Username}
   IDRSolutionsPassword={Your Password}
   

   Trial

   Like the credentials in the repository, you need to supply your token instead of your username and password.

   IDRsolutionsUsername={Your Token}
   IDRSolutionsPassword={Your Token}
   

   More about gradle.properties files can be found here.

2. Next, add BuildVu as a dependency:

   For Full Releases:

   HTML

   dependencies {
       implementation 'com.idrsolutions:buildvu-html:{version}'
   }
   

   SVG

   dependencies {
       implementation 'com.idrsolutions:buildvu-svg:{version}'
   }
   

   Where version is one of the releases in the format YYYY.MM (please note that only versions after 2021.11 are available, and we will only provide support for the most recent version of BuildVu)

   For Daily Builds:

   HTML

   dependencies {
       implementation 'com.idrsolutions:buildvu-html-daily:{version}'
   }
   

   SVG

   dependencies {
       implementation 'com.idrsolutions:buildvu-svg-daily:{version}'
   }
   

   Where version is one of the releases in the format YYYY.MM.DD (please note that we only store the most recent daily build)

   For Trial Builds:

   HTML

   dependencies {
       implementation 'com.idrsolutions:buildvu-html-trial:{version}'
   }
   

   SVG

   dependencies {
       implementation 'com.idrsolutions:buildvu-svg-trial:{version}'
   }
   

   Where version is the latest release in the format YYYY.MM.