Tutorial by: Donut


Preface

This tutorial will walk you though obfuscating your skripts as well as encapsulating them in a jar with Obfuskator. Obfuskator is not a plugin! Obfuscated skripts do not require any additional plugins besides skript to run. The obfuscation is not irreversible of course and is solely intended to deter amateur skript thieves.

Initial Setup

  1. Download Obfuskator
  2. Install the JDK (not JRE!) if you do not have it
  3. Run the Ofuskator program (you may have to tell Windows it is safe to run)
  4. Once on the main menu click either "classic obfuscation" or "jar obfuscation" and proceed to the corresponding tutorial section

Obfuscating Your Skript

If you are not there already, navigate to the classic obfuscation interface:

  1. Click the "Add files" button to upload the skript(s) you would like to obfuscate
  2. Select either the normal or lite obfuscation option (normal is recommended but lite obfuscation will output a smaller file)
  3. Click the "Obfuscate" button
  4. The skript(s) will be obfuscated and saved as "obfuscated_original_name.sk" in the directory you ran the program from
  5. The obfuscated skripts are now ready to be used

Note: You must remove all options in your skript before obfuscating or it will not work properly!

The obfuscated skript will look something like this:

Encapsulating Your Skript in a Jar (aka skar)

Encapsulating your skript in a jar is an efficient way to streamline distribution and your skript will not be exposed in the scripts folder. You have the option to package Skript and/or skript-mirror with your skript (see steps 3-4). When the jar is run the Skript Runtime Envrironment and Mirror Runtime Environment (SRE and MRE respectively) will be initialized.

If you are not there already, navigate to the jar obfuscation interface:

  1. Click the "Add files" button to upload the skript(s) you would like to encapsulate in the jar
  2. Select the "Don't obfuscate" option if you do not want the skript(s) to be obfuscated
  3. Select the "Package Skript" option if you want Skript to be embedded in the jar with your skript. In the drop down menu proceed to select the appropriate Skript version you would like to package
  4. Select the "Package skript-mirror" option if you want skript-mirror to be embedded in the jar with your skript. This means that if your skript uses skript-mirror it will still work properly even if the server does not have skript-mirror installed
  5. Click the "Obfuscate" button and the jar will created in the directory you ran the program from and is ready to be used

Did you find Donut's tutorial helpful?


You must be logged in to comment