{"id":20271177,"url":"https://github.com/mjaroslav/bon2gradle","last_synced_at":"2025-03-18T15:21:29.841Z","repository":{"id":212736789,"uuid":"545030003","full_name":"MJaroslav/Bon2Gradle","owner":"MJaroslav","description":"Plugin for Minecraft Dev projects that allows use BON2 as analog of fg.deobf from ForgeGradle","archived":false,"fork":false,"pushed_at":"2024-03-17T22:39:00.000Z","size":242,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-24T19:34:56.588Z","etag":null,"topics":["bon2","deobfuscation","gradle","gradle-plugin","minecraft","minecraft-modding"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MJaroslav.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-03T16:57:34.000Z","updated_at":"2024-02-01T06:19:32.000Z","dependencies_parsed_at":"2024-11-14T12:40:37.429Z","dependency_job_id":"9f2516a8-a0b0-4ff7-b9b8-97ef662742bd","html_url":"https://github.com/MJaroslav/Bon2Gradle","commit_stats":null,"previous_names":["mjaroslav/bon2gradle"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MJaroslav%2FBon2Gradle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MJaroslav%2FBon2Gradle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MJaroslav%2FBon2Gradle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MJaroslav%2FBon2Gradle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MJaroslav","download_url":"https://codeload.github.com/MJaroslav/Bon2Gradle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244246552,"owners_count":20422459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bon2","deobfuscation","gradle","gradle-plugin","minecraft","minecraft-modding"],"created_at":"2024-11-14T12:36:55.622Z","updated_at":"2025-03-18T15:21:29.781Z","avatar_url":"https://github.com/MJaroslav.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bon2Gradle\n\nPlugin for Minecraft Dev projects that allows use BON2 as analog of `fg.deobf` from ForgeGradle.\n\n[![GitHub issues](https://img.shields.io/github/issues/MJaroslav/Bon2Gradle)](https://github.com/MJaroslav/Bon2Gradle/issues \"GitHub issues\")\n[![GitHub forks](https://img.shields.io/github/forks/MJaroslav/Bon2Gradle)](https://github.com/MJaroslav/Bon2Gradle/network \"GitHub forks\")\n[![GitHub stars](https://img.shields.io/github/stars/MJaroslav/Bon2Gradle)](https://github.com/MJaroslav/Bon2Gradle/stargazers \"GitHub stars\")\n[![GitHub license](https://img.shields.io/github/license/MJaroslav/Bon2Gradle)](https://github.com/MJaroslav/Bon2Gradle/blob/master/LICENSE \"Open license\")\n[![JitPack](https://jitpack.io/v/MJaroslav/Bon2Gradle.svg)](https://jitpack.io/#MJaroslav/Bon2Gradle \"JitPack\")\n[![JitCI status](https://jitci.com/gh/MJaroslav/Bon2Gradle/svg)](https://jitci.com/gh/MJaroslav/Bon2Gradle \"JitCI\")\n![GitHub CI test status](https://github.com/MJaroslav/Bon2Gradle/actions/workflows/ci-test.yml/badge.svg)\n\n## Usage\n\n### Dependencies\n\n- Gradle 6.8+ (minimum tested version).\n  - Tests configured for next versions: `6.8`, `6.9.4`, `7.5.1`, `7.6.4`, `8.5`.\n- Kotlin + Java 8+ (lambdas and streams).\n\n### Adding plugin to build script\n\n```groovy\nbuildscript {\n    repositories {\n        // Add JitPack.io to your build script repositories\n        maven { url 'https://jitpack.io' } \n        \n        // ForgeGradle stuff\n        maven { \n            name 'forge'\n            url 'https://maven.minecraftforge.net/'\n        }\n    }\n    dependencies {\n        // ForgeGradle (fork by anatawa12) stuff\n        classpath('com.anatawa12.forge:ForgeGradle:1.2-1.1.+') {\n            changing = true\n        }\n        \n        // Add this dependency, you can use \"master-SNAPSHOT\" as version for using last commit\n        classpath 'com.github.MJaroslav:Bon2Gradle:0.5.0'\n    }\n}\n\napply plugin: 'bon2gradle' // Applying plugin\n```\n\n### Plugin configuring\n\n```groovy\n// Extension for BON2 configuring\n// option = defaultValue // Description\nbon2 {\n    useParallelDeobfuscation = false // If dependency contains more than one file,\n    // then they will deobfuscated paralelly\n    \n    force = false // Use mappings provided by \"mappingsName\" or by \"csv\"\n    \n    mappingsName = \"\" // \"pure\" mappings name in \"{mappings_channel}_{mappings_version}-{mc_version}\" format\n    // \"pure\" has a higher priority than \"dirty\" function. Example: stable_12-1.7.10\n    \n    csv = files() // List of CSV like files of \"dirty\" mappings\n    \n    dirty = false // Force saving deobfuscated mappings in project build directory as \"dirty\"\n    \n    resolve = true // Automatically deobfuscate all created by bon2.deobf function\n    // artifacts after project evaluation\n    \n    providerClass = 'io.github.mjaroslav.bon2gradle.api.impl.FG12Provider'\n    // Just 'io.github.mjaroslav.bon2gradle.api.MappingProvider' interface realization\n    // For getting your current Minecraft Dev plugin mapping\n}\n```\n\n### Deobfuscating dependencies\n\nJust wrap dependency identifier string to `bon2.deobf` method:\n\n```groovy\nrepositories {\n    mavenCentral()\n    maven {\n        url \"https://cursemaven.com/\"\n        content {\n            includeGroup \"curse.maven\"\n        }\n    }\n}\n\ndependencies {\n    // HEE mod from cursemaven just for example\n    // All deobfuscated jars will be saved in special directory insode of project build directory.\n    implementation bon2.deobf(\"curse.maven:hardcore-ender-expansion-228015:2316923\")\n}\n\n```\n\nYou can also use Closure as second function argument for configure \"pure\" dependency.\n\n## Supported Minecraft Dev Plugins\n\n- It's written and tested with ForgeGradle-1.2 fork by anatawa12.\n- In theory, if I don't use any code of FG outside from their MappingProvider then\n  you can use it with any other plugin.\n\n## Building\n\nJust clone repository, checkout to this branch and run `./gradlew build`. It will build project with unit tests, if you\nwant to run functional tests to, run it with `CI=true` environment variable or manually run `functionalTest` task.\n\nMinimal required JDK version is `8`.\n\n## Post Scriptum\n\nFeel free to correct typos and errors in the text or code :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjaroslav%2Fbon2gradle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjaroslav%2Fbon2gradle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjaroslav%2Fbon2gradle/lists"}