ref: befe254a8a0d499e9a925b7ca9d1a73bbb484583
parent: 4da095780a50c2ee473afc4e8907e706d4150fb5
author: sirjofri <sirjofri@sirjofri.de>
date: Mon Feb 16 17:38:06 EST 2026
adds man page
--- /dev/null
+++ b/README
@@ -1,0 +1,73 @@
+
+ SCOUNDREL(1) SCOUNDREL(1)
+
+ NAME
+ scoundrel - rogue-like dungeon crawler card game.
+
+ SYNOPSIS
+ scoundrel
+
+ DESCRIPTION
+ Scoundrel is a rogue-like dungeon crawler card game where
+ different cards are assigned values for monsters, weapons
+ and potions.
+
+ The card colors:
+
+ Spades and Clubs
+ These are monsters. They deal damage according to their
+ card value. Face cards (J, Q, K, A) are equivalent to
+ 11, 12, 13, 14.
+
+ Hearts
+ These are health potions that heal the HP of the player
+ according to their card value. You can only take one
+ potion per room, and heal to a max HP value of 20.
+
+ Diamonds
+ These are weapons that are equipped when clicked. When
+ attacking monsters with a weapon, the damage is reduced
+ by the value of the weapon card. The player can only
+ attack monsters with the same weapon if the damage of
+ the attacked monster is smaller than the value of the
+ last attacked monster.
+
+ After starting the game with the s key, the player is enter-
+ ing several rooms of the dungeon sequentially. Each room is
+ presented as four random cards. The player can choose to
+ skip a room by pressing the n key, however the player can
+ only skip one room in a row.
+
+ When the room is not skipped, the player has to clear the
+ room by handling three of the four cards. The last card will
+ be brought into the next room.
+
+ The cards of a skipped room are placed at the end of the
+ deck; the player will face them later.
+
+ If there are not enough cards left to fill a room, the game
+ ends.
+
+ If the player's HP reach 0, the game ends.
+
+ Additional commands:
+
+ s Start the game.
+
+ r Reset and start a new game.
+
+ n Try to skip this room.
+
+ w Decide to use the weapon, if equipped. A red bar indi-
+ cates that this weapon will be used, if legal.
+
+ 1, 2, 3, 4
+ Select card to fight or use.
+
+ FILES
+ ./img/*
+ card images
+
+ SOURCE
+ https://shithub.us/sirjofri/scoundrel
+
--- /dev/null
+++ b/scoundrel1
@@ -1,0 +1,70 @@
+.TH SCOUNDREL 1
+.SH NAME
+scoundrel \- rogue-like dungeon crawler card game.
+.SH SYNOPSIS
+.B scoundrel
+.SH DESCRIPTION
+.B Scoundrel
+is a rogue-like dungeon crawler card game where different cards
+are assigned values for monsters, weapons and potions.
+.PP
+The card colors:
+.TP
+.I Spades and Clubs
+These are monsters. They deal damage according to their card value.
+Face cards (J, Q, K, A) are equivalent to 11, 12, 13, 14.
+.TP
+.I Hearts
+These are health potions that heal the HP of the player according to
+their card value. You can only take one potion per room, and heal to
+a max HP value of 20.
+.TP
+.I Diamonds
+These are weapons that are equipped when clicked. When attacking
+monsters with a weapon, the damage is reduced by the value of the
+weapon card. The player can only attack monsters with the same weapon
+if the damage of the attacked monster is smaller than the value of the
+last attacked monster.
+.PP
+After starting the game with the
+.B s
+key, the player is entering several rooms of the
+dungeon sequentially. Each room is presented as four random cards.
+The player can choose to skip a room by pressing the
+.B n
+key, however the player can only skip one room in a row.
+.PP
+When the room is not skipped, the player has to clear the room
+by handling three of the four cards. The last card will be brought
+into the next room.
+.PP
+The cards of a skipped room are placed at the end of the deck;
+the player will face them later.
+.PP
+If there are not enough cards left to fill a room, the game ends.
+.PP
+If the player's HP reach 0, the game ends.
+.PP
+Additional commands:
+.TP
+.B s
+Start the game.
+.TP
+.B r
+Reset and start a new game.
+.TP
+.B n
+Try to skip this room.
+.TP
+.B w
+Decide to use the weapon, if equipped. A red bar indicates that
+this weapon will be used, if legal.
+.TP
+.B 1, 2, 3, 4
+Select card to fight or use.
+.SH FILES
+.TP
+.B ./img/*
+card images
+.SH SOURCE
+.B https://shithub.us/sirjofri/scoundrel
--
⑨