feat: Implement game mechanics

Cargo.toml

@@ -10,8 +10,11 @@ license = "GPL-3.0-or-later"
 anyhow = "1.0.104"
 clap = { version = "4.6.7", features = ["derive"] }
 colored = "3.1.1"
+ctrlc = "3.5.2"
 dirs = "7.0.0"
 fs2 = "0.4.3"
+rand = "0.10.3"
+rustyline = "19.0.0"
 serde = { version = "1.0.229", features = ["derive"] }
 serde_json = "1.0.154"
 

README.md

@@ -64,7 +64,33 @@ There are also shell completions available in the [`res/completions/`](https://g
 ## Usage
 
 Run `incrust` to start the game.  
-Then type 'help' to see the list of available commands.
+Then type 'help' to see the list of available commands and 'guide' to see the game guide (shown below).
+
+```text
+Start compiling stuff by running the 'compile' command.
+You'll earn credits for each completed (and successful) compilation.
+Compilations have a small chance to fail upon completion, in which case
+you won't get rewarded with credits for it.
+Ongoing compilation can be interrupted by pressing Ctrl+C, but note that
+you won't get any credit for it either.
+
+Spend credits to upgrade your system resources and buy different perks by running
+the 'upgrade' command:
+
+- Buying CPU cores speeds up compile time
+  but also slightly increases chances of compilation failures
+- Buying RAM increases the credit reward per completed (and successful) compilation
+  but also slightly increases the compile time
+- Buying Disk space reduces chances of compilation failures
+  but also slightly reduces the credit reward per completed (and successful) compilation
+- Other bonuses can be acquired through different one-time purchase perks
+
+Unlocked perks can be enabled or disabled by running the 'manage' command.
+
+You can check the current status of your resources and perks by running the 'status' command.
+
+Progression is automatically saved and resumed between game sessions.
+```
 
 ## Documentation
 

doc/man/incrust.1.scd

@@ -28,9 +28,13 @@ Then type 'help' to see the list of available commands and 'guide' to see the ga
 
 *1* Failed to create or acquire the lockfile.
 
-*2* Failed to create or read the statefile.
+*2* Failed to create, read or write the statefile.
 
-*3* Failed to read the player's command.
+*3* Failed to initialize the command prompt editor.
+
+*4* Failed to register the interruption shortcut (Ctrl+C) handler for compilation.
+
+*5* Failed to retrieve the player's command.
 
 # BUGS