libretro/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-11-24 01:09:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update craft.md: Sync doc with core template and truncate image paths

Browse Source
This commit is contained in:
Hedonium 2019-03-28 03:01:27 -04:00
parent 5992e9c12f
commit 65ef476218
9 changed files with 136 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/image/core/craft/draw_distance_10.png → docs/image/core/craft/10.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.5 MiB

After

Width:  |  Height:  |  Size: 1.5 MiB

0
docs/image/core/craft/fov_125.png → docs/image/core/craft/125.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.2 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

0
docs/image/core/craft/1920x1080.png → docs/image/core/craft/1920.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 1.4 MiB

0
docs/image/core/craft/draw_distance_32.png → docs/image/core/craft/32.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.8 MiB

After

Width:  |  Height:  |  Size: 1.8 MiB

0
docs/image/core/craft/320x240.png → docs/image/core/craft/320.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 163 KiB

After

Width:  |  Height:  |  Size: 163 KiB

0
docs/image/core/craft/fov_65.png → docs/image/core/craft/65.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.3 MiB

After

Width:  |  Height:  |  Size: 1.3 MiB

0
docs/image/core/craft/show_info_text_off.png → docs/image/core/craft/off.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

0
docs/image/core/craft/show_info_text_on.png → docs/image/core/craft/on.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

234
docs/library/craft.md
View File

