Merge branch 'main' into omit_directory

Author: Herbie34

README.md

@@ -16,6 +16,8 @@ Features:
 * Quests to-do list.
 * Chests hidden in directories.
 
+See [this blog post](https://olano.dev/blog/deconstructing-the-role-playing-videogame/) for background on the development process.
+
 ## Installation
 
 ### From binary
@@ -234,7 +236,3 @@ The hero's class can be changed at the home directory using `rpg-cli class <name
 ## Troubleshooting
 
 * The release binary for macOS [is not signed](https://github.com/facundoolano/rpg-cli/issues/27). To open it for the first time, right click on the binary and select "Open" from the menu.
-
-## Feedback appreciated!
-
-If you find any issue, have features ideas, gameplay suggestions or example shell scripts, feel free to [file an issue](https://github.com/facundoolano/rpg-cli/issues/new) to start a conversation.

shell/README.md

@@ -48,8 +48,8 @@ It can be integrated to the regular ls like this:
 ls () {
     command ls "$@"
     if [ $# -eq 0 ] ; then
-        rpg cd -f .
-        rpg ls
+        rpg-cli cd -f .
+        rpg-cli ls
     fi
 }
 ```
@@ -135,3 +135,16 @@ cd () {
     rpg-cli battle
 }
 ```
+
+### Staying in the current work directory on death
+
+By default the shell integrations will send the user back to the home directory after death. To prevent this, we can change back to the current directory after each battle
+
+For example for cd:
+```sh
+cd () {
+    builtin cd "$@"
+    rpg-cli cd -f .
+    rpg-cli battle; rpg-cli cd -f .
+}
+```

shell/example.ps1

@@ -0,0 +1,42 @@
+# Shell integration for Windows Terminal
+#
+# Note:
+# - I couldn't figure out how to override `cd`, so I used `cdir` instead.
+# - To avoid hitting the absolute path length limit, I made the created directories single-digit numbers.
+# - It seems that `&&` can be used in PowerShell 7, but it's not available in version 5, so I omitted the error handling.
+#
+# See:
+# - [about_Profiles - PowerShell | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles?view=powershell-5.1)
+# - [Migrating from Windows PowerShell 5.1 to PowerShell 7 - PowerShell | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/scripting/whats-new/migrating-from-windows-powershell-51-to-powershell-7?view=powershell-7.4#separate-profiles)
+#
+Set-Variable -Option Constant -Name RPG -Value "C:\your\path\to\rpg-cli.exe"
+
+function rpg() {
+    & $RPG $args
+    sync_rpg
+}
+
+function cdir() {
+    & $RPG cd $args
+    sync_rpg
+}
+
+function dn() {
+    $current = (Get-Item $PWD).BaseName
+    if ($current -match "^[0-9]+$") {
+        $next = (([int]$current) + 1) % 10
+        New-Item -ItemType Directory -ErrorAction SilentlyContinue $next > $null
+        cdir $next
+    } elseif (Test-Path "1") {
+        cdir 1
+    } else {
+        New-Item -ItemType Directory -ErrorAction SilentlyContinue "dungeon\1" > $null
+        cdir "dungeon/1"
+    }
+    rpg ls
+}
+
+function sync_rpg() {
+    $pwd = & $RPG pwd
+    Set-Location -Path $pwd
+}