About Quyuan

Quyuan is a GeoJSON template engine with an integrated multimedia viewer. It processes GeoJSON features through Nunjucks templates to generate marker icons and popup HTML, and provides Web Components (qy-swiper / qy-swiper-slide / qy-viewer) for displaying images, panoramas, and videos inside popups. The project is named after Qu Yuan (屈原), a Chinese poet and politician from the 4th century BC.

Quyuan is open-source under the MIT License.

Read this document in Japanese / 日本語で読む

Key Features

• GeoJSON template engine using Nunjucks syntax (per-feature processing)
• Multiple template keys (marker icons, popup HTML, etc.) with results stored in each feature
• Web Components-based multimedia viewer (qy-swiper / qy-swiper-slide / qy-viewer)
• Supported media: images, 360-degree panoramas, YouTube videos, MP4 videos, 3D models (MTL), Gaussian Splatting
• Works with Leaflet, OpenLayers, and MapLibre GL (integration examples in docs/api/)

Quick Start

Release-dependent information (ADR-0012). The version 0.4.1 below is the current release; update it on each new release.

Install

# pnpm (recommended)
pnpm add @c4h/quyuan

# npm
npm install @c4h/quyuan

Minimal usage

import { Quyuan } from '@c4h/quyuan';

const geojson = {
  type: "FeatureCollection",
  features: [{
    type: "Feature",
    properties: {
      name: "Sample Location",
      type: "cultural",
      images: [
        { path: "image1.jpg", type: "image", description: "Sample image" },
        { path: "pano1.jpg", type: "panorama", description: "360-degree image" }
      ]
    },
    geometry: { type: "Point", coordinates: [139.7, 35.6] }
  }]
};

const templates = {
  icon: "{% if type == 'cultural' %}cultural.png{% else %}default.png{% endif %}",
  html: `
    <div class="popup-content">
      <h3>{{ name }}</h3>
      <qy-swiper style="height:200px;">
        {% for image in images %}
          <qy-swiper-slide
            image-url="{{ image.path }}"
            image-type="{{ image.type }}"
            caption="{{ image.description }}">
          </qy-swiper-slide>
        {% endfor %}
      </qy-swiper>
    </div>
  `
};

const result = Quyuan.templateExtractor({ geojson, templates });
// Processing results are stored in each feature's result object

CDN (jsDelivr)

<script src="https://cdn.jsdelivr.net/npm/@c4h/[email protected]/dist/quyuan.umd.js"></script>

API reference

• API signatures (release-dependent): see docs/api/

Development

Setup

Clone the repository and install dependencies.

git clone https://github.com/code4history/Quyuan.git
cd Quyuan
pnpm install

Development Server

pnpm run dev

Demo: https://code4history.dev/Quyuan/

Build

pnpm run build

Test

pnpm test           # Run tests
pnpm run test:e2e   # Run E2E tests

Prerequisites

Runtime requirements (ADR-0012: release-dependent).

• Node.js and pnpm (for development)
• Browser: Chrome / Edge / Firefox / Safari (latest) — requires Web Components support

Ecosystem

Quyuan is part of the Maplat ecosystem by Code for History. See the full ecosystem map (8 repositories + product/corporate sites):

📖 Ecosystem Map — (the diagram is currently kept in a private planning repository; the Sister repositories table below is the public substitute)

Sister repositories

| Repository | License | npm | Role | |---|---|---|---| | Maplat | Apache 2.0 | @maplat/ui | Main viewer | | MaplatCore | Apache 2.0 | @maplat/core | Core library | | MaplatTin | Apache 2.0 | @maplat/tin | TIN conversion | | MaplatTransform | Apache 2.0 | @maplat/transform | Coordinate transform | | MaplatEditor | Apache 2.0 | — | Data authoring tool (desktop) |

MaplatEditor is the data authoring tool used to create the maps and POIs that the viewers above render. The Maplat ecosystem is end-to-end: author with MaplatEditor, serve with any of the viewer libraries.

License

MIT License — see LICENSE.

Copyright (c) 2021-2026 Code for History

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Contributors

• Kohei Otsuka (@kochizufan)
• Code for History

Contributing

• Report bugs or request features in Issues
• Pull requests are welcome
• Questions and discussions in Discussions

How to Contribute

1. Fork this repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a Pull Request