crowdmap service

A shared map, built from small reports

The crowdmap service lets players improve a Mudlet map without needing to use Git or prepare a pull request. The IRE Mapping Script reports one observed change at a time; the service combines matching reports into a map that everyone can download.

How a report becomes part of the map

  1. Start with a baseline. Each map project has a published Mudlet map.
  2. Report what you observe. A mapping client can submit a new room or area, a changed name, exit, door, coordinate, weight, environment, label, or room/map-data value.
  3. Confirm independently. Identical reports are grouped. The service counts distinct reporter values, not repeated submissions from one reporter.
  4. Choose your confidence level. The Explorer’s “Changes reported by” control selects how many independent reports a change needs before it is included in the map you view.
  5. Maintain the baseline. A map administrator reviews pending reports when an upstream map update is available and decides which compatible reports carry forward.

What players can do

Connect a mapping script

A mapping script needs the project’s HTTPS address, a stable reporter pseudonym, and a confirmation threshold. Configure it against the project host, not the platform’s project-picker host. For example, if the explorer is at https://achaea.maps.example.org/, use that same origin for the following endpoints.

Download a map
GET /map?format=binary&timesSeen=2&reporter=river-scout
Check its version
GET /map/version?timesSeen=2&reporter=river-scout
Submit an observation
POST /change with a JSON change object including type and reporter

Use the same non-negative integer and reporter pseudonym for timesSeen and reporter when checking the version and downloading the map. 0 includes every pending report; a higher value includes only reports confirmed by that many distinct people, plus reports made with the supplied pseudonym. The response does not reveal reporter values. The response to a map download also includes an X-Map-Version header.

The IRE Mapping Script handles these requests for you. Other mapping clients and adapters can use the endpoints above directly. The interactive API reference documents the accepted change shapes.

Open the API reference

Set up the IRE Mapping Script

Install or update the IRE Mapping Script, then select the live service map in Mudlet:

mconfig mapsource service
mconfig crowdmapservicesend on
mconfig gmcpmapupdates on

The service URL defaults to https://<game>.mudmaps.community, using the connected game's subdomain (for example, https://achaea.mudmaps.community). You only need mconfig crowdmapserviceurl https://your-project-host when using a different service. The script waits for the character name supplied by the game and uses it as the reporter value; there is no separate reporter setting.

mapsource
Choose game (the default), published (the established community release), or service (the live map assembled from reports).
crowdmapservicereports
Set the number of independent reports required to include another mapper's change. The default is 2; 0 includes reports immediately. Your own reports are always included. For example: mconfig crowdmapservicereports 3.
crowdmapservicesend
Send supported local map changes as reports. This is off by default; enable it with mconfig crowdmapservicesend on to help confirm changes for other players.
gmcpmapupdates
Apply safe GMCP room information to existing rooms even outside mapping mode. This is off by default; enabling it lets ordinary play contribute room updates when service sending is on.

The script checks the map version and downloads a new map when needed. Local mapping changes still work if the service cannot be reached; failed reports are retried, and the script warns before a later download could overwrite unsent edits. Private room marks and temporary exits remain local.

For map administrators

Open Review on a project host to inspect pending reports, compare an incoming upstream map, and apply the reviewed result. This final action requires a map-administrator API key and rechecks the baseline version before changing it.