Setup

Setup

Depending on your build system, you will use AntRun or Ant directly to run yGuard.

Setup using Ant

Download the bundle from the Github release page. After downloading and extracting the jar files, place them in a path near to your build script. You may use absolute paths, but our examples expect the jar file to lie in the same directory as your build file. Once extracted, you can use the yguard element like so:

<property name="version" value="4.1.1"/>

<target name="yguard">
    <taskdef name="yguard" classname="com.yworks.yguard.YGuardTask" classpath="${projectDir}/yguard-${version}.jar"/>
    <yguard>
        <!-- see the yGuard task documentation for information about the <yguard> element-->
    </yguard>
</target>

Setup using Maven

You can use yGuard directly from Maven central. Add the yGuard dependency to your POM:

<dependency>
    <groupId>com.yworks</groupId>
    <artifactId>yguard</artifactId>
    <version>4.1.1</version>
    <scope>compile</scope>
</dependency>

Once declared, you can use the antrun plugin to define the yGuard task like so:

<plugin>
    <artifactId>maven-antrun-plugin</artifactId>
    <version>1.8</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>run</goal>
            </goals>
            <id>obfuscate</id>
            <configuration>
                <tasks>
                    <property name="runtime_classpath" refid="maven.runtime.classpath"/>
                    <taskdef name="yguard" classname="com.yworks.yguard.YGuardTask" classpath="${runtime_classpath}"/>
                    <yguard>
                       <!-- see the yGuard task documentation for information about the <yguard> element-->
                    </yguard>
                </tasks>
            </configuration>
        </execution>
    </executions>
</plugin>

Setup using Gradle

You can use yGuard directly from Maven central. You can define and use yGuard in your build.gradle:

repositories {
  mavenCentral()
}

dependencies {
  compileOnly 'com.yworks:yguard:4.1.1'
}

task yguard {
  group 'yGuard'
  description 'Obfuscates and shrinks the java archive.'

  doLast {
    ant.taskdef(
        name: 'yguard',
        classname: 'com.yworks.yguard.YGuardTask',
        classpath: sourceSets.main.compileClasspath.asPath
    )

    ant.yguard {
        // see the yGuard task documentation for information about the yGuard element
    }
  }
}