Skip to content

Latest commit

 

History

History
243 lines (166 loc) · 9.51 KB

README-zh_TW.md

File metadata and controls

243 lines (166 loc) · 9.51 KB
Raw

banner2

壹套輕量級紫微鬥數排盤工具庫。

Maintainability Codecov npm Codecov npm GitHub GitHub code size in bytes npm bundle size FOSSA Status Package Quality

简体中文 🔸 繁體中文 🔸 English

介紹

用於紫微鬥數排盤的javascript開源庫，有以下功能。

  • 輸入

    • 生日（陽歷或農歷皆可）
    • 出生時間
    • 性別

  • 可以實現下列功能

    • 紫微鬥數 12 宮的星盤數據
    • 獲取生肖
    • 獲取星座
    • 獲取四柱（幹支紀年法的生辰）
    • 獲取運限（大限，小限，流年，流月，流日，流時）的數據
    • 獲取流耀（大限和流年的動態星耀）
    • 判斷指定宮位是否存在某些星耀
    • 判斷指定宮位三方四正是否存在某些星耀
    • 判斷指定宮位三方四正是否存在四化
    • 判斷指定星耀是否存在四化
    • 判斷指定星耀三方四正是否存在四化
    • 判斷指定星耀是否是某個亮度
    • 根據天幹獲取四化
    • 獲取指定星耀所在宮位
    • 獲取指定宮位三方四正宮位
    • 獲取指定星耀三方四正宮位
    • 獲取指定星耀對宮
    • 獲取指定運限宮位
    • 獲取指定運限宮位的三方四正
    • 判斷指定運限宮位內是否存在某些星耀
    • 判斷指定運限宮位內是否存在四化
    • 判斷指定運限三方四正內是否存在某些星耀
    • 判斷指定運限三方四正內是否存在四化
    • 判斷指定宮位是否是空宮
    • 判斷宮位是否產生飛星到目標宮位
    • 取得宮位產生的四化宮位

  • 其他

    • 多語言輸入/輸出

      輸入的時候支持多個國家和地區語言混合輸入，可以輸出指定語言。目前支持 簡體中文，繁體中文，英文，日文，韓文，越南語。英文的翻譯目前還沒有標準，所以我大多是意譯的，但也正因為如此，可能英文版本的會更加易懂。如果有精通星象翻譯的歡迎提 PR 。任何語言都可以。

    • 鏈式調用

      假如你想判斷 紫微星 的 三方四正 有沒有 化忌，你可以這樣做

      import { astro } from 'iztro';

const astrolabe = astro.bySolar('2000-8-16', 2, '男', true, 'zh-CN');

astrolabe.star('紫微').surroundedPalaces().haveMutagen('忌');

    • 配置和插件

      紫微鬥數流派眾多，不同的流派的四化以及星耀亮度都會有些許差異，為了滿足不同流派的需求和功能的擴展，iztro在 v2.3.0 版本加入了全局配置和第三方插件功能。 詳見配置文檔

Important

如果你在開發中遇到任何問題，可以添加作者微信咨詢
你也可以任意魔改代碼，或聯系作者獲取技術支持
WeChat

快捷跳轉

安裝依賴

你可以使用任何你熟悉的包管理庫來安裝iztro

  • NPM

    npm install iztro -S

  • Yarn

    yarn add iztro

  • pnpm

    pnpm install iztro -S

獨立js庫

假如你使用的是靜態 html 文件，可以下載 release 資源文件中的 iztro-min-js.tar.gz 壓縮包，裏面包含了一個 iztro 壓縮混淆過的js文件和對應的sourcemap文件。

v2.0.4+ 版本才提供獨立js庫。

將 iztro.min.js 用script標簽引入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 加速鏈接，你可以在下面列表中選擇一個，在沒有指定版本號的時候，會自動指向最新版本的代碼庫

你也可以使用如下規則來指定版本：

  • iztro@2
  • iztro@^2.0.5
  • iztro@2.0.5

應為純JS庫沒有代碼提示和註釋，所以在集成的時候請參閱 iztro開發文檔

例子

這裏是一個簡單的例子顯示如何調用iztro獲取到紫微鬥數星盤數據，詳細文檔請移步開發文檔

  • ES6 Module

    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

    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有興趣，也想加入貢獻隊伍，我們非常歡迎，你可以用以下方式進行：

  • 如果你對程序功能有什麽建議，請到這裏創建一個功能需求。
  • 如果你發現程序有BUG，請到這裏創建一個BUG報告。
  • 你也可以將本倉庫fork到你自己的倉庫進行編輯，然後提交PR到本倉庫。
  • 假如你擅長外語，我們也歡迎你對國際化文件的翻譯做出你的貢獻，你可以fork本倉庫，然後在locales文件夾下創建一個國際化語言文件，然後復製其他語言文件目錄裏面的文件到你的目錄下進行更改。
  • 當然，如果你覺得本程序對你有用，請給我買杯咖啡☕️ Static Badge

Important

如果你覺得代碼對你有用，請點⭐支持，你的⭐是我持續更新的動力

總結

使用本程序返回的數據，你可以生成這樣一張星盤，當然這只是一個例子，你可以把註意力集中在星盤的設計上，也可以把重心放在數據的分析上，本程序為你解決了最繁冗的工作，讓你可以把精力更多的放在你所需要關註的事情上面。

image

Star趨勢

Star History Chart

版權

MIT License

Copyright © 2023 All Contributors

Note

請合理使用本開源代碼，禁止用於非法目的。

FOSSA Status