This project offers a lightweight, multilingual JavaScript library (iztro) for generating Zi Wei Dou Shu (Purple Star Astrology) charts and astrological data. It targets developers and enthusiasts needing programmatic access to horoscope and personality analysis, simplifying complex calculations for building astrological applications.

How It Works

iztro calculates core Zi Wei Dou Shu elements including the 12 palaces, zodiac, Four Pillars, and temporal luck cycles (major, minor, yearly, etc.). It supports dynamic stars, star brightness, and complex relational queries. Key advantages include multilingual support (Chinese, English, Japanese, Korean, Vietnamese) and a chainable API for concise queries. An extensible configuration system accommodates different astrological schools, complemented by an optional AI layer (iztro-ziwei-v3) for automated chart interpretation.

Quick Start & Requirements

Installation is via npm, yarn, or pnpm (npm install iztro). Standalone JavaScript usage is supported via downloaded releases or CDN links (jsdelivr, unpkg). No specific hardware or OS requirements are listed beyond standard JavaScript runtime environments. AI Chat API documentation is at api-doc.iztro.com.

Highlighted Details

• Comprehensive Zi Wei Dou Shu data generation (12 palaces, luck cycles, stars, transformations).
• Multilingual support for input and output.
• Expressive, chainable API for complex astrological queries.
• Extensible configuration for different astrological schools.
• Integrated AI layer (iztro-ziwei-v3) for automated interpretation via API.

Maintenance & Community

The project maintains a Discord community (https://discord.gg/xvmu6gww6B) for support. Development health is indicated by NPM download statistics and CI/CD integration. Contributions are welcomed via GitHub issues for feature requests and bug reports, following a contribution guide.

Licensing & Compatibility

Released under the MIT License, permitting commercial use and integration into closed-source projects, with a prohibition on illegal use.

Limitations & Caveats

English translations are noted as potentially literal. The AI interpretation layer requires an API key and may incur usage costs. Users may need to configure the plugin system for specific astrological schools. Direct author consultation via WeChat is suggested for complex development issues.