@ -4,52 +4,62 @@
A simple Minecraft clone written in C using modern OpenGL (shaders).
### Features
## Features
* Simple but nice looking terrain generation using simplex noise.
* Biomes
* Water
* More than 20 types of blocks and more can be added easily.
* Supports plants (grass, flowers, trees, etc.) and transparency (glass).
* Simple clouds in the sky (they don't move).
* Day / night cycles and a textured sky dome.
* More sophisticated sunrise/sunset color blending
* Ambient occlusion for basic shading of blocks.
* World changes persisted in a sqlite3 database.
* Configurable draw distance. The draw distance has a big effect on the framerate, a draw distance of 1 or 2 can make this core playable even on very lightweight computers.
* Configurable field of view.
* Gamepad support (including analog stick support) configurable analog sensitivity and deadzones, preliminary mouse and keyboard support.
* Configurable resolutions, up to 4K.
* A ‘Jumping Flash’ mode that allows you to jump infinitely into the air all while the camera faces downwards.
- Simple but nice looking terrain generation using simplex noise.
- Biomes
- Water
- More than 20 types of blocks and more can be added easily.
- Supports plants (grass, flowers, trees, etc.) and transparency (glass).
- Simple clouds in the sky (they don't move).
- Day / night cycles and a textured sky dome.
- More sophisticated sunrise/sunset color blending
- Ambient occlusion for basic shading of blocks.
- World changes persisted in a sqlite3 database.
- Configurable draw distance. The draw distance has a big effect on the framerate, a draw distance of 1 or 2 can make this core playable even on very lightweight computers.
- Configurable field of view.
- Gamepad support (including analog stick support) configurable analog sensitivity and deadzones, preliminary mouse and keyboard support.
- Configurable resolutions, up to 4K.
- A ‘Jumping Flash’ mode that allows you to jump infinitely into the air all while the camera faces downwards.
### Author(s):
The Craft core has been authored by
Snes9x Team|dking|BassAceGold|ShadauxCat|Nebuleon
- Michael Fogleman
## Contribute to this documentation
The Craft core is licensed under
In order to propose improvements to this document, [visit it's corresponding source page on github](https://github.com/libretro/docs/tree/master/docs/library/craft.md). Changes are proposed using "Pull Requests."
- [MIT](https://github.com/libretro/Craft/blob/master/LICENSE.md)
## License
A summary of the licenses behind RetroArch and its cores have found [here](https://docs.libretro.com/development/licenses/).
MIT
## Requirements
## Extensions
- OpenGL or OpenGL ES
The Craft core does not feature extension use. Just load and start the core.
## How to start the Craft core:
- To start the Craft core, go to RetroArch's main menu screen. Select 'Load Core', then 'Craft'.
- Now, select 'Start Core'.
The content should now start running!
## Features
Frontend-level settings or features that the Craft core respects.
| Feature | Supported |
|-------------------|:---------:|
| Restart | ✕ |
| Saves | ✔ |
| States | ✕ |
| Rewind | ✕ |
| Netplay | ✕ |
| Core Options | ✔ |
| RetroAchievements | ✕ |
| RetroArch Cheats | ✕ |
| Native Cheats | ✕ |
| Controllers | ✔ |
| Controls | ✔ |
| Remapping | ✕ |
| Multi-Mouse | ✕ |
| Rumble | ✕ |
@ -57,116 +67,144 @@ The Craft core does not feature extension use. Just load and start the core.
| Camera | ✕ |
| Location | ✕ |
| Subsystem | ✕ |
| [Softpatching](https://docs.libretro.com/guides/softpatching/) | ✕ |
| Disk Control | ✕ |
| Username | ✕ |
| Language | ✕ |
| Crop Overscan | ✕ |
| LEDs | ✕ |
The Craft core's directory name is 'Craft'
## Directories
World data is saved/loaded to and from 'craft.db' in RetroArch's system directory.
The Craft core's library name is 'Craft'
The Craft core saves/loads to/from these directories.
**Frontend's System directory**
| File | Description |
|:--------:|:-----------:|
| craft.db | World data |
## Geometry and timing
- The Craft core's core provided FPS is 60.0
- The Craft core's core provided sample rate is 48000 Hz
- The Craft core's base width is 640
- The Craft core's base height is 480
- The Craft core's max width is 640
- The Craft core's max height is 480
- The Craft core's core provided aspect ratio is 16/9
## Core options
*The Craft core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.*
The Craft core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.
- **Resolution (restart)** (**640x480**/320x200/640x400/960x600/1280x800/1600x1000/1920x1200/2240x1400/2560x1600/2880x1800/3200x2000/3520x2200/3840x2400/7680x4320/15360x8640/16000x9000/320x240/320x480/360x200/360x240/360x400/360x480/400x224/480x272/512x224/512x240/512x384/512x512/640x224/640x240/640x448/720x576/800x480/800x600/960x720/1024x768/1280x720/1366x768/1600x900/1920x1080/2048x2048/4096x4096): Configure the resolution.
Settings with (Restart) means that core has to be closed for the new setting to be applied on next launch.
- **Resolution (restart)** [craft_resolution] (**640x480**|320x200|640x400|960x600|1280x800|1600x1000|1920x1200|2240x1400|2560x1600|2880x1800|3200x2000|3520x2200|3840x2400|7680x4320|15360x8640|16000x9000|320x240|320x480|360x200|360x240|360x400|360x480|400x224|480x272|512x224|512x240|512x384|512x512|640x224|640x240|640x448|720x576|800x480|800x600|960x720|1024x768|1280x720|1366x768|1600x900|1920x1080|2048x2048|4096x4096)
Configure the resolution.
??? note "Resolution - 320x240"
![](/image/core/craft320x240.png)
![](../image/core/craft/320.png)
??? note "Resolution - 1920x1080"
![](/image/core/craft1920x1080.png)
![](../image/core/craft/1920.png)
- **Show info text** (**Off**/On): Show game information in the upper left corner of Craft.
- **Show info text** [craft_show_info_text] (**disabled**|enabled)
Show game information in the upper left corner of Craft.
??? note "Show info text - Off"
![](/image/core/craftshow_info_text_off.png)
![](../image/core/craft/off.png)
??? note "Show info text - On"
![](/image/core/craftshow_info_text_on.png)
![](../image/core/craft/on.png)
- **Jumping Flash mode** (**Off**/On): Enabling this allows you to jump infinitely into the air all while the camera faces downwards.
- **Jumping Flash mode** (**Off**/On):
- **Field of view** (**65**/70/75/80/85/90/95/100/105/110/115/120/125/130/135/140/145/150): Configure the field of view.
Enabling this allows you to jump infinitely into the air all while the camera faces downwards.
- **Field of view** [craft_field_of_view] (**65** to 150 in increments of 5)
Configure the field of view.
??? note "Field of view - 65"
![](/image/core/craftfov_65.png)
![](../image/core/craft/65.png)
??? note "Field of view - 125"
![](/image/core/craftfov_125.png)
![](../image/core/craft/125.png)
- **Draw distance** (**10**/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/27/28/29/30/31/32/9/8/7/6/5/4/3/2/1): Configure the draw distance.
- **Draw distance** [craft_draw_distance] (1 to 32 in increments of 1. **10 is default**)
Configure the draw distance.
??? note "Draw distance - 10"
![](/image/core/craftdraw_distance_10.png)
![](../image/core/craft/10.png)
??? note "Draw distance - 32"
![](/image/core/craftdraw_distance_32.png)
![](../image/core/craft/32.png)
- **Inverted aim** (**Off**/On): Invert up and down crosshair aiming controls for the RetroPad and the RetroMouse.
- **Right analog sensitivity** (**0.0150**/0.0175/0.0200/0.0225/0.0250/0.0275/0.0300/0.0325/0.0350/0.0375/0.0400/0.0425/0.0450/0.0475/0.0500): Modify the RetroPad right analog stick's sensitivity.
- **Analog deadzone size** (**0.010**/0.015/0.020/0.025/0.030/0.035/0.040/0.045/0.050/0.055/0.060/0.065/0.070/0.075/0.080/0.085/0.090/0.095/0.100/0.110/0.115/0.120/0.125/0.130/0.135/0.140/0.145/0.150/0.155/0.160/0.165/0.170/0.175/0.180/0.185/0.190/0.195/0.200): Modify RetroPad analog sticks' deadzone.
- **Inverted aim** [craft_inverted_aim] (**disabled**|enabled)
## Controllers
Invert up and down crosshair aiming controls for the RetroPad and the RetroMouse.
*The Craft core supports the following controller setting(s), bolded controller settings are the default for the specified user(s):*
- **Right analog sensitivity** [craft_analog_sensitivity] (**0.0150** to 0.0500 in increments of 0.0025)
### User 1 - 16 Device Type(s)
Modify the RetroPad right analog stick's sensitivity.
* **RetroPad** - Joypad
- **Analog deadzone size** [craft_deadzone_radius] (**0.010** to 0.200 in increments of 0.005)
* RetroPad w/Analog - Joypad - **There is no reason to switch to this.**
Modify RetroPad analog sticks' deadzone.
## Joypad
### Controllers graph
| RetroPad Inputs | Craft core inputs |
| RetroPad Inputs | Craft Inputs |
|------------------------------------------------|---------------------------|
| ![](/image/retropad/retro_b.png) | Jump |
| ![](/image/retropad/retro_y.png) | Destroy block |
| ![](/image/retropad/retro_select.png) | Zoom out |
| ![](/image/retropad/retro_dpad_up.png) | Move forwards |
| ![](/image/retropad/retro_dpad_down.png) | Move backwards |
| ![](/image/retropad/retro_dpad_left.png) | Move crosshair left |
| ![](/image/retropad/retro_dpad_right.png) | Move crosshair right |
| ![](/image/retropad/retro_a.png) | Next block |
| ![](/image/retropad/retro_x.png) | Place block |
| ![](/image/retropad/retro_l1.png) | Move left |
| ![](/image/retropad/retro_r1.png) | Move right |
| ![](/image/retropad/retro_l2.png) | Move crosshair up |
| ![](/image/retropad/retro_r2.png) | Move corsshair down |
| ![](/image/retropad/retro_left_stick.png) X | Move left/right |
| ![](/image/retropad/retro_left_stick.png) Y | Move up/down |
| ![](/image/retropad/retro_right_stick.png) X | Move crosshair left/right |
| ![](/image/retropad/retro_right_stick.png) Y | Move crosshair up/down |
| ![](../image/retropad/retro_b.png) | Jump |
| ![](../image/retropad/retro_y.png) | Destroy block |
| ![](../image/retropad/retro_select.png) | Zoom out |
| ![](../image/retropad/retro_dpad_up.png) | Move forwards |
| ![](../image/retropad/retro_dpad_down.png) | Move backwards |
| ![](../image/retropad/retro_dpad_left.png) | Move crosshair left |
| ![](../image/retropad/retro_dpad_right.png) | Move crosshair right |
| ![](../image/retropad/retro_a.png) | Next block |
| ![](../image/retropad/retro_x.png) | Place block |
| ![](../image/retropad/retro_l1.png) | Move left |
| ![](../image/retropad/retro_r1.png) | Move right |
| ![](../image/retropad/retro_l2.png) | Move crosshair up |
| ![](../image/retropad/retro_r2.png) | Move crosshair down |
| ![](../image/retropad/retro_left_stick.png) X | Move left/right |
| ![](../image/retropad/retro_left_stick.png) Y | Move up/down |
| ![](../image/retropad/retro_right_stick.png) X | Move crosshair left/right |
| ![](../image/retropad/retro_right_stick.png) Y | Move crosshair up.down |
| RetroKeyboard | Craft |
|--------------------------------------------------------------------------------------------------------|----------------------|
| ![Retro_Keyboard_Arrow_Up](/image/Button_Pack/Keyboard_Mouse/Dark/Keyboard_Black_Arrow_Up.png) | Move forward |
| ![Retro_Keyboard_Arrow_Down](/image/Button_Pack/Keyboard_Mouse/Dark/Keyboard_Black_Arrow_Down.png) | Move backwards |
| ![Retro_Keyboard_Arrow_Left](/image/Button_Pack/Keyboard_Mouse/Dark/Keyboard_Black_Arrow_Left.png) | Move crosshair left |
| ![Retro_Keyboard_Arrow_Right](/image/Button_Pack/Keyboard_Mouse/Dark/Keyboard_Black_Arrow_Right.png) | Move crosshair right |
| ![Retro_Keyboard_Right_Shift](/image/Button_Pack/Keyboard_Mouse/Dark/Keyboard_Black_Shift_Alt.png) | Zoom out |
## Keyboard
| RetroMouse | Craft |
|-----------------------------------------------------------------|----------------|
| ![Retro_Mouse](/image/RetroMouse/Retro_Mouse.png) | Move crosshair |
| ![Retro_Left](/image/RetroMouse/Retro_Left.png) | Destroy block |
| ![Retro_Middle](/image/RetroMouse/Retro_Middle.png) | Copy block |
| ![Retro_Right](/image/RetroMouse/Retro_Right.png) | Place block |
| RetroKeyboard Inputs | Craft Inputs |
|----------------------|----------------------|
| Keyboard Up | Move forwards |
| Keyboard Down | Move backwards |
| Keyboard Right | Move crosshair left |
| Keyboard Left | Move crosshair right |
| Keyboard Right Shift | Zoom out |
| RetroMouse Inputs | (Device name) Inputs |
|-------------------------------------------------------|---------------------------|
| ![](/image/retromouse/retro_mouse.png) Mouse Cursor | - |
| ![](/image/retromouse/retro_left.png) Mouse 1 | - |
| ![](/image/retromouse/retro_right.png) Mouse 2 | - |
| ![](/image/retromouse/retro_middle.png) Mouse 3 | - |
| Mouse 4 | - |
| Mouse 5 | - |
| Wheel Up | - |
| Wheel Down | - |
| Wheel Left | - |
| Wheel Right | - |
## Mouse
| RetroMouse Inputs | Craft Inputs |
|-------------------------------------------------------|----------------|
| ![](../image/retromouse/retro_mouse.png) Mouse Cursor | Move crosshair |
| ![](../image/retromouse/retro_left.png) Mouse 1 | Destroy block |
| ![](../image/retromouse/retro_right.png) Mouse 2 | Place block |
| ![](../image/retromouse/retro_middle.png) Mouse 3 | Copy block |
| Wheel Up | Previous block |
| Wheel Down | Next block |
## External Links
* [Libretro Repository](https://github.com/libretro/craft)
* [Report Core Issues Here](https://github.com/libretro/libretro-meta)
* [Official Website](https://www.michaelfogleman.com/projects/craft/)
* [Official Repository](https://github.com/fogleman/Craft)
- [Official Craft Website](https://www.michaelfogleman.com/projects/craft/)
- [Official Craft Github Repository](https://github.com/fogleman/Craft)
- [Libretro Craft Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/craft_libretro.info)
- [Libretro Craft Github Repository](https://github.com/libretro/craft)
- [Report Libretro Craft Core Issues Here](https://github.com/libretro/Craft/issues)