Ver Fonte

README: plain step by step install guide

uwu há 2 meses atrás
pai
commit
0ba49d1cc0
1 ficheiros alterados com 79 adições e 14 exclusões
  1. 79 14
      README.md

+ 79 - 14
README.md

@@ -32,26 +32,91 @@ is backed up and can be reverted with `uninstall.sh`.
 
 ## Install
 
+Step by step. Everything is copy-paste, no Linux knowledge needed beyond
+opening a terminal.
+
+**Step 1. Make sure the game uses Proton.**
+
+In Steam: right click the game > Properties > Compatibility > tick "Force the
+use of a specific Steam Play compatibility tool" and pick Proton Experimental.
+
+**Step 2. Get this repo.**
+
+Open a terminal and run:
+
+```bash
+git clone https://github.com/WallpaperEngineLover/embarrassed-shina-linux-proton.git ~/shina-linux-patch
+```
+
+No git? On the repo page press the green "Code" button, "Download ZIP", unzip
+it into your home folder and rename the folder to `shina-linux-patch`. The
+folder must sit at a path with no spaces and no `:` in it. `LD_PRELOAD` breaks
+on such paths, so the installer checks and refuses them.
+
+**Step 3. Install the tools the installer needs.**
+
+You need `gcc`, `patch`, `python3` and the .NET SDK. Pick your distro:
+
+```bash
+# Ubuntu / Mint / Pop
+sudo apt install gcc patch python3 dotnet-sdk-8.0
+
+# Fedora / Nobara
+sudo dnf install gcc patch python3 dotnet-sdk-9.0
+
+# Arch / CachyOS / EndeavourOS
+sudo pacman -S gcc patch python3 dotnet-sdk
+```
+
+**Step 4. Run the installer.**
+
+```bash
+cd ~/shina-linux-patch
+bash install.sh
+```
+
+It finds the game on its own. If it can't, it says so, and you run it again
+with the game folder spelled out:
+
+```bash
+bash install.sh "/path/to/steamapps/common/Embarrassed Shina-chan~ the Naked Wandering College Girl"
+```
+
+**Step 5. Set the Steam launch options.**
+
+The installer's final output prints a path ending in `launcher.installed.sh`.
+In Steam: right click the game > Properties > General > Launch Options, and
+paste that line, for example:
+
+```
+"/home/you/shina-linux-patch/launcher.installed.sh" %command%
+```
+
+Keep the quotes and the `%command%` exactly as printed.
+
+**Step 6. Play.**
+
+Start the game from Steam as usual. For most people the install ends here.
+
+**Step 7. Only if the keyboard does nothing in game (Wayland desktops).**
+
+Close the game fully, then:
+
 ```bash
-git clone <this-repo> && cd shina-linux-patch
-./install.sh            # auto-detects the game, or pass its folder explicitly
+cd ~/shina-linux-patch
+bash patches/05-wayland-keyboard.sh "/path/to/steamapps/common/Embarrassed Shina-chan~ the Naked Wandering College Girl"
 ```
 
-Clone to a path without spaces or `:` (e.g. `~/shina-linux-patch`).
-`LD_PRELOAD` cannot handle such paths and the installer refuses them.
+and start the game again. On X11 this step is never needed.
 
-Then, as the installer prints:
+**Undo everything:**
 
-1. Steam -> the game -> Properties -> Launch Options:
-   ```
-   "/abs/path/to/launcher.installed.sh" %command%
-   ```
-2. Wayland only (keyboard focus): close the game fully, then
-   ```
-   bash patches/05-wayland-keyboard.sh "/path/to/.../Embarrassed Shina-chan~ ..."
-   ```
+```bash
+cd ~/shina-linux-patch
+bash uninstall.sh "/path/to/steamapps/common/Embarrassed Shina-chan~ the Naked Wandering College Girl"
+```
 
-Launch from Steam. Revert anytime: `./uninstall.sh "/path/to/...game folder"`.
+then clear the Launch Options in Steam.
 
 ## The fixes