{"id":19513786,"url":"https://github.com/kasukusakura/jvmhookframework","last_synced_at":"2025-04-26T05:32:08.312Z","repository":{"id":57733789,"uuid":"380416710","full_name":"KasukuSakura/JvmHookFramework","owner":"KasukuSakura","description":"[WIP] Framework for jvm hooking","archived":false,"fork":false,"pushed_at":"2021-07-14T12:53:29.000Z","size":314,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T08:11:37.657Z","etag":null,"topics":["framework","hook","hooks-api","java","jvm"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KasukuSakura.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-26T04:56:31.000Z","updated_at":"2022-09-19T11:55:58.000Z","dependencies_parsed_at":"2022-08-24T11:20:23.734Z","dependency_job_id":null,"html_url":"https://github.com/KasukuSakura/JvmHookFramework","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KasukuSakura%2FJvmHookFramework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KasukuSakura%2FJvmHookFramework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KasukuSakura%2FJvmHookFramework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KasukuSakura%2FJvmHookFramework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KasukuSakura","download_url":"https://codeload.github.com/KasukuSakura/JvmHookFramework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250937229,"owners_count":21510923,"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":["framework","hook","hooks-api","java","jvm"],"created_at":"2024-11-10T23:32:48.917Z","updated_at":"2025-04-26T05:32:07.395Z","avatar_url":"https://github.com/KasukuSakura.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jvm Hook Framework\n\n[简体中文](README.zh.md)\n\n----\n\n# Desc\n\n`JVM Hook Framework` is designed for injecting java classes with friendly apis using `SpongePowered/mixin`\n\n[![Maven Central](https://img.shields.io/maven-central/v/io.github.karlatemp.jhf/api.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:io.github.karlatemp.jhf)\n\n# Using\n\nYou need add `Maven Central` and `https://repo.spongepowered.org/repository/maven-public/` into your repositories.\n\n```groovy\nplugins {\n    id 'java-library'\n}\n\nrepositories {\n    mavenCentral()\n    maven { url = 'https://repo.spongepowered.org/repository/maven-public/' }\n    maven { url = 'https://files.minecraftforge.net/maven/' }\n}\n\ndependencies {\n    api 'io.github.karlatemp.jhf:api:\u003cversion\u003e'\n}\n```\n\n## Developing a plugin\n\n### Project setup\n\n- Create a new class named `myjhfplugin.Startup` (or other you like)\n- Create a new file in project resources named `jhf-main.txt`\n- Write `myjhfplugin.Start` in `jhf-main.txt`\n- Add a **static** method in `myjhfplugin.Startup` named **launch** with **no parameter** and **void return type**\n  \u003e `private static void launch() throws Throwable {}`\n\n### Using mixin\n\nYou need create a class module of class you want to inject.\n\n```java\nimport org.spongepowered.asm.mixin.Mixin;\nimport org.spongepowered.asm.mixin.Overwrite;\n\n@Mixin(targets = \"testunit.RunTester\")\npublic class MixinRunTester {\n    @Overwrite\n    public static void error() {\n    }\n}\n```\n\nThen, you need create a mixin configuration file in your project resources. Suggested path format\nis `${project-name}/mixin/${config-name}.json`\n\n```json5\n{\n  \"minVersion\": 0,\n  \"package\": \"tester.mixin\",\n  // The package storing mixin classes\n  \"mixins\": [\n    \"MixinRunTester\"\n  ],\n  // Class name that relative to ${package}\n  \"client\": [],\n  // no effect\n  \"server\": []\n  // no effect\n}\n```\n\nIn your `Plugin Main Point` add following code\n\n```java\npublic class MainPlugin {\n    private static void launch() throws Throwable {\n        Mixins.addConfiguration(\"myplugin/mixin/main.json\");\n    }\n}\n\n```\n\n\u003e Example: [MixinRunTester](tester/src/main/java/tester/mixin/MixinRunTester.java)\n\n## Listen `JavaLangReflectInvokeEvent`\n\n`JavaLangReflectInvokeEvent` will broadcast when application invoking reflection of `java.lang.reflect`.\n\n```java\nJavaLangReflectInvokeEvent.EVENT_LINE.register(EventPriority.NORMAL,event-\u003e {\n    if (event.target instanceof Method) {\n        if (event.target.getDeclaringClass().getName().endsWith(\"EskPermissionDenied\")) {\n            throw new IllegalAccessException(\"Permission Denied\");\n        }\n    }\n});\n```\n\n## Modify bytecodes\n\nWhen a new class before loading, a `TransformBytecodeEvent` will broadcast to event-pipeline.\n\nListen and modify `TransformBytecodeEvent.bytecode` to change bytecode with the lowest way.\n\n## Find an example\n\nThe folder `tester` is a plugin for `JvmHookFramework Testing`. You can refer to it to write your own plugin.\n\n## Plugin configuration\n\nJHF using `SpongePowered/Configuration` to manage configurations. Using it by\n\n```java\npublic class Main {\n    public static final File DATA_FOLDER = JvmHookFramework.getInstance().getDataFolder(\"my-plugin\");\n    public static final HoconConfigurationLoader LOADER = JvmHookFramework.getInstance().newConfigLoader(\n            ConfigurationOptions.defaults()\n                    .shouldCopyDefaults(true)\n            ,\n            new File(DATA_FOLDER).toPath()\n    );\n}\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkasukusakura%2Fjvmhookframework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkasukusakura%2Fjvmhookframework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkasukusakura%2Fjvmhookframework/lists"}