117 lines
4.1 KiB
Markdown
117 lines
4.1 KiB
Markdown
# Scoundrel
|
|
|
|
This is a terminal port of the rogue-lite card game Scoundrel. I got really into Balatro for a week
|
|
and immediately started wanting to code a game. I stumbled upon a youtube video for a rogue-lite
|
|
card game you can play with just a deck of cards and decided to port it to the terminal as a preliminary exercise before I begin to write a new game (which may never happen, I have 5 other pressing projects that take priority over game development).
|
|
|
|
# Installation
|
|
|
|
You must have python installed on your machine...
|
|
|
|
1. clone the repository
|
|
2. cd into the repository and create a virtual environment `python3 -m venv venv`
|
|
3. activate the virtual environment `source venv/bin/activate`
|
|
4. install requirements `pip install -r requirements.txt`
|
|
5. run the game `python3 main.py`
|
|
|
|
# Rules
|
|
### 1. INTRODUCTION:
|
|
|
|
Welcome to Scoundrel! The solo rogue-lite dungeon crawler card game!
|
|
This is the unneccessary terminal port of the game by Dominic DiTaranto.
|
|
If you enjoy this port, check out my website for other cool stuff
|
|
https://www.domdit.com
|
|
|
|
Table Of Contents:
|
|
1. INTRODUCTION
|
|
3. CONTROLS
|
|
2. RULES
|
|
|
|
### 2. CONTROLS
|
|
|
|
Arrow Keys - Select a Card
|
|
|
|
Enter Button - Engage with a Card
|
|
|
|
s - Skip a Room
|
|
|
|
b - Fight Barehanded
|
|
|
|
p - Pause/Unpause
|
|
|
|
h - See High Scores (from start menu)
|
|
|
|
u - Change User Name (from start menu)
|
|
|
|
Esc - Exit Game
|
|
|
|
? - Takes you to this help page.
|
|
|
|
### 3.a RULES - Setup and Rules
|
|
|
|
You are a dungeon explorer making your way through a series of rooms.
|
|
A room is made up of 4 cards.
|
|
|
|
In each room you may encounter:
|
|
- Equippable Weapons (Diamond Suit Cards)
|
|
- Health Potions (Heart Suit Cards)
|
|
- Enemies (Spade and Club Suit Cards)
|
|
- Merchants (Joker Cards) [Not Yet Implemented]
|
|
|
|
Your goal is to traverse the rooms until the deck runs out of cards.
|
|
|
|
### 3.b RULES - Selecting a Card
|
|
|
|
When you enter a room, select a card by navigating to it with the arrow keys
|
|
and pressing Enter.
|
|
|
|
If the card is a weapon, you equip that weapon. Each weapon does as much damage
|
|
as its value. Picking up a weapon will automatically discard your currently equipped weapon.
|
|
|
|
If the card is a health potion, you will gain life equal to the value of the card.
|
|
Your life may not exceed 20.
|
|
|
|
You can skip a room by pressing s, but you cannot skip two rooms in a row. the room
|
|
that you skip gets moved to the bottom of the deck to be traversed through later.
|
|
|
|
### 3.c RULES - Combat
|
|
|
|
If you select an enemy, you enter the combat phase.
|
|
|
|
If you do not have a weapon equipped you will take damage to your life points
|
|
equal to the value of the enemy card. This is called barehanded combat.
|
|
|
|
If you have an equipped weapon and the value of the weapon is greater than the enemy value
|
|
You do not take any damage to your health. Your weapon becomes damaged and you can only
|
|
attack enemies with a value lower than the previous enemy's value. This is the weapons damage rating.
|
|
|
|
If you attack an enemy with a weapon that has a value lower than the enemy's value, you
|
|
take damage equal to the enemy value - the weapon value. Example: if your weapon is a 5
|
|
and the enemy is an 8, you will take 3 damage.
|
|
|
|
### 3.d RULES - Combat Continued
|
|
|
|
If you attack an enemy with a value higher than the weapon's damage rating,
|
|
you take all of that damage as if it were barehanded. You will lose life equal
|
|
to the value of the enemy.
|
|
|
|
You should only attack enemies with a weapon that has a damage rating above or equal
|
|
to the enemy's value. There will be situations where you have no choice but to take
|
|
the barehanded damage combat. This is part of the strategy element.
|
|
|
|
Your Weapon's damage rating is shown in the brackets next to the weapon.
|
|
|
|
When a room only has 1 card left, you move on to the next room. That card follows you
|
|
into the next room
|
|
|
|
### 3.e RULES - Scoring
|
|
|
|
If you die, the remaining monster's values are subtracted from your score.
|
|
The negative value is your score.
|
|
|
|
If you beat the whole dungeon, your score is your positive life points.
|
|
|
|
|
|
# Future Updates
|
|
- Endless mode: reshuffle the deck and keep playing
|
|
- Jokers as Merchants: Add jokers back to the deck and have them either buff you or hurt you based on RNG.
|