@hypersocial/cli-games 0.1.1 → 0.2.1

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.
Files changed (11) hide show
  1. package/README.md +40 -15
  2. package/dist/cli.js +182 -165
  3. package/dist/cli.js.map +1 -1
  4. package/dist/create-CIK3AD2D.js +418 -0
  5. package/dist/create-CIK3AD2D.js.map +1 -0
  6. package/dist/index.d.ts +111 -1
  7. package/dist/index.js +318 -164
  8. package/dist/index.js.map +1 -1
  9. package/dist/update-check-PNB4U4P7.js +130 -0
  10. package/dist/update-check-PNB4U4P7.js.map +1 -0
  11. package/package.json +5 -2
package/README.md CHANGED
@@ -4,31 +4,48 @@
4
4
 
5
5
  **Snake, Tetris, 2048, Pong, Asteroids, Space Invaders, Breakout, Frogger, Tron, Minesweeper, Wordle, Hangman, Simon, Runner, Tower, Typing Test, Crack, Chopper.**
6
6
 
7
- ## CLI Usage
7
+ Originally built as easter eggs for [HyperSpaces](https://hyperspaces.dev) — the terminal for AI coding agents. Play games while your agents ship code.
8
+
9
+ ## Quick Start
8
10
 
9
11
  ```bash
10
- # Interactive menu
12
+ # Play now — no install needed
11
13
  npx @hypersocial/cli-games
12
14
 
13
15
  # Launch a specific game
14
16
  npx @hypersocial/cli-games snake
15
- npx @hypersocial/cli-games tetris
16
17
 
17
- # Choose a color theme
18
- npx @hypersocial/cli-games --theme green
19
- npx @hypersocial/cli-games --theme amber snake
18
+ # With a color theme
19
+ npx @hypersocial/cli-games tetris --theme green
20
20
  ```
21
21
 
22
- ### Available Themes
22
+ ## Install
23
23
 
24
- `cyan` (default), `amber`, `green`, `white`, `hotpink`, `blood`, `ice`, `bladerunner`, `tron`, `kawaii`, `oled`, `solarized`, `nord`, `highcontrast`, `banana`, `cream`, and their light variants.
24
+ ```bash
25
+ # Global install
26
+ npm install -g @hypersocial/cli-games
27
+ cli-games
25
28
 
26
- ## Library Usage (xterm.js)
29
+ # Or as a project dependency (for xterm.js integration)
30
+ npm install @hypersocial/cli-games
31
+ ```
32
+
33
+ ## CLI Usage
27
34
 
28
35
  ```bash
29
- npm install @hypersocial/cli-games
36
+ cli-games # Interactive game menu
37
+ cli-games <game> # Launch a game directly
38
+ cli-games --theme <theme> # Set color theme
39
+ cli-games --list # List all games
40
+ cli-games --help # Show help
30
41
  ```
31
42
 
43
+ ### Available Themes
44
+
45
+ `cyan` (default), `amber`, `green`, `white`, `hotpink`, `blood`, `ice`, `bladerunner`, `tron`, `kawaii`, `oled`, `solarized`, `nord`, `highcontrast`, `banana`, `cream`, and their light variants (e.g. `cyanLight`).
46
+
47
+ ## Library Usage (xterm.js)
48
+
32
49
  ```typescript
33
50
  import { games, setTheme, runGame } from '@hypersocial/cli-games';
34
51
 
@@ -41,7 +58,7 @@ const controller = runGame('snake', terminal);
41
58
  // Stop the game
42
59
  controller?.stop();
43
60
 
44
- // Or use the games registry
61
+ // Browse all games
45
62
  for (const game of games) {
46
63
  console.log(`${game.id}: ${game.name} - ${game.description}`);
47
64
  }
@@ -88,13 +105,21 @@ terminal.options.theme = xtermTheme;
88
105
 
89
106
  ## Controls
90
107
 
91
- - **Arrow keys** or **WASD** — Move/navigate
92
- - **Enter** — Confirm/select
108
+ - **Arrow keys** or **WASD** — Move / navigate
109
+ - **Enter** — Confirm / select
93
110
  - **ESC** — Pause menu
94
111
  - **Q** — Quit
95
112
 
113
+ ## About
114
+
115
+ Built by [Selcuk Atli](https://x.com/selcukatli) at [HyperSocial App Studio](https://github.com/hypersocialinc).
116
+
117
+ These games are the easter eggs inside [HyperSpaces](https://hyperspaces.dev), a terminal built for developers running multiple AI coding agents across multiple projects. Think Discord for your terminals — projects in the dock, branches as channels, agents side by side.
118
+
119
+ ## Contributing
120
+
121
+ Contributions welcome via pull requests. Add a new game, improve an existing one, or fix a bug.
122
+
96
123
  ## License
97
124
 
98
125
  AGPL-3.0 — see [LICENSE](LICENSE) for details.
99
-
100
- Contributions welcome via pull requests.