{"id":20260694,"url":"https://github.com/gesslar/explorer","last_synced_at":"2026-05-08T22:04:38.380Z","repository":{"id":259458714,"uuid":"859569147","full_name":"gesslar/Explorer","owner":"gesslar","description":"Developer's Automapping tool for Mudlet","archived":false,"fork":false,"pushed_at":"2024-11-22T06:25:49.000Z","size":69,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-14T04:21:19.656Z","etag":null,"topics":["mudlet","mudlet-mapper-script","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":"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":"LICENSE.txt","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-09-18T22:25:09.000Z","updated_at":"2024-11-22T06:25:50.000Z","dependencies_parsed_at":"2024-10-25T16:58:49.627Z","dependency_job_id":"f29f13e0-b589-43c9-8f3f-bb7837c09bbe","html_url":"https://github.com/gesslar/Explorer","commit_stats":null,"previous_names":["gesslar/explorer"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2FExplorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2FExplorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2FExplorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesslar%2FExplorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gesslar","download_url":"https://codeload.github.com/gesslar/Explorer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241721473,"owners_count":20009177,"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":["mudlet","mudlet-mapper-script","mudlet-package"],"created_at":"2024-11-14T11:21:40.178Z","updated_at":"2025-12-01T01:04:45.093Z","avatar_url":"https://github.com/gesslar.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Explorer\n\nDeveloper's Automapping tool for Mudlet\n\n## Description\n\nThis package is intended for use by developers who are looking to automatically\nexplore their game world. It is not intended for use by players, as it will\nautomatically move your character around the game world, and as well, it\nmay contravene the rules of your game.\n\n## Configuration\n\nIn Mudlet, type `explore` to see the help information for this package.\n\n* `explore start` - Start exploring\n* `explore stop` - Stop exploring\n* `explore set` - See your current preference settings\n* `explore set \u003cpreference\u003e \u003cvalue\u003e` - Set a preference to a value\n\n  Available preferences:\n  * `shuffle` - Set the maximum number of steps to take before selecting a\n     random exit stub to explore (default: 0). If set to 0, Explorer will not\n     shuffle.\n  * `zoom` - Set the zoom level of the map during exploration (default:\n    10)\n\n## Events\n\n### Listening\n\nThis package listens to the following events in order to function. You will\nneed to ensure that these events are passed along with the required arguments\n(if any).\n\n#### `onMoveMap`\n\nTrigger this event when the player has moved to a new room. Explorer sets a\ntimer to check if the player has moved to a new room. When this event is\ntriggered, it confirms that the player has moved to a new room and will then\nproceed to explore a new room.\n\n##### Arguments\n\n* `current room id` - The id of the room the player has arrived in.\n\n#### `sysSpeedwalkFinished`\n\nTrigger this event when the speedwalk system has finished. The package listens\nfor this event to understand that speedwalking has completed and that it can\nnow schedule other activities.\n\n##### Arguments\n\nNone\n\n### Raising\n\nThe following events are raised by this package:\n\n#### `onExplorationStarted`\n\nThis event is raised when exploration has begun.\n\n##### Arguments\n\nNone\n\n#### `onExplorationStopped`\n\nThis event is raised when exploration has stopped.\n\n##### Arguments\n\n* `canceled` - Boolean indicating if the exploration was canceled.\n* `silent` - Boolean indicating that no messages should be printed.\n\n#### `onDetermineNextRoom`\n\nThis event is raised when the next room to explore is being determined.\n\n##### Arguments\n\n* `room_id` - The id of the room the player is currently in.\n* `area_id` - The id of the area the player is currently in.\n\n#### `onNextRoomDetermined`\n\nThis event is raised when the next room to explore has been determined.\n\n##### Arguments\n\n* `room_id` - The id of the next room to explore.\n* `area_id` - The id of the area the next room to explore is in.\n\n#### `onExploreDirection`\n\nThis event is raised when the explorer is about to explore a new direction. It\nfollows after `onNextRoomDetermined`, if the next room to explore is in the\nsame area and is adjacent to the current room.\n\n##### Arguments\n\n* `room_id` - The id of the room the explorer is currently in.\n* `direction` - The direction the explorer is about to explore.\n* `stub` - The exit stub of the room the explorer is about to explore.\n\n#### `onDirectionExplored`\n\nThis event is raised when the player has moved into a new room following a\ndirection exploration.\n\n##### Arguments\n\n* `room_id` - The id of the room the explorer has arrived in.\n* `direction` - The direction that was explored.\n\n#### `onStubIgnored`\n\nThis event is raised when an exit stub is ignored.\n\n##### Arguments\n\n* `room_id` - The id of the room the stub is in.\n* `stub` - The stub that was ignored.\n* `direction` - The direction of the stub that was ignored.\n\n## Dependencies\n\nThe following packages are required and will be automatically installed if they\nare missing:\n\n* [Helper](https://github.com/gesslar/Helper)\n\n### Support\n\nWhile there is no official support and this is a hobby project, you are welcome\nto report issues on the [GitHub repo](https://github.com/gesslar/Explorer).\n\n## Credits\n\n[Compass icons created by Dimitry Miroliubov - Flaticon](https://www.flaticon.com/free-icons/compass)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesslar%2Fexplorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgesslar%2Fexplorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesslar%2Fexplorer/lists"}