brt — Brew Remote Tools

Download Raw

1#!/usr/bin/env bash
2# Terminal Doom via doom-ascii (https://github.com/wojciech-graj/doom-ascii)

4BRT_DOOM_DIR="${HOME}/.brt/doom"
5BRT_DOOM_BIN="${BRT_DOOM_DIR}/doom-ascii"
6BRT_DOOM_SRC="${BRT_DOOM_DIR}/src"
7BRT_DOOM_VERSION="0.3.1"
8BRT_DOOM_REPO="https://github.com/wojciech-graj/doom-ascii.git"
9BRT_FREEDOOM_URL="https://github.com/freedoom/freedoom/releases/download/v0.13.0/freedoom-0.13.0.zip"
10BRT_DOOM_IWAD="${BRT_DOOM_DIR}/freedoom1.wad"

12brt_doom_scaling() {
local rows
rows=$(tput lines 2>/dev/null || echo 24)
if (( rows >= 40 )); then
  echo 2
elif (( rows >= 28 )); then
  echo 3
else
  echo 4
fi
22}

24brt_doom_write_config() {
local cfg="${BRT_DOOM_DIR}/.default.cfg"
cat > "$cfg" <<'EOF'
27# brt -doom controls (DOS scancodes; see chocolate-doom default.cfg)
28use_mouse                     1
29mouseb_fire                   0
30mouseb_strafe                 0
31mouseb_forward                0
32mouseb_speed                  0
33grabmouse                     1
34mouse_sensitivity             7

36# Move: WASD
37key_up                        17
38key_down                      31
39key_strafeleft                30
40key_straferight               32

42# Look / turn: arrow keys
43key_left                      75
44key_right                     77

46# Space = use (classic Doom has no jump)
47key_use                       57

49# Right Shift = fire
50key_fire                      54

52# Run on ]
53key_speed                     27
54EOF
55}

57brt_doom_ensure_wad() {
local zip tmpdir

if [[ -f "$BRT_DOOM_IWAD" ]]; then
  return 0
fi

brt_require curl
brt_require unzip

brt_info "Downloading Freedoom WAD (first run only)..."
zip=$(mktemp "${TMPDIR:-/tmp}/brt-freedoom.XXXXXX.zip")
tmpdir=$(mktemp -d "${TMPDIR:-/tmp}/brt-freedoom.XXXXXX")

if ! curl -fsSL --progress-bar "$BRT_FREEDOOM_URL" -o "$zip"; then
  rm -f "$zip"
  rm -rf "$tmpdir"
  brt_error "Failed to download Freedoom from ${BRT_FREEDOOM_URL}"
  brt_info "Place doom1.wad or freedoom1.wad in ${BRT_DOOM_DIR}/"
  return 1
fi

unzip -qq -o "$zip" -d "$tmpdir" || {
  rm -f "$zip"
  rm -rf "$tmpdir"
  brt_error "Failed to extract Freedoom archive"
  return 1
}

local wad
wad=$(find "$tmpdir" -name 'freedoom1.wad' -print -quit)
if [[ -z "$wad" ]]; then
  rm -f "$zip"
  rm -rf "$tmpdir"
  brt_error "freedoom1.wad not found in archive"
  return 1
fi

cp "$wad" "$BRT_DOOM_IWAD"
rm -f "$zip"
rm -rf "$tmpdir"
brt_ok "Installed ${BRT_DOOM_IWAD}"
99}

