{"id":19040178,"url":"https://github.com/meteordevelopment/meteor-addon-template","last_synced_at":"2025-04-13T07:51:58.133Z","repository":{"id":37987734,"uuid":"340478813","full_name":"MeteorDevelopment/meteor-addon-template","owner":"MeteorDevelopment","description":"A template project to help people use the Meteor Client Addon API.","archived":false,"fork":false,"pushed_at":"2025-04-02T19:29:38.000Z","size":443,"stargazers_count":109,"open_issues_count":6,"forks_count":109,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-04T07:24:13.086Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MeteorDevelopment.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-19T20:13:10.000Z","updated_at":"2025-04-02T19:28:07.000Z","dependencies_parsed_at":"2023-12-15T20:32:26.143Z","dependency_job_id":"cff38a74-b431-4838-ae5f-4c011f9ff30b","html_url":"https://github.com/MeteorDevelopment/meteor-addon-template","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorDevelopment%2Fmeteor-addon-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorDevelopment%2Fmeteor-addon-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorDevelopment%2Fmeteor-addon-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MeteorDevelopment%2Fmeteor-addon-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MeteorDevelopment","download_url":"https://codeload.github.com/MeteorDevelopment/meteor-addon-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681493,"owners_count":21144700,"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":[],"created_at":"2024-11-08T22:20:58.622Z","updated_at":"2025-04-13T07:51:58.102Z","avatar_url":"https://github.com/MeteorDevelopment.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Meteor Addon Template\n\nA template to allow easy usage of the Meteor Addon API.\n\n### How to use\n\n- Clone this project\n- Use this template to create new modules/commands\n- Build the executable using the gradle `build` task.\n- Run the mod with Meteor.\n\n### Project structure\n\n```text\n.\n│── .github\n│   ╰── workflows\n│       │── dev_build.yml\n│       ╰── pull_request.yml\n│── gradle\n│   ╰── wrapper\n│       │── gradle-wrapper.jar\n│       ╰── gradle-wrapper.properties\n│── src\n│   ╰── main\n│       │── java\n│       │   ╰── com\n│       │       ╰── example\n│       │           ╰── addon\n│       │               │── commands\n│       │               │   ╰── CommandExample\n│       │               │── hud\n│       │               │   ╰── HudExample\n│       │               │── modules\n│       │               │   ╰── ModuleExample\n│       │               ╰── AddonTemplate\n│       ╰── resources\n│           │── assets\n│           │   ╰── template\n│           │       ╰── icon.png\n│           │── addon-template.mixins.json\n│           ╰── fabric.mod.json\n│── .editorconfig\n│── .gitignore\n│── build.gradle\n│── gradle.properties\n│── gradlew\n│── gradlew.bat\n│── LICENSE\n│── README.md\n╰── settings.gradle\n```\n\nThis is the default project structure. Each folder/file has a specific purpose.  \nHere is a brief explanation of the ones you might need to modify:\n\n- `.github/workflows`: Contains the GitHub Actions configuration files.\n- `gradle`: Contains the Gradle wrapper files.  \n  Edit the `gradle.properties` file to change the version of the Gradle wrapper.\n- `src/main/java/com/example/addon`: Contains the main class of the addon.  \n  Here you can register your custom commands, modules, and HUDs.  \n  Edit the `getPackage` method to reflect the package of your addon.\n- `src/main/resources`: Contains the resources of the addon.\n    - `assets`: Contains the assets of the addon.  \n      You can add your own assets here, separated in subfolders.\n        - `template`: Contains the assets of the template.  \n          You can replace the `icon.png` file with your own addon icon.  \n          Also, rename this folder to reflect the name of your addon.\n    - `addon-template.mixins.json`: Contains the Mixin configuration for the addon.  \n      You can add your own mixins in the `client` array.\n    - `fabric.mod.json`: Contains the metadata of the addon.  \n      Edit the various fields to reflect the metadata of your addon.\n- `build.gradle.kts`: Contains the Gradle build script.  \n  You can manage the dependencies of the addon here.  \n  Remember to keep the `fabric-loom` version up-to-date.\n- `gradle.properties.kts`: Contains the properties of the Gradle build.  \n  These will be used by the build script.\n- `LICENSE`: Contains the license of the addon.  \n  You can edit this file to change the license of your addon.\n- `README.md`: Contains the documentation of the addon.  \n  You can edit this file to reflect the documentation of your addon, and showcase its features.\n\n## License\n\nThis template is available under the CC0 license. Feel free to use it for your own projects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeteordevelopment%2Fmeteor-addon-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeteordevelopment%2Fmeteor-addon-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeteordevelopment%2Fmeteor-addon-template/lists"}