Crowdmap service

A shared map, built from small reports

Crowdmap lets players improve a Mudlet map without needing to use Git or prepare a pull request. A compatible mapping client 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
Check its version
GET /map/version?timesSeen=2
Submit an observation
POST /change with a JSON change object including type and reporter

Use the same non-negative integer for timesSeen 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. The response to a map download also includes an X-Map-Version header.

The stock IRE Mapping Script’s mconfig crowdmap on setting selects its built-in crowdmap sources; it does not currently provide a Crowdmap-service URL setting. Point a service-compatible script or adapter at the endpoints above. The interactive API reference documents the accepted change shapes.

Open the API reference

Preview documentation

Planned IRE Mapping Script setup

This is the proposed configuration interface for the Crowdmap-service integration. It is published early so map operators and script users can prepare their settings. These commands are not available in the released IRE Mapping Script yet; their names and behaviour may change before release.

mconfig crowdmapurl https://achaea.maps.example.org
mconfig crowdmapreporter river-scout
mconfig crowdmapthreshold 2
mconfig crowdmap on
crowdmapurl
The project’s HTTPS origin, with no endpoint path. Do not use the shared platform/project-picker host.
crowdmapreporter
A stable pseudonym used to count independent confirmations. Choose one that is not personal information.
crowdmapthreshold
The non-negative confirmation threshold used for both the version check and map download. Start with 2 for a cautious map.
crowdmap
Turns Crowdmap downloads on after the URL and settings have been saved.

On startup and periodic update checks, the planned integration will request /map/version first. If the version differs from the locally installed map, it will download the matching binary map from /map. Mapping actions will continue to work if the service is temporarily unreachable; only the update or report will be retried later.

Reports are intended to be sent automatically for changes the script can identify reliably, such as room names, exits, areas, coordinates, and selected room metadata. Before enabling reporting in a preview build, review its release notes for the final opt-in command and the supported change types.

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.