MeshCore Ninja Alpha

About

MeshCore Ninja is a community-maintained catalogue for the MeshCore ecosystem — the regional and national networks people run, the devices that join them, and the firmwares that run on them (the official build plus community forks and custom variants). Each entry carries detailed specs, and a compatibility matrix shows which firmware supports which hardware at a glance.

How it works

The catalogue is generated at build time from human-readable YAML files in the data/ folder — no database, no server. Records live in collections — networks, devices, firmwares and vendors — each a directory of records, where the directory name is the id. A build step compiles them into a single data.json the app reads (and which is published for reuse).

The one exception is live network activity — recent packets, active nodes and observers shown on some network views. That data isn't static: it's gathered and served by an optional realtime collector with its own backing store, and the site only shows it when that service is configured. Everything else works as a plain static site with no backend.

Contributing

  1. Add or edit a record in the relevant collection, e.g. data/networks/<id>/network.yaml or data/devices/<id>/device.yaml.
  2. Cross-link records by id — a device's vendorId, a firmware's devices: list, a network's radio bands, and so on.
  3. Run npm test to validate against the JSON Schema and referential checks.
  4. Open a PR.

See data/RULES.md for the authoring guide and data/SCHEMA.md for the full field reference.

View the source on GitHub Report an issue

Accuracy

Details are gathered from each project's repository and may lag behind the latest release. Corrections via PR are very welcome.

Licensing

The MeshCore Ninja database — device, firmware, network and compatibility records, schemas, and the generated exports (data.json, /devices.json and friends) — is dedicated to the public domain under CC0 1.0 Universal, so anyone can embed, sync or re-publish it without attribution. The application source code is licensed under the MIT License.

Third-party device photographs, vendor logos and trademarks remain the property of their respective owners and are not covered by the CC0 dedication. See the full licensing breakdown for details.