{"id":20260725,"url":"https://github.com/gesslar/mupdate","last_synced_at":"2026-02-15T05:04:18.748Z","repository":{"id":245524895,"uuid":"818516511","full_name":"gesslar/mupdate","owner":"gesslar","description":"Mudlet Package Self-Updater","archived":false,"fork":false,"pushed_at":"2025-11-21T00:20:15.000Z","size":2394,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-13T20:41:33.247Z","etag":null,"topics":["mudlet","mudlet-lua"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gesslar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2024-06-22T03:56:44.000Z","updated_at":"2025-11-21T00:20:19.000Z","dependencies_parsed_at":"2024-07-05T22:20:55.540Z","dependency_job_id":"6c3b6084-1e8d-45ca-8792-c70599c3d414","html_url":"https://github.com/gesslar/mupdate","commit_stats":null,"previous_names":["gesslar/mupdate"],"tags_count":77,"template":false,"template_full_name":null,"purl":"pkg:github/gesslar/mupdate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2Fmupdate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2Fmupdate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2Fmupdate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2Fmupdate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gesslar","download_url":"https://codeload.github.com/gesslar/mupdate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2Fmupdate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29469919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T04:35:06.950Z","status":"ssl_error","status_checked_at":"2026-02-15T04:33:41.357Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["mudlet","mudlet-lua"],"created_at":"2024-11-14T11:21:50.686Z","updated_at":"2026-02-15T05:04:18.736Z","avatar_url":"https://github.com/gesslar.png","language":"Lua","readme":"# Mupdate Auto-Updater Module\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5126e0c20c7c454a9f04ed8e5a817976)](https://app.codacy.com/gh/gesslar/mupdate/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n\n## Description\n\nThis module provides an auto-updater for packages within the MUD client,\n[Mudlet](https://github.com/Mudlet/Mudlet/). It automates the process of\nchecking for new versions of a package, downloading updates, and installing\nthem.\n\n## Acknowledgements\n\nThis module was essentially ripped off from the [MUDKIP_Mud2](https://github.com/11BelowStudio/MUDKIP_Mud2)\npackage from [@11BelowStudio](https://github.com/11BelowStudio/), and\nrefactored.\n\n### Original acknowledgements on the MUDKIP_Mud2 package\n\nThe core functionality of this auto-updater was adapted from the DSL PNP 4.0\nMain Script by Zachary Hiland, originally shared on the\n[Mudlet forums](https://forums.mudlet.org/viewtopic.php?p=20504).\n\nSpecial thanks to [@demonnic](https://github.com/demonnic/) for providing\nadditional Lua code and guidance on package installation.\n\n![Demo GIF](resources/demo.gif)\n\n## Instructions for Use\n\n### 1. Placement\n\n- **Using [Muddler](https://github.com/demonnic/muddler):** Put the\n  `Mupdate.lua` file in your project's resources directory.\n- **Developing Directly in Mudlet:** Add the `Mupdate.lua` file to your Mudlet\n  package's Script Group within Mudlet, and ensure that it is higher than the\n  script that will be calling it.\n\n### 2. Integration\n\nIn your package script, require the Mupdate module and instantiate it with the\nnecessary options.\n\n### Variables\n\n- `downloadPath`: The URL path where the package files are hosted.\n- `packageName`: The name of your package.\n- `remoteVersionFile`: The file name of the version check file on the server.\n  File should be named `PACKAGE_NAME_version.txt`\n- `paramKey`: (Optional) The key of the URL parameter to check for the file\n  name.\n- `paramRegex`: (Optional) The regex pattern to extract the file name from the\n  URL parameter value.\n- `debugMode`: (Optional) Boolean flag to enable or disable debug mode for\n  detailed logging. Defaults to `false`.\n\n#### Example Implementation\n\nAn example implementation is provided in this repository called `Updater.lua`.\n\n### Version Comparison\n\n- Mupdate calls `getPackageInfo(packageName)` to get your package's version\n  number. Which must be in the SemVer format. So, this must be set on your\n  package.\n- Mupdate downloads the version file from the same location that hosts your\n  `.mpackage` file, and its contents must simply contain the updated version in\n  the SemVer format.\n\n### Semantic Versioning\n\nThe Mupdate system requires the use of semantic versioning (SemVer) for package\nversion numbers. Semantic versioning follows the format `MAJOR.MINOR.PATCH`,\nwhere:\n\n- `MAJOR` version increments indicate incompatible API changes,\n- `MINOR` version increments add functionality in a backward-compatible manner, and\n- `PATCH` version increments include backward-compatible bug fixes.\n\n#### Example\n\n- `1.0.0` -\u003e Initial release\n- `1.1.0` -\u003e New feature added\n- `1.1.1` -\u003e Bug fix\n- `2.0.0` -\u003e Breaking change introduced\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesslar%2Fmupdate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgesslar%2Fmupdate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesslar%2Fmupdate/lists"}