Official Java client for SunLicense, a licence management and anti-piracy system for indie software developers.
SunLicense issues, validates and revokes licence keys for Minecraft plugins, Discord bots, FiveM scripts, desktop apps and other paid software — with marketplace automation for BuiltByBit and Polymart.
Early release. Licence validation works today. Activations, entitlements and offline verification are in active development.
<dependency>
<groupId>com.sunlicense</groupId>
<artifactId>sunlicense</artifactId>
<version>0.2.0</version>
</dependency>Gradle:
implementation 'com.sunlicense:sunlicense:0.2.0'SunLicense client = new SunLicense.Builder()
.baseUrl("https://your-instance.example.com")
.token(System.getenv("SUNLICENSE_TOKEN")) // optional
.build();
SunLicense.Result result = client.validate("LICENCE-KEY-HERE");
if (result.isValid()) {
getLogger().info("Licence valid");
} else {
getLogger().warning("Rejected: " + result.getStatus() + " " + result.getBody());
}With extra context:
client.validate("LICENCE-KEY-HERE", Map.of("product", "my-plugin", "host", "server-01"));Every 30 minutes, on a background thread, the client can report anonymous usage statistics (product version, OS, architecture, CPU cores, locale, Java version and platform) for your product's Analytics tab:
SunLicenseAnalytics analytics = client.analytics(licenceKey, machineId)
.productVersion("2.3.1")
.enabled(config.getBoolean("analytics", true))
.start();
// free products, no licence: SunLicense.analytics("pa_…")
analytics.close(); // on shutdownIt never blocks or fails a validation. Off when your switch says so, with SUNLICENSE_ANALYTICS=off, or with
-Dsunlicense.analytics=false. What is sent: https://docs.sunlicense.com/guide/sdks#built-in-analytics
Feature usage and bStats-style custom charts (shown on Lite and Standard plans):
analytics.feature("auto-sell");
analytics.simplePie("storage", () -> config.getString("storage"))
.singleLine("players", () -> server.getOnlinePlayers().size());Every chart type: https://docs.sunlicense.com/guide/product-analytics#feature-usage-and-custom-charts
Core unlock, tamper reports, the ownership notice and protected files
(guide). Seal part of your app at build time with the CLI
(sunlicense seal <file> --product <code> --digest '**/*.class'); it only opens after a valid license check,
so there's no check to delete. The unlock is cached for 7 days on the machine (outages) and comes with offline
.lic files too.
SunLicense client = new SunLicense.Builder()
.token(System.getenv("SUNLICENSE_API_KEY"))
.protection(SunLicenseProtection.builder().productCode("myplugin").product("My Plugin", "Acme Studios"))
.build();
SunLicenseProtection protection = client.protection();
client.validate(licenseKey, Map.of("host", machineId)); // a valid answer carries the unlock
byte[] core = protection.unseal(SEALED_CORE); // throws SunLicenseProtection.Locked without one
protection.integrity(SunLicenseProtection.codeSource(Main.class)); // OK or MODIFIED, sent with the next check
log.info(protection.notice()); // product, owner, masked key
byte[] rules = protection.protectedFile("rules.dat"); // Standard: files only valid licenses downloadJava 11 or newer. No third-party dependencies — safe to shade into a plugin without relocation conflicts.
Also available for JavaScript, Python, PHP and Lua.
- Website — https://sunlicense.com
- Documentation — https://docs.sunlicense.hapangama.com
- Issues — https://github.com/sunlicense-com/sunlicense-java/issues
MIT © Hapangama