term-survivors 0.3.0 → 0.4.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.
Files changed (2) hide show
  1. package/README.md +28 -6
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,14 +1,23 @@
1
+ [![npm](https://img.shields.io/npm/v/term-survivors?color=blue)](https://www.npmjs.com/package/term-survivors)
2
+ [![crates.io](https://img.shields.io/crates/v/term-survivors?color=blue)](https://crates.io/crates/term-survivors)
3
+ ![npm downloads](https://img.shields.io/npm/d18m/term-survivors?color=blue)
4
+ ![GitHub Actions](https://img.shields.io/github/actions/workflow/status/kimulaco/term-survivors/test.yml?color=97ca00)
5
+ ![MIT License](https://img.shields.io/github/license/kimulaco/term-survivors)
6
+ [![GitHub Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=ff69b4)](https://github.com/sponsors/kimulaco)
7
+
1
8
  # Term Survivors
2
9
 
3
10
  > **Note:** This project is currently under development. Features and APIs may change without notice.
4
11
 
5
12
  A Vampire Survivors-like roguelike shooter that runs in the terminal.
6
13
 
7
- ## Overview
14
+ Survive waves of enemies for 5+ minutes and defeat the final boss to clear the game. Weapons fire automatically.
15
+
16
+ Start quickly, pause anytime, and resume right where you left off — perfect for short breaks between AI-assisted work sessions.
8
17
 
9
- Survive waves of enemies for 5+ minutes and defeat the final boss to clear the game. Weapons fire automatically just move and stay alive.
18
+ <div align="center"><img src="./docs/assets/gameplay.png" alt="Game play image" width="600" height="445"></div>
10
19
 
11
- - Platforms: macOS / Linux / Windows
20
+ Platforms: macOS / Linux / Windows
12
21
 
13
22
  ## Play
14
23
 
@@ -24,6 +33,10 @@ npm install -g term-survivors
24
33
 
25
34
  # cargo
26
35
  cargo install term-survivors
36
+
37
+ # Homebrew
38
+ brew tap kimulaco/term-survivors
39
+ brew install term-survivors
27
40
  ```
28
41
 
29
42
  Then run:
@@ -34,7 +47,7 @@ term-survivors
34
47
 
35
48
  ```bash
36
49
  term-survivors --help
37
- term-survivors 0.3.0
50
+ term-survivors 0.4.0
38
51
 
39
52
  USAGE:
40
53
  term-survivors [COMMAND]
@@ -52,14 +65,23 @@ COMMANDS:
52
65
 
53
66
  Keyboard only. Mouse is not supported.
54
67
 
68
+ ### In Game
69
+
55
70
  | Key | Action |
56
71
  |-----|--------|
57
72
  | `W` `A` `S` `D` / Arrow keys | Move |
58
- | `Space` | Pause / resume (during play) |
73
+ | `Space` | Pause / resume |
59
74
  | `1` `2` `3` | Choose upgrade on level up |
75
+ | `M` | Return to title |
76
+
77
+ ### Menus & Screens
78
+
79
+ | Key | Action |
80
+ |-----|--------|
60
81
  | `Enter` | Start game / resume saved session (title screen) |
61
82
  | `N` | Start new game (title screen) |
62
- | `M` | Return to title (during play) |
83
+ | `A` | Toggle auto restart (title screen) |
84
+ | `B` | Toggle dark mode (title screen) |
63
85
  | `R` | Retry after game over / clear |
64
86
  | `Q` / `ESC` | Quit |
65
87
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "term-survivors",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "A Vampire Survivors-like roguelike shooter that runs in the terminal",
5
5
  "keywords": [
6
6
  "game",
@@ -25,10 +25,10 @@
25
25
  "term-survivors": "index.js"
26
26
  },
27
27
  "optionalDependencies": {
28
- "@term-survivors/darwin-arm64": "0.3.0",
29
- "@term-survivors/darwin-x64": "0.3.0",
30
- "@term-survivors/linux-x64": "0.3.0",
31
- "@term-survivors/linux-arm64": "0.3.0",
32
- "@term-survivors/win32-x64": "0.3.0"
28
+ "@term-survivors/darwin-arm64": "0.4.0",
29
+ "@term-survivors/darwin-x64": "0.4.0",
30
+ "@term-survivors/linux-x64": "0.4.0",
31
+ "@term-survivors/linux-arm64": "0.4.0",
32
+ "@term-survivors/win32-x64": "0.4.0"
33
33
  }
34
34
  }