slasher-horrorscripts 0.1.4

A Rust-based CLI tool that displays high-quality ANSI art of horror movie icons in your terminal
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# Slasher Horrorscripts 🔪

`.png` image credit https://pngegg.com

A Rust-based CLI tool that displays high-quality ANSI art of horror movie icons
in your terminal. Inspired by `pokemon-colorscripts`, but built for fans of the
macabre.

![screenshot1](https://raw.githubusercontent.com/saylesss88/slasher-horrorscripts/main/assets/demo1.png)

## ✨ Features

- **Blazing Fast**: Written in pure Rust with embedded assets (single binary, no
  runtime dependencies).

- **High Fidelity**: Uses a custom image-to-ANSI engine (px2ansi-rs) for crisp
  pixel-perfect rendering.

- **Self-Contained**: No external image files needed at runtime; everything is
  baked into the executable.

- **Randomizer**: Get a different slasher every time you open your terminal.

## 📦 Installation

Option 1: Install via Cargo (Recommended)

Get the default slashers (Jason, Freddy, etc.) immediately.

```bash
cargo install slasher-horrorscripts
```

Option 2: Build From Source (For Customization)

Choose this if you want to add your own characters or modify the art.

1. Clone the repository:

```bash
git clone https://github.com/yourusername/slasher-horrorscripts.git
cd slasher-horrorscripts
```

2. Generate Assets:

This step converts the raw PNG sprites in `assets/images` into optimized ANSI
text files.

```bash
cargo run --bin convert
# Or once installed simply
convert
```

3. Build & Install

```bash
cargo build --release
cp target/release/slasher-horrorscripts ~/.local/bin/
```

## Usage

Run the tool directly from your terminal:

```bash
# Show a random slasher
slasher-horrorscripts

# Show a specific character
slasher-horrorscripts --name jason

# List all available characters
slasher-horrorscripts --list

# Show random character without the name label
slasher-horrorscripts --random --no-title
```

## Add to Shell Startup

To see a random horror icon every time you launch your terminal, add this to
your shell config (.bashrc, .zshrc, or config.fish):

```bash
# Display a random slasher on startup
slasher-horrorscripts --random
```

## 🎨 Adding New Characters

Want to add Pinhead, or any other character?

1. Find a pixel art sprite (PNG/JPG).

- Tip: 8-bit or 16-bit sprites with transparent backgrounds work best.

2. Save the image to `assets/images/` (e.g., `swampthing.png`).

3. Run the converter:

```bash
cargo run --bin convert
```

4. Rebuild the binary:

```bash
cargo build --release
```

## 🔧 Technical Details

This project uses a custom rendering engine, px2ansi-rs, to handle image
processing.

- **Engine**: px2ansi-rs handles the RGB-to-ANSI escape sequence conversion.

- **Resizing**: Images are automatically resized to a terminal-friendly height
  (40 rows) during the conversion step to ensure consistent presentation.

- **Embedding**: The rust-embed crate compiles the generated ANSI text files
  directly into the final binary, making it portable and easy to distribute.

## 📜 License

MIT License - Hack away!