Improve 3DS documentation (#3462)

This commit is contained in:
Stephen C. Wills 2021-11-10 12:13:47 -05:00 committed by GitHub
commit c15123688a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 115 additions and 54 deletions

View file

@ -224,7 +224,7 @@ make -j$(nproc)
```
The output files will be generated in the build folder.
[Nintendo 3DS manual](/docs/manual/platforms/n3ds.md)
[Nintendo 3DS manual](/docs/manual/platforms/3ds.md)
</details>
<details><summary>PlayStation Vita</summary>

View file

@ -66,13 +66,22 @@ When the transfer is done you can disconnect your device and press "Check again"
<details><summary>Nintendo 3DS</summary>
### .cia installation
Download `devilutionx.cia` from the [latest release](https://github.com/diasurgical/devilutionX/releases/latest) and place it on your SD card.
This file will be used later to install the game on the 3DS console.
- Copy `devilutionx.cia` to your SD card.
- Copy the Diablo and Hellfire MPQ files to `sd:/3ds/devilutionx/`. You do not need to copy devilutionx.mpq.
- Install `devilutionx.cia` with a title manager (e.g. [FBI](https://github.com/Steveice10/FBI)).
- `devilutionx.cia` can be removed after being installed.
- Launch Diablo from your 3DS Homemenu.
Copy the MPQ files to the `devilutionx` subfolder under the `3ds` folder on your SD card (`/3ds/devilutionx`). The game will read these files from this location.
You do not need a copy of `devilutionx.mpq` on your SD card to run the game on 3DS.
To avoid errors when you run the game, if you have an old version of `devilutionx.mpq` in the folder, you should remove it now.
![image](https://user-images.githubusercontent.com/9203145/141046152-61be39dc-d14e-4b10-accf-1755a93972f7.png)
Put the SD card back into the 3DS console and then power it on.
Use a title manager such as [FBI](https://github.com/Steveice10/FBI) to install `devilutionx.cia`.
You will no longer need `devilutionx.cia` after this step, and so it can be removed after the installation.
![image](https://user-images.githubusercontent.com/9203145/141047377-789e5f1c-d049-4a25-82bb-8b3572d791cf.png)
[Nintendo 3DS manual](/docs/manual/platforms/3ds.md)
</details>

View file

@ -0,0 +1,99 @@
# DevilutionX (Diablo 1) for Nintendo 3DS
## Installation
Look for the latest release on the
[Releases](https://github.com/diasurgical/devilutionX/releases) page.
Installation instructions can be found on the [Installing](/docs/installing.md) page.
## Usage
* Launch Diablo from your 3DS Homemenu.
## Controls
* Circle-Pad 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
* Start + ↑: game menu (alt: Start + Select)
* Start + ↓: toggle automap
* Start + ←: character sheet (alt: ZL or Start + L)
* Start + →: inventory (alt: ZR or Start + R)
* Start + X: toggle zoom
* Select + D-Pad: move automap or simulate mouse
* Select + A/B/X/Y: Spell hotkeys
* Select + ZL: quest log (alt: Start + Y)
* Select + ZR: spell book (alt: Start + B)
## Touchpad
* Single finger drag: move the mouse pointer (pointer jumps to finger)
* Single short tap: left mouse click
## Multiplayer
The 3DS currently supports cross-platform Multiplayer in TCP mode.
To play, you will need to enable Wi-Fi on the console and set up a network connection in System Settings.
For more general information about Multiplayer and how to set up your network for TCP games,
refer to the [DevilutionX Multiplayer guide](https://github.com/diasurgical/devilutionX/wiki/Multiplayer).
When playing Multiplayer, guests will experience better performance than hosts.
When playing cross-platform, it is recommended to host your game session
on another platform with more capable hardware.
## Translations
The 3DS version of the game will attempt to detect the appropriate
language based on your 3DS console's language setting.
Chinese, Korean, and Japanese users will need to download
[fonts.mpq](https://github.com/diasurgical/devilutionx-assets/releases/download/v1/fonts.mpq)
or the text will be missing.
It is currently not recommended to use the Chinese, Korean, or Japanese translations on old 3DS models.
The game will load additional symbols into system memory as needed while you continue to play the game.
There is not enough memory in the old 3DS models to hold all the symbols in memory.
It is therefore possible to run out of memory on the console and crash the game simply by using these translations.
To change the language used by the game, you will need to
[modify diablo.ini](https://github.com/diasurgical/devilutionX/wiki/DevilutionX-diablo.ini-configuration-guide#language).
The config folder path for 3DS is the same as the data folder for the MPQs (`/3ds/devilutionx` on your SD card).
## Performance tips
New 3DS models have significantly improved hardware compared to old models.
To improve the performance of the game on old 3DS models, you will want to
[modify diablo.ini](https://github.com/diasurgical/devilutionX/wiki/DevilutionX-diablo.ini-configuration-guide).
The config folder path for 3DS is the same as the data folder for the MPQs (`/3ds/devilutionx` on your SD card).
In particular, you will see a significant performance improvement
if you set the game to Diablo's original resolution of 640x480.
```ini
[Graphics]
Width=640
Height=480
```
After making this change, if you would like the game to stretch to fit the full area of the top screen,
use `Fit to Screen=1`. If instead you do not like the display to be stretched, use `Fit to Screen=0`.
Because 3DS uses SDL1, many of the graphics settings do not apply.
The following represents the full list of applicable settings.
* Width
* Height
* Fit to Screen
* Blended Transparency
* Gamma Correction
* Color Cycling
* FPS Limiter
## Resources
* Discord: https://discord.gg/YQKCAYQ
* GitHub: https://github.com/diasurgical/devilutionX

View file

@ -1,47 +0,0 @@
# DevilutionX (Diablo 1) for Nintendo 3DS
## Installation
Start by downloading [devilutionx-3ds.cia](https://github.com/diasurgical/devilutionX/releases/latest/download/devilutionx-3ds.cia).
#### Install DevilutionX: Diablo
1. Extract `devilutionx.cia` and place it on your SD card.
2. Copy `diabdat.mpq` from your Diablo CD (or GoG install folder) to `sd:/3ds/devilutionx/`.
3. Put the SD card back into the 3DS and install `devilutionx.cia` using a title manager (e.g. [FBI](https://github.com/Steveice10/FBI)).
1. `devilutionx.cia` can be removed after being installed.
##### Install DevilutionX: Diablo - Hellfire
5. Copy `hellfire.mpq` `hfmonk.mpq` `hfmusic.mpq` and `hfvoice.mpq` from your Hellfire CD (or GoG install folder) to `sd:/3ds/devilutionx/`.
## Usage
- Launch Diablo from your 3DS Homemenu.
## Controls
- Circle-Pad 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
- Start + ↑: game menu (alt: Start + Select)
- Start + ↓: toggle automap
- Start + ←: character sheet (alt: ZL or Start + L)
- Start + →: inventory (alt: ZR or Start + R)
- Start + X: toggle zoom
- Select + D-Pad: move automap or simulate mouse
- Select + A/B/X/Y: Spell hotkeys
- Select + ZL: quest log (alt: Start + Y)
- Select + ZR: spell book (alt: Start + B)
## Touchpad
- Single finger drag: move the mouse pointer (pointer jumps to finger)
- Single short tap: left mouse click
## Resources
* Discord: https://discord.gg/YQKCAYQ
* GitHub: https://github.com/diasurgical/devilutionX