mirror of
https://github.com/libretro/docs.git
synced 2024-11-27 10:40:28 +00:00
Update mkdocs.yml. Add stone_soup.md
Add Dungeon Crawl Stone Soup documentation.
This commit is contained in:
parent
fc224e7e17
commit
86931818e4
BIN
docs/image/core/stone_soup/dat.png
Normal file
BIN
docs/image/core/stone_soup/dat.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 39 KiB |
113
docs/library/stone_soup.md
Normal file
113
docs/library/stone_soup.md
Normal file
@ -0,0 +1,113 @@
|
||||
# Dungeon Crawl Stone Soup
|
||||
|
||||
## Background
|
||||
Dungeon Crawl Stone Soup is a free roguelike game of exploration and treasure-hunting in dungeons filled with dangerous and unfriendly monsters in a quest for the mystifyingly fabulous Orb of Zot.
|
||||
|
||||
The Dungeon Crawl Stone Soup core has been authored by
|
||||
|
||||
- DCSS Team
|
||||
|
||||
The Dungeon Crawl Stone Soup core is licensed under
|
||||
|
||||
- [GPLv2+](https://github.com/libretro/crawl-ref/blob/master/crawl-ref/licence.txt)
|
||||
|
||||
A summary of the licenses behind RetroArch and its cores have found [here](https://docs.libretro.com/tech/licenses/).
|
||||
|
||||
#### How to start the Dungeon Crawl Stone Soup core:
|
||||
|
||||
1. Create an empty directory to hold game data.
|
||||
2. Copy [https://github.com/libretro/crawl-ref/tree/master/crawl-ref/source/dat](https://github.com/libretro/crawl-ref/tree/master/crawl-ref/source/dat) into the root of game directory.
|
||||
3. Create a file named game.crawlrc in the root of the game directory.
|
||||
4. Load game.crawlrc with the Dungeon Crawl Stone Soup core.
|
||||
|
||||
![](../image/core/stone_soup/dat.png)
|
||||
|
||||
## Extensions
|
||||
|
||||
Content that can be loaded by the Dungeon Crawl Stone Soup core have the following file extensions:
|
||||
|
||||
- .crawlrc
|
||||
|
||||
## Features
|
||||
|
||||
Frontend-level settings or features that the Dungeon Crawl Stone Soup core respects.
|
||||
|
||||
| Feature | Supported |
|
||||
|-------------------|:---------:|
|
||||
| Restart | ✕ |
|
||||
| Screenshots | ✕ |
|
||||
| Saves | ✔ |
|
||||
| States | ✕ |
|
||||
| Rewind | ✕ |
|
||||
| Netplay | ✕ |
|
||||
| Core Options | ✕ |
|
||||
| RetroAchievements | ✕ |
|
||||
| RetroArch Cheats | ✕ |
|
||||
| Native Cheats | ✕ |
|
||||
| Controls | ✔ |
|
||||
| Remapping | ✔ |
|
||||
| Multi-Mouse | ✕ |
|
||||
| Rumble | ✕ |
|
||||
| Sensors | ✕ |
|
||||
| Camera | ✕ |
|
||||
| Location | ✕ |
|
||||
| Subsystem | ✕ |
|
||||
| [Softpatching](https://docs.libretro.com/guides/softpatching/) | ✕ |
|
||||
| Disk Control | ✕ |
|
||||
| Username | ✕ |
|
||||
| Language | ✕ |
|
||||
| Crop Overscan | ✕ |
|
||||
| LEDs | ✕ |
|
||||
|
||||
### Directories
|
||||
|
||||
The Dungeon Crawl Stone Soup core's library name is 'Dungeon Crawl: Stone Soup'
|
||||
|
||||
The Dungeon Crawl Stone Soup core saves/loads to/from these directories.
|
||||
|
||||
**Loaded content's directory**
|
||||
|
||||
| File | Description |
|
||||
|:-------|:----------------------------------------:|
|
||||
| saves/ | Dungeon Crawl Stone Soup saves directory |
|
||||
|
||||
### Geometry and timing
|
||||
|
||||
- The Dungeon Crawl Stone Soup core's core provided FPS is 60
|
||||
- The Dungeon Crawl Stone Soup core's core provided sample rate is 44100 Hz
|
||||
- The Dungeon Crawl Stone Soup core's base width is 1024
|
||||
- The Dungeon Crawl Stone Soup core's base height is 768
|
||||
- The Dungeon Crawl Stone Soup core's max width is 1024
|
||||
- The Dungeon Crawl Stone Soup core's max height is 768
|
||||
- The Dungeon Crawl Stone Soup core's core provided aspect ratio is 0.0
|
||||
|
||||
## Devices
|
||||
|
||||
- Joypad
|
||||
- Pointer
|
||||
- Keyboard (Keyboard callback)
|
||||
|
||||
## Joypad
|
||||
|
||||
| User 1 input descriptors | RetroPad Inputs |
|
||||
|--------------------------|---------------------------------------------|
|
||||
| Enter | ![](../image/retropad/retro_b.png) |
|
||||
| Up | ![](../image/retropad/retro_dpad_up.png) |
|
||||
| Down | ![](../image/retropad/retro_dpad_down.png) |
|
||||
| Left | ![](../image/retropad/retro_dpad_left.png) |
|
||||
| Right | ![](../image/retropad/retro_dpad_right.png) |
|
||||
|
||||
## Pointer
|
||||
|
||||
| RetroPointer Inputs | Dungeon Crawl Stone Soup inputs |
|
||||
|--------------------------------------------------------------------------------------------------------------------------|---------------------------------|
|
||||
| ![](../image/retromouse/retro_mouse.png) or ![](../image/Button_Pack/Gestures/Gesture_Finger_Front.png) Pointer Position | Cursor |
|
||||
| ![](../image/retromouse/retro_left.png) or ![](../image/Button_Pack/Gestures/Gesture_Tap.png) Pointer Pressed | Click |
|
||||
|
||||
## External Links
|
||||
|
||||
- [Official Dungeon Crawl Stone Soup Website](https://crawl.develz.org/)
|
||||
- [Official Dungeon Crawl Stone Soup Github Repository](https://github.com/crawl/crawl)
|
||||
- [Libretro Dungeon Crawl Stone Soup Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/stonesoup_libretro.info)
|
||||
- [Libretro Dungeon Crawl Stone Soup Github Repository](https://github.com/libretro/crawl-ref)
|
||||
- [Report Libretro Dungeon Crawl Stone Soup Core Issues Here](https://github.com/libretro/libretro-meta/issues)
|
@ -96,6 +96,7 @@ pages:
|
||||
- 'Cave Story (NXEngine)': 'library/nxengine.md'
|
||||
- 'Dinothawr': 'library/dinothawr.md'
|
||||
- 'Doom (PrBoom)': 'library/prboom.md'
|
||||
- 'Dungeon Crawl Stone Soup': 'library/stone_soup.md'
|
||||
- 'Handheld Electronic (GW)': 'library/gw.md'
|
||||
- 'Minecraft (Craft)': 'library/craft.md'
|
||||
- 'Mr.Boom (Bomberman)': 'library/mr_boom.md'
|
||||
|
Loading…
Reference in New Issue
Block a user