Add user manuals for OD, RetroFW, and Switch

Packaging/switch/readme.txt

@@ -1,47 +0,0 @@
-# Nintendo Switch Port of DevilutionX (Diablo)
-
-# How To Install:
- - Put `devilutionx.nro` and `CharisSILB.ttf` in into `/switch/devilutionx`
- - Copy diabdat.mpq from your CD (or GoG install folder) to `/switch/devilutionx`. Make sure it is all lowercase.
- - Launch `devilutionx.nro`. (Do not use album to launch; see the note below.)
- - *Note:* Hold R on any installed game and launch it. Do not use album to launch. If you use album, the homebrew will only have a small amount memory available, and the touch keyboard won't work. This is true for all homebrew, not just DevilutionX.
-
-# Joycon Controls
-- Left analog or D-Pad: move hero
-- A: attack nearby enemies, talk to townspeople and merchants, pickup/place items in the inventory, OK while in main menu
-- B: select spell, back while in menus
-- X: pickup items, open nearby chests and doors, use item in the inventory
-- Y: cast spell, delete character while in main menu
-- L: use health item from belt
-- R: use mana potion from belt
-- ZL or Start + Left: character sheet
-- ZR or Start + Right: inventory
-- Left analog click or Start + Down: toggle automap
-- Start + Up or Start + Select: game menu
-- Start + Left: character info
-- Start + Right: inventory
-- Select + A/B/X/Y: Spell hotkeys
-- Right analog: move automap or simulate mouse
-- Right analog click or Select + L: left mouse click
-- Select + Right analog click or Select + R: right mouse click
-- Select + ZL or Start + Y: quest log
-- Select + ZR or Start + B: spell book
-
-# Touch Controls
- - Single finger drag: move the mouse pointer (pointer jumps to finger)
- - Single short tap: left mouse click
- - Single short tap while holding a second finger down: right mouse click
- - Dual finger drag: drag'n'drop (left mouse button is held down)
- - Three finger drag: drag'n'drop (right mouse button is held down)
-
-# Credits
- - See list of contributors https://github.com/diasurgical/devilutionX/graphs/contributors
-
-# Legal
-This software is being released to the Public Domain. No assets of Diablo are being provided. You must own a copy of Diablo and have access to the assets beforehand in order to use this software.
-
-Battle.net® - Copyright © 1996 Blizzard Entertainment, Inc. All rights reserved. Battle.net and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.
-
-Diablo® - Copyright © 1996 Blizzard Entertainment, Inc. All rights reserved. Diablo and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.
-
-This software is in no way associated with or endorsed by Blizzard Entertainment®.

README.md

