{"id":19573288,"url":"https://github.com/11belowstudio/mudkip_mud2","last_synced_at":"2025-02-26T11:16:00.924Z","repository":{"id":242000320,"uuid":"807653025","full_name":"11BelowStudio/MUDKIP_Mud2","owner":"11BelowStudio","description":"Multi User Dungeon Kool Informational Package for MUD2 [Mudlet package]","archived":false,"fork":false,"pushed_at":"2024-10-10T21:58:10.000Z","size":359,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-09T03:44:59.027Z","etag":null,"topics":["mud-client","mud2","mudlet","mudlet-lua","mudlet-package"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/11BelowStudio.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":"2024-05-29T14:10:16.000Z","updated_at":"2024-10-10T21:57:54.000Z","dependencies_parsed_at":"2024-06-07T16:04:45.058Z","dependency_job_id":"75cddc70-f1f9-496f-89be-1ab2ef98a85d","html_url":"https://github.com/11BelowStudio/MUDKIP_Mud2","commit_stats":null,"previous_names":["11belowstudio/mudkip_mud2"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11BelowStudio%2FMUDKIP_Mud2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11BelowStudio%2FMUDKIP_Mud2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11BelowStudio%2FMUDKIP_Mud2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/11BelowStudio%2FMUDKIP_Mud2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/11BelowStudio","download_url":"https://codeload.github.com/11BelowStudio/MUDKIP_Mud2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240840106,"owners_count":19866168,"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":["mud-client","mud2","mudlet","mudlet-lua","mudlet-package"],"created_at":"2024-11-11T06:33:09.551Z","updated_at":"2025-02-26T11:16:00.668Z","avatar_url":"https://github.com/11BelowStudio.png","language":"Lua","readme":"# MUDKIP_Mud2\n\n## Multi User Dungeon Kool Informational Package (for playing MUD2 with Mudlet)\n\n**MUDKIP** is a plucky little [Mudlet](https://www.mudlet.org) package I bodged together, which adds some Kool Informational Panels that might be of use whilst one is playing *MUD2*.\n\nIt adds some gauges at the bottom to show your current stamina and magic (assuming you have any magic) at a glance, and adds a status bar across the top with the raw stats on them (along with afflictions, the dreamword, current points, etc.)\n\nThis is a plugin for Mudlet, *not a standalone MUD client!*\nPlease ensure you have Mudlet installed and are using Mudlet.\n\nAnd, again, this is *only intended to be used for MUD2!*\nThis is very unlikely to work on any other MUD, so don't try it.\n\nalso yes, we have auto-updates (very nice)\n\n![a screenshot of MUDKIP being used in mudlet](/docs/readme.png)\n\n## Installation and Uninstallation\n\n### Installation\n\nOpen your MUD2 profile in mudlet and enter the following command:\n\n`lua installPackage(\"https://github.com/11BelowStudio/MUDKIP_Mud2/releases/latest/download/MUDKIP_Mud2.mpackage\")`\n\n### Uninstallation\n\nOpen your MUD2 profile in mudlet and enter this command:\n\n`lua uninstallPackage(\"MUDKIP_Mud2\")`\n\n(or just use mudlet's package manager menu thing to uninstall it)\n\n## Usage\n\nThe main thing *MUDKIP* does is add the status indicators mentioned above, showing:\n\n* Your stats (stamina, magic, strength, dexterity, points)\n* Current status afflictions (if any)\n* The weather\n* Time until the next reset\n* Most recent dreamword (if known)\n\nThe only automation it currently offers is sending a `fes` every so often whilst in-game (to update the stats), and an alias for saying the dreamword (if known)\n\n**MUDKIP** unfortunately does *not* offer those bells and whistles like speedwalking, fancy maps, re-fighting, etc.\n\n### Aliases\n\n* **automatic dreamword** `dword`\n  * If the dreamword is known, this will send a `say \u003cdreamword\u003e` command to the game.\n    * If the dreamword is not known, MUDKIP will leave a message\n    telling you that it doesn't know what the dreamword is.\n  * `dwo` and `dwor` are also aliases for this.\n  * There's an uppercase variant which says the dreamword in uppercase instead.\n* **fixing emotes**\n  * Tired of accidentally sending `laughs`,`smiles`,`waves` etc\n    and then having the MUD2 parser complain about it?\n  * *MUDKIP_Mud2* will correct them to `laugh`, `smile`, `wave` etc, allowing you to perform those actions in peace.\n  * Many other verbs along these lines have also been fixed.\n\n### API\n\n// TODO\n\n* Everything's contained within the global `MUDKIP_Mud2` table.\n* The stats etc with the current state of your persona are\n  in the `MUDKIP_Mud2.stats` table.\n* Misc utils are in `MUDKIP_Mud2.utils`.\n* UI stuff is held in `MUDKIP_Mud2.ui`\n* Auto-update stuff is held in `MUDKIP_Mud2.updates`\n* Stuff related to the enhanced `map` command output is in `MUDKIP_Mud2.map`\n\n## Final thoughts, how to contribute, thanks, things like that\n\n*MUDKIP* is still a bit scuffed, and some of the implementation details could use a bit of cleaning up.\nIf you do want to help out, feel free to open a PR on the `develop` branch.\n\nThis package was built using [muddler](https://github.com/demonnic/muddler), in case you were wondering.\nConsider taking a look at the documentation of muddler if you wish to contribute to the development of *MUDKIP*.\n\n## CHANGELOG\n\n* **1.3.6** (`10/10/2024`)\n  * Changed the blanked-out line placeholder to be something that MUD2 genuinely cannot comprehend (I think) but hopefully won't accidentally cause mishaps to happen\n  * (theoretically) added support for being invisible\n\nSee [CHANGELOG.md](https://github.com/11BelowStudio/MUDKIP_Mud2/blob/main/CHANGELOG.md) for the full changelog.\n\n## TODO\n\n* see what people want I guess\n* get the auto-update to check the tag on the latest release on git or something like that instead of the release version.txt(?)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F11belowstudio%2Fmudkip_mud2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F11belowstudio%2Fmudkip_mud2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F11belowstudio%2Fmudkip_mud2/lists"}