A Lightweight Qimen Dunjia Chart Generation Library

Introduction

An open-source library for generating Qimen Dunjia charts, featuring the following capabilities:

Input
- Chart Layout Time (supports both Date objects and date strings)
- Optional Parameters
  - solarTerm: Specifies the solar term
  - isYangdun: Specifies Yang or Yin Dun
  - juNumber: Specifies the Ju number.
  - yearDivide: Year boundary calculation method ('normal' | 'exact')
The following features are supported:
- Qimen Dunjia’s 9-Palace chart data (including deities, stars, doors, heavenly stems on the movable disc, and earthly stems on the fixed disc)
- Complete time information (Four Pillars, solar terms, Xun Shou, Kong Wang, etc.)
- Chart information (Yin/Yang Dun, chart number, Yuan)
- Palace analysis (Ji Xing, Men Po, Ru Mu, etc.)
- Star and Door strength/weakness
- Common Auspicious and Inauspicious Pattern Judgments
- Hidden Stem Information
- Multi-language Support (zh-CN, zh-TW, en-US)

Command Line Interface (CLI)

3meta provides a convenient CLI tool qimen that supports generating chart data in JSON format with multi-language support.

npm run build
node bin/qimen.js --date 2023-12-01T12:00:00 --lang en-US

Supported arguments:

--date: Date time (ISO)
--lang: Language (zh-CN, zh-TW, en-US)
--solarTerm: Specify solar term
And more (Check node bin/qimen.js --help)

Quick Navigation

Direct Usage

If you want to view the 3meta chart layout results with zero development effort, simply use the online chart layout tool: 3meta.pub.

Multi-Chart Collaborative Analysis
Supports streaming interaction with AI
Support copying in AI format
Save the chart as a Markdown note
Support keyboard shortcuts
Support DeepSeek V3、DeepSeek R1、Gemini Fast、Gemini Pro Model
And more

Using in Projects

Installing from npm (Recommended)

npm install 3meta

Installing from Github

npm install git+https://github.com/3metaJun/3meta.git

Or Installing Locally

npm install /path/to/3meta

Standalone JavaScript library

If you are using a static HTML file, you can download library file from the release.

v2.0.0+ version provide。

usage example:

<script src="3meta.min.js"></script>
<script>
    // Switch to English
    ThreeMeta.i18n.setLocale('en-US');

    const chart = ThreeMeta.QimenChart.byDatetime('2023-12-01 12:00:00');

    // Use formatters to output pattern descriptions
    chart.palaces.forEach(p => {
        p.auspiciousPatterns.forEach(pat => {
            console.log(ThreeMeta.formatPattern(pat));
        });
    });
</script>
</html>

Usage Instructions

Calling `3meta` to generate a Qimen Dunjia chart is extremely simple—you’ll obtain all required information with just the steps outlined below.

import { QimenChart } from '3meta';

// 使用默认配置排盘
const chart = QimenChart.byDatetime('2023-12-01 12:00:00');

// 或者自定义参数
const customChart = QimenChart.byDatetime('2023-12-01 12:00:00', {
  solarTerm: '冬至',
  isYangdun: true,
  juNumber: 1,
  yearDivide: 'exact'
});

console.log(chart);

Multi-language Support (i18n)

You can easily switch languages and format output using the i18n object:

import { QimenChart, i18n, formatPattern } from '3meta';

// Set language to English
i18n.setLocale('en-US');

const chart = QimenChart.byDatetime('2023-12-01 12:00:00');

// Format pattern descriptions
chart.palaces.forEach(p => {
  p.auspiciousPatterns.forEach(pat => {
    console.log(formatPattern(pat)); // Outputs English descriptions
  });
});

// Translate specific terms manually
console.log(i18n.t('stems.甲')); // "Jia"

Summary

Using the data returned by this program, you can generate a complete Qimen Dunjia chart. This project handles the most tedious and time-consuming work for you, allowing you to focus your attention on what truly matters.

版权

MIT License

[!NOTE] Please use this open-source code responsibly and strictly prohibit its use for any illegal purposes.

FilesExpand file tree

README-en_US.md

Latest commit

History