101brt_doom_find_wad() {
local wad="${1:-}"

if [[ -n "$wad" && -f "$wad" ]]; then
  case "$wad" in
    ~/*) wad="${HOME}/${wad#~/}" ;;
    ~) wad="$HOME" ;;
  esac
  if command -v realpath &>/dev/null; then
    realpath "$wad"
  else
    (cd "$(dirname "$wad")" && printf '%s/%s\n' "$(pwd)" "$(basename "$wad")")
  fi
  return 0
fi

if [[ -f "$BRT_DOOM_IWAD" ]]; then
  printf '%s\n' "$BRT_DOOM_IWAD"
  return 0
fi

for wad in "${HOME}/.brt/doom/doom1.wad" "${HOME}/.brt/doom/DOOM1.WAD" \
  "${HOME}/.brt/doom/freedoom1.wad"; do
  if [[ -f "$wad" ]]; then
    printf '%s\n' "$wad"
    return 0
  fi
done

return 1
131}

133brt_doom_ensure_binary() {
if [[ -x "$BRT_DOOM_BIN" ]]; then
  return 0
fi

brt_require git
brt_require make
brt_require cc

mkdir -p "$BRT_DOOM_DIR"

if [[ ! -d "${BRT_DOOM_SRC}/.git" ]]; then
  brt_info "Fetching doom-ascii ${BRT_DOOM_VERSION} (first run only)..."
  git clone --depth 1 --branch "${BRT_DOOM_VERSION}" "$BRT_DOOM_REPO" "$BRT_DOOM_SRC" \
    || {
      brt_error "Failed to clone doom-ascii"
      return 1
    }
fi

brt_info "Building doom-ascii..."
if ! make -C "$BRT_DOOM_SRC" -j"$(sysctl -n hw.ncpu 2>/dev/null || nproc 2>/dev/null || echo 2)"; then
  brt_error "Failed to build doom-ascii (need Xcode CLT or gcc)"
  return 1
fi

local built=""
for built in \
  "${BRT_DOOM_SRC}/game/doom-ascii" \
  "${BRT_DOOM_SRC}/_unix/game/doom-ascii" \
  "${BRT_DOOM_SRC}/_unix/obj/doom-ascii"; do
  if [[ -f "$built" ]]; then
    cp "$built" "$BRT_DOOM_BIN"
    chmod +x "$BRT_DOOM_BIN"
    brt_ok "Built ${BRT_DOOM_BIN}"
    return 0
  fi
done

brt_error "Build finished but doom-ascii binary is missing"
return 1
174}

176brt_doom_term_restore() {
[[ -w /dev/tty ]] || return 0
printf '\033[?25h\033[0m\033[r' >/dev/tty 2>/dev/null || true
stty sane </dev/tty 2>/dev/null || true
180}

182brt_doom_on_exit() {
brt_doom_term_restore
184}

186brt_doom() {
local wad_arg="" scaling rc=0
local -a extra_args=()

while [[ $# -gt 0 ]]; do
  case "$1" in
    -h|--help)
      cat <<EOF
194brt -doom — play Doom in the terminal

196Controls:
WASD              Move (forward / back / strafe)
Mouse move        Turn (if terminal/backend supports mouse reporting)
Left click        Fire (if terminal/backend supports mouse reporting)
Arrow keys        Turn fallback
Space             Use doors and switches
Right Shift       Fire fallback
]                 Run
Esc               Menu
Ctrl+C            Quit

207Options:
--wad <file>      Use a specific WAD (default: Freedoom, auto-downloaded)
--scaling <N>     Display scale 2–4 (smaller = larger; default: auto)

211Requires: git, make, and a C compiler on first run.
212EOF
      return 0
      ;;
    --wad)
      wad_arg="${2:-}"
      [[ -n "$wad_arg" ]] || { brt_error "--wad requires a path"; exit 1; }
      shift 2
      ;;
    --scaling)
      extra_args+=("-scaling" "${2:-}")
      [[ -n "${2:-}" ]] || { brt_error "--scaling requires a number"; exit 1; }
      shift 2
      ;;
    *)
      if [[ -z "$wad_arg" && -f "$1" ]]; then
        wad_arg="$1"
        shift
      else
        brt_error "Unknown option: $1"
        brt_info "Run: brt -doom --help"
        exit 1
      fi
      ;;
  esac
done

brt_doom_ensure_binary || exit 1
brt_doom_write_config

local iwad
if ! iwad=$(brt_doom_find_wad "$wad_arg"); then
  brt_doom_ensure_wad || exit 1
  iwad=$(brt_doom_find_wad "") || {
    brt_error "No WAD file found"
    exit 1
  }
fi

local scaling_flag
scaling_flag=$(brt_doom_scaling)
if ((${#extra_args[@]} == 0)); then
  extra_args=("-scaling" "$scaling_flag")
fi
extra_args+=("-chars" "block" "-kpsmooth" "8")

brt_info "WAD: ${iwad}"
brt_info "Renderer: unicode block cells (-chars block)"
brt_info "Controls: mouse move/click (when supported) · arrows/Right Shift fallback · WASD move · Ctrl+C quit"

trap 'brt_doom_on_exit' EXIT INT TERM

set +e
(
  cd "$BRT_DOOM_DIR" || exit 1
  exec "$BRT_DOOM_BIN" \
    -iwad "$iwad" \
    "${extra_args[@]}"
)
rc=$?
set -e

brt_doom_term_restore

if (( rc == 0 || rc == 130 || rc == 143 )); then
  return 0
fi
brt_error "Doom exited with code ${rc}"
return "$rc"
280}


1	`#!/usr/bin/env bash`
2	`# Terminal Doom via doom-ascii (https://github.com/wojciech-graj/doom-ascii)`
3
4	`BRT_DOOM_DIR="${HOME}/.brt/doom"`
5	`BRT_DOOM_BIN="${BRT_DOOM_DIR}/doom-ascii"`
6	`BRT_DOOM_SRC="${BRT_DOOM_DIR}/src"`
7	`BRT_DOOM_VERSION="0.3.1"`
8	`BRT_DOOM_REPO="https://github.com/wojciech-graj/doom-ascii.git"`
9	`BRT_FREEDOOM_URL="https://github.com/freedoom/freedoom/releases/download/v0.13.0/freedoom-0.13.0.zip"`
10	`BRT_DOOM_IWAD="${BRT_DOOM_DIR}/freedoom1.wad"`
11
12	`brt_doom_scaling() {`
13	`local rows`
14	`rows=$(tput lines 2>/dev/null \|\| echo 24)`
15	`if (( rows >= 40 )); then`
16	`echo 2`
17	`elif (( rows >= 28 )); then`
18	`echo 3`
19	`else`
20	`echo 4`
21	`fi`
22	`}`
23
24	`brt_doom_write_config() {`
25	`local cfg="${BRT_DOOM_DIR}/.default.cfg"`
26	`cat > "$cfg" <<'EOF'`
27	`# brt -doom controls (DOS scancodes; see chocolate-doom default.cfg)`
28	`use_mouse 1`
29	`mouseb_fire 0`
30	`mouseb_strafe 0`
31	`mouseb_forward 0`
32	`mouseb_speed 0`
33	`grabmouse 1`
34	`mouse_sensitivity 7`
35
36	`# Move: WASD`
37	`key_up 17`
38	`key_down 31`
39	`key_strafeleft 30`
40	`key_straferight 32`
41
42	`# Look / turn: arrow keys`
43	`key_left 75`
44	`key_right 77`
45
46	`# Space = use (classic Doom has no jump)`
47	`key_use 57`
48
49	`# Right Shift = fire`
50	`key_fire 54`
51
52	`# Run on ]`
53	`key_speed 27`
54	`EOF`
55	`}`
56
57	`brt_doom_ensure_wad() {`
58	`local zip tmpdir`
59
60	`if [[ -f "$BRT_DOOM_IWAD" ]]; then`
61	`return 0`
62	`fi`
63
64	`brt_require curl`
65	`brt_require unzip`
66
67	`brt_info "Downloading Freedoom WAD (first run only)..."`
68	`zip=$(mktemp "${TMPDIR:-/tmp}/brt-freedoom.XXXXXX.zip")`
69	`tmpdir=$(mktemp -d "${TMPDIR:-/tmp}/brt-freedoom.XXXXXX")`
70
71	`if ! curl -fsSL --progress-bar "$BRT_FREEDOOM_URL" -o "$zip"; then`
72	`rm -f "$zip"`
73	`rm -rf "$tmpdir"`
74	`brt_error "Failed to download Freedoom from ${BRT_FREEDOOM_URL}"`
75	`brt_info "Place doom1.wad or freedoom1.wad in ${BRT_DOOM_DIR}/"`
76	`return 1`
77	`fi`
78
79	`unzip -qq -o "$zip" -d "$tmpdir" \|\| {`
80	`rm -f "$zip"`
81	`rm -rf "$tmpdir"`
82	`brt_error "Failed to extract Freedoom archive"`
83	`return 1`
84	`}`
85
86	`local wad`
87	`wad=$(find "$tmpdir" -name 'freedoom1.wad' -print -quit)`
88	`if [[ -z "$wad" ]]; then`
89	`rm -f "$zip"`
90	`rm -rf "$tmpdir"`
91	`brt_error "freedoom1.wad not found in archive"`
92	`return 1`
93	`fi`
94
95	`cp "$wad" "$BRT_DOOM_IWAD"`
96	`rm -f "$zip"`
97	`rm -rf "$tmpdir"`
98	`brt_ok "Installed ${BRT_DOOM_IWAD}"`
99	`}`
100
101	`brt_doom_find_wad() {`
102	`local wad="${1:-}"`
103
104	`if [[ -n "$wad" && -f "$wad" ]]; then`
105	`case "$wad" in`
106	`~/*) wad="${HOME}/${wad#~/}" ;;`
107	`~) wad="$HOME" ;;`
108	`esac`
109	`if command -v realpath &>/dev/null; then`
110	`realpath "$wad"`
111	`else`
112	`(cd "$(dirname "$wad")" && printf '%s/%s\n' "$(pwd)" "$(basename "$wad")")`
113	`fi`
114	`return 0`
115	`fi`
116
117	`if [[ -f "$BRT_DOOM_IWAD" ]]; then`
118	`printf '%s\n' "$BRT_DOOM_IWAD"`
119	`return 0`
120	`fi`
121
122	`for wad in "${HOME}/.brt/doom/doom1.wad" "${HOME}/.brt/doom/DOOM1.WAD" \`
123	`"${HOME}/.brt/doom/freedoom1.wad"; do`
124	`if [[ -f "$wad" ]]; then`
125	`printf '%s\n' "$wad"`
126	`return 0`
127	`fi`
128	`done`
129
130	`return 1`
131	`}`
132
133	`brt_doom_ensure_binary() {`
134	`if [[ -x "$BRT_DOOM_BIN" ]]; then`
135	`return 0`
136	`fi`
137
138	`brt_require git`
139	`brt_require make`
140	`brt_require cc`
141
142	`mkdir -p "$BRT_DOOM_DIR"`
143
144	`if [[ ! -d "${BRT_DOOM_SRC}/.git" ]]; then`
145	`brt_info "Fetching doom-ascii ${BRT_DOOM_VERSION} (first run only)..."`
146	`git clone --depth 1 --branch "${BRT_DOOM_VERSION}" "$BRT_DOOM_REPO" "$BRT_DOOM_SRC" \`
147	`\|\| {`
148	`brt_error "Failed to clone doom-ascii"`
149	`return 1`
150	`}`
151	`fi`
152
153	`brt_info "Building doom-ascii..."`
154	`if ! make -C "$BRT_DOOM_SRC" -j"$(sysctl -n hw.ncpu 2>/dev/null \|\| nproc 2>/dev/null \|\| echo 2)"; then`
155	`brt_error "Failed to build doom-ascii (need Xcode CLT or gcc)"`
156	`return 1`
157	`fi`
158
159	`local built=""`
160	`for built in \`
161	`"${BRT_DOOM_SRC}/game/doom-ascii" \`
162	`"${BRT_DOOM_SRC}/_unix/game/doom-ascii" \`
163	`"${BRT_DOOM_SRC}/_unix/obj/doom-ascii"; do`
164	`if [[ -f "$built" ]]; then`
165	`cp "$built" "$BRT_DOOM_BIN"`
166	`chmod +x "$BRT_DOOM_BIN"`
167	`brt_ok "Built ${BRT_DOOM_BIN}"`
168	`return 0`
169	`fi`
170	`done`
171
172	`brt_error "Build finished but doom-ascii binary is missing"`
173	`return 1`
174	`}`
175
176	`brt_doom_term_restore() {`
177	`[[ -w /dev/tty ]] \|\| return 0`
178	`printf '\033[?25h\033[0m\033[r' >/dev/tty 2>/dev/null \|\| true`
179	`stty sane </dev/tty 2>/dev/null \|\| true`
180	`}`
181
182	`brt_doom_on_exit() {`
183	`brt_doom_term_restore`
184	`}`
185
186	`brt_doom() {`
187	`local wad_arg="" scaling rc=0`
188	`local -a extra_args=()`
189
190	`while [[ $# -gt 0 ]]; do`
191	`case "$1" in`
192	`-h\|--help)`
193	`cat <<EOF`
194	`brt -doom — play Doom in the terminal`
195
196	`Controls:`
197	`WASD Move (forward / back / strafe)`
198	`Mouse move Turn (if terminal/backend supports mouse reporting)`
199	`Left click Fire (if terminal/backend supports mouse reporting)`
200	`Arrow keys Turn fallback`
201	`Space Use doors and switches`
202	`Right Shift Fire fallback`
203	`] Run`
204	`Esc Menu`
205	`Ctrl+C Quit`
206
207	`Options:`
208	`--wad <file> Use a specific WAD (default: Freedoom, auto-downloaded)`
209	`--scaling <N> Display scale 2–4 (smaller = larger; default: auto)`
210
211	`Requires: git, make, and a C compiler on first run.`
212	`EOF`
213	`return 0`
214	`;;`
215	`--wad)`
216	`wad_arg="${2:-}"`
217	`[[ -n "$wad_arg" ]] \|\| { brt_error "--wad requires a path"; exit 1; }`
218	`shift 2`
219	`;;`
220	`--scaling)`
221	`extra_args+=("-scaling" "${2:-}")`
222	`[[ -n "${2:-}" ]] \|\| { brt_error "--scaling requires a number"; exit 1; }`
223	`shift 2`
224	`;;`
225	`*)`
226	`if [[ -z "$wad_arg" && -f "$1" ]]; then`
227	`wad_arg="$1"`
228	`shift`
229	`else`
230	`brt_error "Unknown option: $1"`
231	`brt_info "Run: brt -doom --help"`
232	`exit 1`
233	`fi`
234	`;;`
235	`esac`
236	`done`
237
238	`brt_doom_ensure_binary \|\| exit 1`
239	`brt_doom_write_config`
240
241	`local iwad`
242	`if ! iwad=$(brt_doom_find_wad "$wad_arg"); then`
243	`brt_doom_ensure_wad \|\| exit 1`
244	`iwad=$(brt_doom_find_wad "") \|\| {`
245	`brt_error "No WAD file found"`
246	`exit 1`
247	`}`
248	`fi`
249
250	`local scaling_flag`
251	`scaling_flag=$(brt_doom_scaling)`
252	`if ((${#extra_args[@]} == 0)); then`
253	`extra_args=("-scaling" "$scaling_flag")`
254	`fi`
255	`extra_args+=("-chars" "block" "-kpsmooth" "8")`
256
257	`brt_info "WAD: ${iwad}"`
258	`brt_info "Renderer: unicode block cells (-chars block)"`
259	`brt_info "Controls: mouse move/click (when supported) · arrows/Right Shift fallback · WASD move · Ctrl+C quit"`
260
261	`trap 'brt_doom_on_exit' EXIT INT TERM`
262
263	`set +e`
264	`(`
265	`cd "$BRT_DOOM_DIR" \|\| exit 1`
266	`exec "$BRT_DOOM_BIN" \`
267	`-iwad "$iwad" \`
268	`"${extra_args[@]}"`
269	`)`
270	`rc=$?`
271	`set -e`
272
273	`brt_doom_term_restore`
274
275	`if (( rc == 0 \|\| rc == 130 \|\| rc == 143 )); then`
276	`return 0`
277	`fi`
278	`brt_error "Doom exited with code ${rc}"`
279	`return "$rc"`
280	`}`
281

lib/doom.sh