iztro
Version:
轻量级紫微斗数星盘生成库。可以通过出生年月日获取到紫微斗数星盘信息、生肖、星座等信息。This is a lightweight kit for generating astrolabes for Zi Wei Dou Shu (The Purple Star Astrology), an ancient Chinese astrology. It allows you to obtain your horoscope and personality analysis.
237 lines (162 loc) • 10.1 kB
Markdown
<div align="center">
# 壹套輕量級紫微鬥數排盤工具庫
[简体中文](./README.md) 🔸 繁體中文 🔸 [English](./README-en_US.md)
</div>
<div align="center">
[](https://www.npmjs.com/package/iztro)
[](https://www.npmjs.com/package/iztro)
[](https://www.npmjs.com/package/iztro)
[](https://www.jsdelivr.com/package/npm/iztro)
[](https://github.com/SylarLong/iztro)
[](https://github.com/SylarLong/iztro/actions/workflows/Codecov.yaml)
[](https://github.com/SylarLong/iztro/actions/workflows/Codecov.yaml)
[](https://codeclimate.com/github/SylarLong/iztro/maintainability)
[](https://packagequality.com/#?package=iztro)
[](https://www.npmjs.com/package/iztro)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FSylarLong%2Fiztro?ref=badge_shield)
</div>
## 介紹
用於紫微鬥數排盤的 JavaScript 開源庫，有以下功能：
- 輸入
- 生日（陽歷或農歷皆可）
- 出生時間
- 性別
- 可以實現下列功能
- 紫微鬥數 12 宮的星盤數據
- 獲取生肖
- 獲取星座
- 獲取四柱（幹支紀年法的生辰）
- 獲取運限（大限、小限、流年、流月、流日、流時）的數據
- 獲取流耀（大限和流年的動態星耀）
- 判斷指定宮位是否存在某些星耀
- 判斷指定宮位三方四正是否存在某些星耀
- 判斷指定宮位三方四正是否存在四化
- 判斷指定星耀是否存在四化
- 判斷指定星耀三方四正是否存在四化
- 判斷指定星耀是否是某個亮度
- 根據天幹獲取四化
- 獲取指定星耀所在宮位
- 獲取指定宮位三方四正宮位
- 獲取指定星耀三方四正宮位
- 獲取指定星耀對宮
- 獲取指定運限宮位
- 獲取指定運限宮位的三方四正
- 判斷指定運限宮位內是否存在某些星耀
- 判斷指定運限宮位內是否存在四化
- 判斷指定運限三方四正內是否存在某些星耀
- 判斷指定運限三方四正內是否存在四化
- 判斷指定宮位是否是空宮
- 判斷宮位是否產生飛星到目標宮位
- 取得宮位產生的四化宮位
- 其他
- 多語言輸入/輸出
輸入的時候支持多個國家和地區語言混合輸入，可以輸出指定語言。目前支持 簡體中文，繁體中文，英文，日文，韓文，越南語。英文的翻譯目前還沒有標準，所以我大多是意譯的，但也正因為如此，可能英文版本的會更加易懂。如果有精通星象翻譯的歡迎提 PR 。任何語言都可以。
- 鏈式調用
假如你想判斷 紫微星 的 三方四正 有沒有 化忌，你可以這樣做
```ts
import { astro } from 'iztro';
const astrolabe = astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');
astrolabe.star('紫微').surroundedPalaces().haveMutagen('忌');
```
- 配置和插件
紫微鬥數流派眾多，不同的流派的四化以及星耀亮度都會有些許差異，為了滿足不同流派的需求和功能的擴展，iztro在 v2.3.0 版本加入了全局配置和第三方插件功能。 詳見 [配置文檔](https://ziwei.pro/zh_TW/posts/config-n-plugin.html)。
> [!IMPORTANT]
> 如果你在開發中遇到任何問題，可以添加作者微信咨詢。<br>
> 你也可以任意魔改代碼，或聯系作者獲取技術支持。<br>
> <img src="https://github.com/SylarLong/SylarLong/assets/6510425/a2af4876-7d26-4900-a0fc-f5a2030f6205" alt="WeChat" width="350" />
## 快捷跳轉
- [文檔](https://docs.iztro.com)
- [討論](https://github.com/SylarLong/iztro/discussions)
- [問題](https://github.com/SylarLong/iztro/issues)
- [排盤](https://ziwei.pub)
## 立即使用
若您不想自己動手寫程式，只想直接查看 `iztro` 的排盤結果，歡迎直接使用 [紫微派（ziwei.pub）](https://ziwei.pub) 的線上排盤服務。
## 安裝依賴
你可以使用任何你熟悉的包管理庫來安裝 `iztro`。
```shell
# npm
npm install iztro -S
# yarn
yarn add iztro
# pnpm
pnpm install iztro -S
```
## 獨立 JavaScript 庫
假如你使用的是靜態 HTML 文件，可以下載 [release](https://github.com/SylarLong/iztro/releases) 資源文件中的 `iztro-min-js.tar.gz` 壓縮包，裏面包含了一個 `iztro` 壓縮混淆過的 `js` 文件和對應的 `sourcemap` 文件。
> `v2.0.4+` 版本才提供獨立 js 庫。
將 `iztro.min.js` 用 `script` 標簽引入 HTML 文件使用。
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>iztro-紫微鬥數開源庫</title>
</head>
<body>
<script src="./iztro.min.js"></script>
<script>
// 獲取一張星盤數據
var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');
</script>
</body>
</html>
```
當然，我們更推薦你直接使用 `CDN` 加速鏈接，你可以在下面列表中選擇一個，在沒有指定版本號的時候，會自動指向最新版本的代碼庫
- jsdelivr
- https://cdn.jsdelivr.net/npm/iztro/dist/iztro.min.js
- https://cdn.jsdelivr.net/npm/iztro@2.0.5/dist/iztro.min.js
- unpkg
- https://unpkg.com/iztro/dist/iztro.min.js
- https://unpkg.com/iztro@2.0.5/dist/iztro.min.js
你也可以使用如下規則來指定版本：
- `iztro@2`
- `iztro@^2.0.5`
- `iztro@2.0.5`
因為純 JS 庫沒有代碼提示和註釋，所以在集成的時候請參閱 [iztro 開發文檔](https://docs.iztro.com/quick-start.html)。
## 示例
這裏是一個簡單的例子顯示如何調用 `iztro` 獲取到紫微鬥數星盤數據，詳細文檔請移步 [開發文檔](https://docs.iztro.com)
- ES6 Module
```ts
import { astro } from 'iztro';
// 通過陽歷獲取星盤信息
const astrolabe = astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');
// 通過農歷獲取星盤信息
const astrolabe = astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');
```
- CommonJS
```ts
var iztro = require('iztro');
// 通過陽歷獲取星盤信息
var astrolabe = iztro.astro.bySolar('2000-8-16', 2, '女', true, 'zh-CN');
// 通過農歷獲取星盤信息
var astrolabe = iztro.astro.byLunar('2000-7-17', 2, '女', false, true, 'zh-CN');
```
## 貢獻指南
如果你對 `iztro` 有興趣，也想加入貢獻隊伍，我們非常歡迎，你可以用以下方式進行：
- 如果你對程式功能有什麽建議，請到 [這裏](https://github.com/SylarLong/iztro/issues/new?assignees=SylarLong&labels=%E5%8A%9F%E8%83%BD%EF%BD%9Cfeature&projects=&template=new-feature.md&title=%7B%E6%A0%87%E9%A2%98%7D%EF%BD%9C%7Btitle%7D)創建一個 `功能需求`。
- 如果你發現程式有 BUG，請到 [這裏](https://github.com/SylarLong/iztro/issues/new?assignees=SylarLong&labels=%E6%BC%8F%E6%B4%9E%EF%BD%9Cbug&projects=&template=bug-report.md&title=%7Bversion%7D%3A%7Bfunction%7D-) 創建一個 `BUG 報告`。
- 你也可以將本倉庫 `fork` 到你自己的倉庫進行編輯，然後提交PR到本倉庫。
- 假如你擅長外語，我們也歡迎你對國際化文件的翻譯做出你的貢獻，你可以 `fork` 本倉庫，然後在 [locales](https://github.com/SylarLong/iztro/tree/main/src/i18n/locales) 文件夾下創建一個國際化語言文件，然後復製其他語言文件目錄裏面的文件到你的目錄下進行更改。
- 當然，如果你覺得本程式對你有用，請給我買杯咖啡☕️ [](https://PayPal.Me/sylarlong)
> [!NOTE]
> 在開始之前，請先閱讀 [貢獻指南](https://github.com/SylarLong/iztro/blob/main/CONTRIBUTING.md)。
## 總結
使用本程式返回的數據，你可以生成這樣一張星盤，當然這只是一個例子，你可以把註意力集中在星盤的設計上，也可以把重心放在數據的分析上，本程式為你解決了最繁冗的工作，讓你可以把精力更多的放在你所需要關註的事情上面。
## Star 趨勢
> [!IMPORTANT]
> 如果你覺得代碼對你有用，請點 ⭐ 支持，你的 ⭐ 是我持續更新的動力～
<a href="https://star-history.com/#sylarlong/iztro&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=sylarlong/iztro&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=sylarlong/iztro&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=sylarlong/iztro&type=Date" />
</picture>
</a>
## 版權
[MIT License](https://github.com/SylarLong/iztro/blob/main/LICENSE)
Copyright © 2023 All Contributors
[](https://app.fossa.com/projects/git%2Bgithub.com%2FSylarLong%2Fiztro?ref=badge_large)
> [!NOTE]
> 請合理使用本開源代碼，禁止用於非法目的。