term-survivors 0.1.2 → 0.2.2
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/README.md +88 -0
- package/package.json +8 -7
package/README.md
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# Term Survivors
|
|
2
|
+
|
|
3
|
+
> **Note:** This project is currently under development. Features and APIs may change without notice.
|
|
4
|
+
|
|
5
|
+
A Vampire Survivors-like roguelike shooter that runs in the terminal.
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
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.
|
|
10
|
+
|
|
11
|
+
- Platforms: macOS / Linux / Windows
|
|
12
|
+
|
|
13
|
+
## Play
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx term-survivors
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Or install permanently:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# npm
|
|
23
|
+
npm install -g term-survivors
|
|
24
|
+
|
|
25
|
+
# cargo
|
|
26
|
+
cargo install term-survivors
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Then run:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
term-survivors
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
term-survivors --help
|
|
37
|
+
term-survivors 0.2.2
|
|
38
|
+
|
|
39
|
+
USAGE:
|
|
40
|
+
term-survivors [COMMAND]
|
|
41
|
+
|
|
42
|
+
OPTIONS:
|
|
43
|
+
-h, --help Print help information
|
|
44
|
+
-V, --version Print version information
|
|
45
|
+
|
|
46
|
+
COMMANDS:
|
|
47
|
+
start Start the game [default]
|
|
48
|
+
clear Delete save data (~/.term_survivors)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Controls
|
|
52
|
+
|
|
53
|
+
Keyboard only. Mouse is not supported.
|
|
54
|
+
|
|
55
|
+
| Key | Action |
|
|
56
|
+
|-----|--------|
|
|
57
|
+
| `W` `A` `S` `D` / Arrow keys | Move |
|
|
58
|
+
| `Space` | Pause / resume (during play) |
|
|
59
|
+
| `1` `2` `3` | Choose upgrade on level up |
|
|
60
|
+
| `Enter` | Start game / resume saved session (title screen) |
|
|
61
|
+
| `N` | Start new game (title screen) |
|
|
62
|
+
| `M` | Return to title (during play) |
|
|
63
|
+
| `R` | Retry after game over / clear |
|
|
64
|
+
| `Q` / `ESC` | Quit |
|
|
65
|
+
|
|
66
|
+
## Save Data
|
|
67
|
+
|
|
68
|
+
Save data is stored in `~/.term_survivors/`:
|
|
69
|
+
|
|
70
|
+
To delete all save data:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
term-survivors clear
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Logs
|
|
77
|
+
|
|
78
|
+
Each session writes debug logs to `~/.term_survivors/logs/latest.log` (overwritten on startup). The log records key events such as game start, level-up choices, and game over/clear outcomes, as well as any errors encountered during the session.
|
|
79
|
+
|
|
80
|
+
If you're reporting a bug, please include the contents of this file in your [issue](https://github.com/kimulaco/term-survivors/issues) — it helps narrow down what happened.
|
|
81
|
+
|
|
82
|
+
## Development
|
|
83
|
+
|
|
84
|
+
For contributors: see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)
|
|
85
|
+
|
|
86
|
+
## License
|
|
87
|
+
|
|
88
|
+
[MIT](./LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "term-survivors",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "A Vampire Survivors-like roguelike shooter that runs in the terminal",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"game",
|
|
@@ -18,16 +18,17 @@
|
|
|
18
18
|
"node": ">=20"
|
|
19
19
|
},
|
|
20
20
|
"files": [
|
|
21
|
-
"index.js"
|
|
21
|
+
"index.js",
|
|
22
|
+
"README.md"
|
|
22
23
|
],
|
|
23
24
|
"bin": {
|
|
24
25
|
"term-survivors": "index.js"
|
|
25
26
|
},
|
|
26
27
|
"optionalDependencies": {
|
|
27
|
-
"@term-survivors/darwin-arm64": "0.
|
|
28
|
-
"@term-survivors/darwin-x64": "0.
|
|
29
|
-
"@term-survivors/linux-x64": "0.
|
|
30
|
-
"@term-survivors/linux-arm64": "0.
|
|
31
|
-
"@term-survivors/win32-x64": "0.
|
|
28
|
+
"@term-survivors/darwin-arm64": "0.2.2",
|
|
29
|
+
"@term-survivors/darwin-x64": "0.2.2",
|
|
30
|
+
"@term-survivors/linux-x64": "0.2.2",
|
|
31
|
+
"@term-survivors/linux-arm64": "0.2.2",
|
|
32
|
+
"@term-survivors/win32-x64": "0.2.2"
|
|
32
33
|
}
|
|
33
34
|
}
|