@@ -152,6 +152,8 @@ DEVKITPRO=<path to devkit> Packaging/switch/build.sh
 ```
 
 The nro-file will be generated in the build folder. Test with an emulator (RyuJinx) or real hardware.
+
+[Nintendo Switch manual](docs/manual/platforms/switch.md)
 </details>
 
 <details><summary>Haiku</summary>
@@ -204,6 +206,12 @@ Replace `<platform>` with one of: `retrofw`, `rg350`, or `gkd350h`.
 
 This prepares and uses the buildroot at `$HOME/buildroot-$PLATFORM-devilutionx`.
 
+End-user manuals are available here:
+
+* [RetroFW manual](docs/manual/platforms/retrofw.md)
+* [RG-350 manual](docs/manual/platforms/rg350.md)
+* [GKD350h manual](docs/manual/platforms/gkd350h.md)
+
 </details>
 
 <details><summary>Clockwork PI GameShell</summary>

docs/manual/platforms/gkd350h.md

@@ -0,0 +1,42 @@
+# DevilutionX (Diablo 1) for GKD350h
+
+![gkd-350h-devilutionx](https://user-images.githubusercontent.com/216339/73123835-32e41080-3f8c-11ea-970c-8dd159c6e4ef.jpg)
+
+## Installation
+
+1. Copy [devilutionx-gkd350h.opk](https://github.com/diasurgical/devilutionX/releases/latest/download/devilutionx-gkd350h.opk) to `/media/data/apps` or `/media/sdcard/apps/`.
+2. Copy `diabdat.mpq` (**all lowercase**) from your CD, or GoG install folder to:
+
+   ~~~
+   /usr/local/home/.local/share/diasurgical/devilution/diabdat.mpq
+   ~~~
+
+## Controls
+
+- Joystick / D-Pad: move hero
+- ○: attack nearby enemies, talk to townspeople and merchants, pickup/place items in the inventory, OK while in main menu
+- ×: select spell, back while in menus
+- △: pickup items, open nearby chests and doors, use item in the inventory
+- □: cast spell, delete character while in main menu
+- L: use health item from belt
+- R: use mana potion from belt
+- Select + ↑: game menu
+- Select + L or ←: character info
+- Select + R or →: inventory
+- Select + ↓: map
+- Select + □: Quest log
+- Select + ×: Spell book
+- Start + △○×□: Quick spell hotkeys
+
+## Known issues / quirks
+
+* Start and Select are swapped in this version because Start + D-Pad controls backlight on the GKD350h.
+* There is nothing to map mouse emulation to in this version because of this but it isn't necessary to play the game. Unfortunately, this also means that you can't move the automap.
+* This version looks uglier than on RG350 because it uses software scaling beacuse the IPU on the GKD350h doesn't work.
+
+Saves are compatible with PC saves from Diablo 1 and DevilutionX.
+
+## Resources
+
+* Discord: https://discord.gg/aQBQdDe
+* GitHub: https://github.com/diasurgical/devilutionX

docs/manual/platforms/retrofw.md

@@ -0,0 +1,54 @@
+# DevilutionX (Diablo 1) for RetroFW (RG300/RS-97/RS-07/LDK)
+
+Demo video:
+
+<a href="https://www.youtube.com/watch?v=fxpdc1iZK94" target="_blank"><img src="https://user-images.githubusercontent.com/216339/66889273-ae234700-efd9-11e9-8746-489f4eece210.jpg" height="300"></a>
+
+## Installation
+
+**Requires RetroFW 2.0+.**
+
+1. Install [devilutionx-retrofw.ipk](https://github.com/diasurgical/devilutionX/releases/latest/download/devilutionx-retrofw.ipk) using the Explorer app.
+2. Copy `diabdat.mpq` (**all lowercase**) from your CD, or GoG install folder to:
+
+   ~~~
+   ~/.local/share/diasurgical/devilution
+   ~~~
+
+`~` is your home directory, `/home/retrofw` by default.
+
+## Controls
+
+- D-pad: move hero
+- A: attack nearby enemies, talk to townspeople and merchants, pickup/place items in the inventory, OK while in main menu
+- B: select spell, back while in menus
+- X: pickup items, open nearby chests and doors, use item in the inventory
+- Y: cast spell, delete character while in main menu
+- R: use mana potion from belt
+- L: use health item from belt
+- Start + Select: game menu (alt: Start + ↑)
+- Start + L or ←: character info
+- Start + R or →: inventory
+- Start + ↓: map
+- Start + Y: Quest log
+- Start + B: Spell book
+- Select + A/B/X/Y: hot spell
+- Select + D-pad: move map/cursor
+- Select + L: left mouse click
+- Select + R: right mouse click
+- Suspend: map
+
+---
+
+Game saves and `diablo.ini` are located at:
+
+~~~
+~/.local/share/diasurgical/devilution
+~~~
+
+Saves are compatible with PC saves from Diablo 1 and DevilutionX.
+
+## Resources
+
+* Discord: https://discord.gg/aQBQdDe
+* GitHub: https://github.com/diasurgical/devilutionX

docs/manual/platforms/rg350.md

@@ -0,0 +1,58 @@
+# DevilutionX (Diablo 1) for the RG-350 handheld
+
+Demo video:
+
+<a href="https://youtu.be/ItA3TMiqXu8"><img src="https://user-images.githubusercontent.com/216339/66907570-73cda000-f001-11e9-9341-539fda20eff4.jpg" height="300"></a>
+
+## Installation
+
+**Requires firmware v1.5+**
+
+1. Copy [devilutionx-rg350.opk](https://github.com/diasurgical/devilutionX/releases/latest/download/devilutionx-rg350.opk) to `/media/sdcard/APPS/`.
+
+2. Copy `diabdat.mpq` (**all lowercase**) from your CD, or GoG install folder to:
+
+   ~~~
+   /media/home/.local/share/diasurgical/devilution/diabdat.mpq
+   ~~~
+
+   **NOTE:** You can copy `diabdat.mpq` to sdcard instead and create a symlink at the expected location. To do this, SSH into your RG350 and run:
+
+   ~~~bash
+   ln -sf /media/sdcard/<path_to_diabdat.mpq> /media/home/.local/share/diasurgical/devilution/diabdat.mpq
+   ~~~
+
+## Controls
+
+- Left analog or D-Pad: move hero
+- A: attack nearby enemies, talk to townspeople and merchants, pickup/place items in the inventory, OK while in main menu
+- B: select spell, back while in menus
+- X: pickup items, open nearby chests and doors, use item in the inventory
+- Y: cast spell, delete character while in main menu
+- L1: use health item from belt
+- R1: use mana potion from belt
+- L2: character sheet (alt: Start + L1 or ←)
+- R2: inventory (alt: Start + L2 or →)
+- Left analog click: toggle automap (alt: Start + ↓)
+- Start + Select: game menu (alt: Start + ↑)
+- Select + A/B/X/Y: Spell hotkeys
+- Right analog: move automap or simulate mouse
+- Right analog click: left mouse click (alt: Select + L1)
+- Select + Right analog click: right mouse click (alt: Select + R1)
+- Select + L2: quest log (alt: Start + Y)
+- Select + R2: spell book (alt: Start + B)
+
+---
+
+Game saves and `diablo.ini` are located at:
+
+~~~
+/media/home/.local/share/diasurgical/devilution/
+~~~
+
+Saves are compatible with PC saves from Diablo 1 and DevilutionX.
+
+## Resources
+
+* Discord: https://discord.gg/aQBQdDe
+* GitHub: https://github.com/diasurgical/devilutionX

docs/manual/platforms/switch.md

@@ -0,0 +1,46 @@
+# DevilutionX (Diablo 1) for Nintendo Switch
+
+## Installation
+
+1. Download and unzip [devilutionx-switch.zip](https://github.com/diasurgical/devilutionX/releases/latest/download/devilutionx-switch.zip).
+2. Put [`devilutionx.nro] and `CharisSILB.ttf` in into `/switch/devilutionx`
+3. Copy `diabdat.mpq` from your CD (or GoG install folder) to `/switch/devilutionx`. Make sure it is all lowercase.
+
+## Usage
+
+Launch `devilutionx.nro`. (Do not use album to launch; see the note below.)
+
+*Note:* Hold R on any installed game and launch it. Do not use album to launch. If you use album, the homebrew will only have a small amount memory available, and the touch keyboard won't work. This is true for all homebrew, not just DevilutionX.
+
+## Joycon Controls
+
+- Left analog or D-Pad: move hero
+- A: attack nearby enemies, talk to townspeople and merchants, pickup/place items in the inventory, OK while in main menu
+- B: select spell, back while in menus
+- X: pickup items, open nearby chests and doors, use item in the inventory
+- Y: cast spell, delete character while in main menu
+- L: use health item from belt
+- R: use mana potion from belt
+- ZL: character sheet (alt: Start + L or ←)
+- ZR: inventory (alt: Start + ZL or →)
+- Left analog click: toggle automap (alt: Start + ↓)
+- Start + Select: game menu (alt: Start + ↑)
+- Select + A/B/X/Y: Spell hotkeys
+- Right analog: move automap or simulate mouse
+- Right analog click: left mouse click (alt: Select + L)
+- Select + Right analog click: right mouse click (alt: Select + R)
+- Select + ZL: quest log (alt: Start + Y)
+- Select + ZR: spell book (alt: Start + B)
+
+## Touch Controls
+
+- Single finger drag: move the mouse pointer (pointer jumps to finger)
+- Single short tap: left mouse click
+- Single short tap while holding a second finger down: right mouse click
+- Dual finger drag: drag'n'drop (left mouse button is held down)
+- Three finger drag: drag'n'drop (right mouse button is held down)
+
+## Resources
+
+* Discord: https://discord.gg/aQBQdDe
+* GitHub: https://github.com/diasurgical/devilutionX