{"id":19952473,"url":"https://github.com/dosmike/spongepluginversionchecker","last_synced_at":"2026-06-15T09:31:27.609Z","repository":{"id":133520597,"uuid":"201066890","full_name":"DosMike/SpongePluginVersionChecker","owner":"DosMike","description":"Minimalistinc include for fully automatic version checking agains the sponge ore repository","archived":false,"fork":false,"pushed_at":"2019-12-18T16:15:23.000Z","size":68,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-01T15:16:12.782Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/DosMike.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":"2019-08-07T14:28:41.000Z","updated_at":"2019-12-18T16:11:26.000Z","dependencies_parsed_at":"2023-07-10T00:15:28.813Z","dependency_job_id":null,"html_url":"https://github.com/DosMike/SpongePluginVersionChecker","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/DosMike/SpongePluginVersionChecker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DosMike%2FSpongePluginVersionChecker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DosMike%2FSpongePluginVersionChecker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DosMike%2FSpongePluginVersionChecker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DosMike%2FSpongePluginVersionChecker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DosMike","download_url":"https://codeload.github.com/DosMike/SpongePluginVersionChecker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DosMike%2FSpongePluginVersionChecker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34357281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-13T01:13:20.063Z","updated_at":"2026-06-15T09:31:27.484Z","avatar_url":"https://github.com/DosMike.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SpongePluginVersionChecker\nMinimalistinc include for fully automatic version checking agains the sponge ore repository\n\n# How to use\n\n## Add the dependency\n\nTo use this with gradle you should be able to just add the following to your **build.gradle**:\n```\nplugins {\n\tid 'java'\n\tid 'com.github.johnrengelman.shadow' version '5.1.0'\n}\nallprojects {\n\trepositories {\n\t\t...\n\t\tmaven { url 'https://jitpack.io' }\n\t}\n}\ndependencies {\n    shadow 'com.github.DosMike:SpongePluginVersionChecker:master-SNAPSHOT'\n}\n//from personal experience use this task to build your jar:\ntask uberJar(type:ShadowJar, group:'_Plugin', dependsOn:removeOldVersions) {\n    duplicatesStrategy = DuplicatesStrategy.EXCLUDE\n    exclude 'META-INF/**'\n    manifest {\n        attributes('Implementation-Title': project.name,\n                'Implementation-Version': project.version)\n    }\n    configurations = [project.configurations.shadow]\n    //relocate the version checker to avoid problems with different versions of versionChecker in different plugins\n    //conveniently the plugin id supports a limited character set that can be used as package name\n    relocate('de.dosmike.sponge', 'shadow.dosmike.versionchecker.'+pluginid) {\n        //don't relocate my actual plugins - yes, includes are paths!\n        include \"de/dosmike/sponge/VersionChecker\"\n        include \"de/dosmike/sponge/VersionChecker\\$Version\"\n    }\n    from(sourceSets.main.resources)\n    from(sourceSets.main.output) //.output would not capture mcmod.info for me\n    classifier = null\n}\n\n//if you want your plugin to be jitpack-able, you'll have to add the shadow jar as artifact:\nartifacts {\n    archives uberJar\n\t...\n}\n```\n\n## Usage example\n\nOnce the dependency is added you just need to call one method.\nIt's recommended to call this method after all plugins are loaded by Spoge.\nThis method checks if the specified config allows version checking. If so, it performs version check on the provided executor.\n\n`VersionChecker.conformAuto(instance:Object, configDir:Path, configName:String)`\n\n**instance**: the plugin instance to check for updates, usually `this`   \n**configDir**: where to search for the configuration (private plugin directory is recommended)   \n**configName**: the name of the config file, if configDir is the public config dir it's recommended to start the filename with the plugin id   \n\nAlternatively you can use\n`VersionChecker.setVersionCheckingEnabled(pluginId:String, allowVersionChecking:boolean);`\nfollowed by\n`VersionChecker.checkVersion(instance:Object)` or\n`VersionChecker.checkPluginVersion(container:PluginContainer)`\n\n**pluginId**: This should be your plugin id  \n**allowVersionChecking**: `true` if version checking is allowed. *To follow Ore Guidelines, this value may **ONLY** be set true from a config node like `node.getBoolean(false)`*  \n**instance**: Your plugin instance  \n**container**: Your plugin container\n\n## Debgging\n\nIf the property VerboseVersionChecker is set to true VersionChecker will print additional information to\nthe console.\n\n# License\n\nMIT licensed, see the LICENSE file.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdosmike%2Fspongepluginversionchecker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdosmike%2Fspongepluginversionchecker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdosmike%2Fspongepluginversionchecker/lists"}