README.md

deface

deface is an open-source runtime transformation library for the JVM, written in Kotlin and Rust.

importing

you can import deface from maven central just by adding it to your dependencies:

gradle

repositories {
    mavenCentral()
}

dependencies {
    implementation("fr.stardustenterprises:deface:0.4.0") // or latest version
}

maven

<dependency>
    <groupId>fr.stardustenterprises</groupId>
    <artifactId>deface</artifactId>
    <!-- or latest version -->
    <version>0.4.0</version> 
</dependency>

using

note: you might want to check the test sourceset

building

important: this part assumes you're using a Linux host as osxcross isn't supported yet on Windows hosts.

this project depends on the Cargo and osxcross projects.

to install cargo, install Rust on your machine via the rustup tool.

toolchains

windows & linux arm

this project requires multiple cross-compilation toolchains, which might differ depending on your distribution.

here are the required packages for ArchLinux:

sudo pacman -Sy --noconfirm \
  gcc \
  mingw-w64-gcc mingw-w64-headers \
  aarch64-linux-gnu-gcc

macOS

to create a cross-compilation toolchain for macOS, you'd need to set up osxcross by following the instructions on their GitHub repo. (or this handy chinese blog post)

actually building

you can then build the project via Gradle by running the following command:

./gradlew build

this should download the project dependencies and build the project automatically.

troubleshooting

if you ever encounter any problem related to this project, you can open an issue describing what the problem is. please, be as precise as you can, so that we can help you asap. we are most likely to close the issue if it is not related to our work.

contributing

you can contribute by forking the repository, making your changes and creating a new pull request describing what you changed, why and how.

licensing

this project is under the ISC license.