@guanxing1/plugin-elizaos 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Ryan Cheung
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,168 @@
1
+ # @guanxing/plugin-elizaos
2
+
3
+ ElizaOS plugin for **观星 GuanXing** — Chinese metaphysics AI tools.
4
+
5
+ Give any Eliza-powered AI agent the ability to perform BaZi (八字) analysis, Tarot readings, I-Ching divination, Feng Shui assessments, dream interpretation, and more.
6
+
7
+ ## Actions
8
+
9
+ | Action | Description |
10
+ |--------|-------------|
11
+ | `BAZI_ANALYSIS` | Chinese Four Pillars of Destiny (八字命理) — birth chart analysis |
12
+ | `DAILY_FORTUNE` | Daily fortune forecast by zodiac sign (每日运势) |
13
+ | `QIUQIAN` | Temple fortune stick divination (求签问卦) — Guanyin or Guandi |
14
+ | `TAROT_READING` | Tarot card reading (塔罗占卜) — single, three-card, or Celtic Cross |
15
+ | `DREAM_INTERPRET` | Dream interpretation (周公解梦) with psychology insights |
16
+ | `ALMANAC_LOOKUP` | Chinese almanac / Huang Li (黄历) — auspicious dates & activities |
17
+ | `FENGSHUI_ASSESSMENT` | Feng Shui analysis (风水评估) for home, office, or shop |
18
+ | `NAME_SCORE` | Chinese name numerology scoring (姓名打分) |
19
+ | `COMPATIBILITY_CHECK` | Zodiac/birth date compatibility (缘分配对) |
20
+ | `ZODIAC_READING` | Zodiac sign deep analysis (星座解读) |
21
+
22
+ ## Installation
23
+
24
+ ```bash
25
+ bun add @guanxing/plugin-elizaos
26
+ # or
27
+ npm install @guanxing/plugin-elizaos
28
+ ```
29
+
30
+ ## Configuration
31
+
32
+ ### 1. Get an API Key
33
+
34
+ Sign up at [heartai.zeabur.app](https://heartai.zeabur.app) and create a developer API key.
35
+
36
+ ### 2. Add to your character
37
+
38
+ ```json
39
+ {
40
+ "name": "MyAgent",
41
+ "plugins": ["@guanxing/plugin-elizaos"],
42
+ "settings": {
43
+ "secrets": {
44
+ "GUANXING_API_KEY": "gx_sk_your_key_here"
45
+ }
46
+ }
47
+ }
48
+ ```
49
+
50
+ Or set the environment variable:
51
+
52
+ ```bash
53
+ GUANXING_API_KEY=gx_sk_your_key_here
54
+ ```
55
+
56
+ ## Example Conversations
57
+
58
+ **BaZi Analysis**
59
+ ```
60
+ User: Can you do a BaZi reading for someone born on 1990-06-15 at 2pm?
61
+ Agent: 八字 BaZi Analysis for 1990-06-15 at 14:00
62
+ Four Pillars: 庚午 壬午 丁巳 丁未
63
+ Day Master: 丁火
64
+ Five Elements: 金: 1 | 木: 0 | 水: 1 | 火: 4 | 土: 2
65
+ ...
66
+ ```
67
+
68
+ **Daily Fortune**
69
+ ```
70
+ User: What's my daily fortune? I'm a Leo.
71
+ Agent: 狮子座 — Today's Fortune
72
+ Overall: ★★★★☆
73
+ Career: ★★★★★
74
+ Lucky Color: Gold
75
+ ...
76
+ ```
77
+
78
+ **Fortune Stick (求签)**
79
+ ```
80
+ User: Draw a fortune stick — should I change jobs?
81
+ Agent: 🏮 Fortune Stick #42 — 旧燕衔泥
82
+ Grade: 中上
83
+ ...
84
+ ```
85
+
86
+ **Tarot Reading**
87
+ ```
88
+ User: Do a three-card tarot spread about my relationship
89
+ Agent: 🃏 Tarot Reading — Past / Present / Future
90
+ Card 1: The Lovers — Deep connection...
91
+ Card 2: The Tower (Reversed) — Upheaval settling...
92
+ Card 3: The Star — Hope and renewal ahead...
93
+ ```
94
+
95
+ **Dream Interpretation**
96
+ ```
97
+ User: I dreamed I was flying over an ocean and saw a golden dragon
98
+ Agent: 🌙 Dream Interpretation
99
+ Symbols: flying, ocean, golden dragon
100
+ ...
101
+ ```
102
+
103
+ **Chinese Almanac**
104
+ ```
105
+ User: Check the Chinese almanac for today
106
+ Agent: 📅 Chinese Almanac — Today
107
+ Lunar Date: 二月十九
108
+ Auspicious: 开业, 搬家, 签约
109
+ Inauspicious: 动土, 安葬
110
+ ...
111
+ ```
112
+
113
+ **Feng Shui**
114
+ ```
115
+ User: Check the feng shui of my south-facing home office
116
+ Agent: 🏡 Feng Shui Assessment — office
117
+ Score: 72/100
118
+ ...
119
+ ```
120
+
121
+ **Name Score**
122
+ ```
123
+ User: Score the name 张伟
124
+ Agent: 📝 Name Score — 张伟
125
+ Total Score: 85/100
126
+ ...
127
+ ```
128
+
129
+ **Compatibility**
130
+ ```
131
+ User: Check compatibility between Leo and Pisces
132
+ Agent: 💕 Compatibility Check
133
+ 狮子座 × 双鱼座
134
+ Overall Score: 68/100
135
+ Love: ███████░░░ 75%
136
+ ...
137
+ ```
138
+
139
+ **Zodiac Reading**
140
+ ```
141
+ User: Tell me about Scorpio's personality
142
+ Agent: ⭐ 天蝎座 Zodiac Reading — personality
143
+ Element: Water
144
+ Ruling Planet: Pluto
145
+ Key Traits: Passionate, Determined, Mysterious
146
+ ...
147
+ ```
148
+
149
+ ## Development
150
+
151
+ ```bash
152
+ # Install dependencies
153
+ bun install
154
+
155
+ # Build
156
+ bun run build
157
+
158
+ # Watch mode
159
+ bun run dev
160
+ ```
161
+
162
+ ## API
163
+
164
+ This plugin connects to the [GuanXing API](https://heartai.zeabur.app) (`https://heartai.zeabur.app/api/v1/`). All 10 endpoints are POST requests authenticated via Bearer token.
165
+
166
+ ## License
167
+
168
+ MIT