libretro/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-11-27 10:40:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add preliminary Cannonball documenation

Browse Source
This commit is contained in:
Hedonium 2019-06-12 02:39:23 -04:00
parent 3f26ca3452
commit 230e02f20b
4 changed files with 244 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/development/licenses.md
View File

@ -16,6 +16,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|----------------|
| [Lakka](http://www.lakka.tv/) | [Non-commercial](http://www.lakka.tv/doc/FAQ/) | Non-commercial |
| [4DO](../library/4do.md) | [Non-commercial](https://github.com/libretro/4do-libretro/blob/master/libfreedo/freedocore.h) | Non-commercial |
| [Cannonball](../library/cannonball.md) | [Non-commercial](https://github.com/libretro/cannonball/blob/master/docs/license.txt) | Non-commercial |
| [Dinothawr](../library/dinothawr.md) | [Non-commercial](https://github.com/libretro/Dinothawr/blob/master/LICENSE) | Non-commercial |
| FB Alpha | [Non-commercial](https://github.com/libretro/fbalpha/blob/master/src/license.txt) | Non-commercial |
| FB Alpha 2012 | [Non-commercial](https://github.com/libretro/fbalpha2012/blob/master/docs/license.txt) | Non-commercial |

237
docs/library/cannonball.md Normal file
View File

@ -0,0 +1,237 @@
# Cannonball
## Background
CannonBall: The Enhanced OutRun Engine.
## Features
- Smoother 60fps gameplay
- True Widescreen Play Mode
- Force Feedback support
- Custom Track support from [LayOut](https://github.com/djyt/layout/wiki)
- New Game Modes (Continuous Mode & Time Trial Mode)
- [Many, many more enhancements](https://github.com/djyt/cannonball/wiki/Cannonball-Manual#enhancements)
The Cannonball core has been authored by
- Chris White
The Cannonball core is licensed under
- [Non-commercial](https://github.com/libretro/cannonball/blob/master/docs/license.txt)
A summary of the licenses behind RetroArch and its cores have found [here](https://docs.libretro.com/development/licenses/).
## How to start the Cannonball core:
- To start the Cannonball core, you need to obtain Cannonball's data files. You can do this by going to RetroArch's main menu screen and selecting 'Online Updater'. From there, select 'Content Downloader'.
- Select 'Cannonball', then select 'CannonBall.zip'. This should download and extract this file to RetroArch's Downloads directory.
- Go back to RetroArch's main menu screen. Select 'Load Content', then 'Downloads'.
- Select the 'CannonBall' directory, then select 'CannonBall.zip'.
- If you are asked which core to select, choose 'Cannonball'.
The content should now start running!
## Extensions
Content that can be loaded by the Cannonball core have the following file extensions:
- .game
- .88
RetroArch database(s) that are associated with the Cannonball core:
- [Cannonball](https://github.com/libretro/libretro-database/blob/master/rdb/Cannonball.rdb)
## Features
Frontend-level settings or features that the Cannonball core respects.
| Feature | Supported |
|-------------------|:---------:|
| Restart | ✕ |
| 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 Cannonball core's library name is 'Cannonball'
## Geometry and timing
- The Cannonball core's core provided FPS is 60 when the [Video Framerate core option](https://docs.libretro.com/library/cannonball/#core-options) is set to Smooth (60)
- The Cannonball core's core provided FPS is 120 when the [Video Framerate core option](https://docs.libretro.com/library/cannonball/#core-options) is set to Ultra Smooth (120)
- The Cannonball core's core provided sample rate is 44100 Hz
- The Cannonball core's base width is 320
- The Cannonball core's base height is 224
- The Cannonball core's max width is 640
- The Cannonball core's max height is 640
- The Cannonball core's core provided aspect ratio is 4/3 when the [Video Widescreen Mode core option](https://docs.libretro.com/library/cannonball/#core-options) is set to Off
- The Cannonball core's core provided aspect ratio is 16/9 when the [Video Widescreen Mode core option](https://docs.libretro.com/library/cannonball/#core-options) is set to On
## Core options
The Cannonball core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.
Settings with (Restart) means that core has to be closed for the new setting to be applied on next launch.
- **Menu At Start** [cannonball_menu_enabled] (**ON**|OFF)
Awaiting description.
- **Menu Road Scroll Speed** [cannonball_menu_road_scroll_speed] (**50**|60|70|80|90|100|150|200|300|400|500|5|10|15|20|25|30|40)
Awaiting description.
- **Video Widescreen Mode** [cannonball_video_widescreen] (**ON**|OFF)
Awaiting description.
- **Video High-Resolution Mode** [cannonball_video_hires] (**OFF**|ON)
Awaiting description.
- **Video Framerate** [cannonball_video_fps] (**Smooth (60)**|Ultra Smooth (120)|Original (60/30))
Awaiting description.
- **Advertise Sound** [cannonball_sound_advertise] (**ON**|OFF)
Awaiting description.
- **Previus Music** [cannonball_sound_preview] (**ON**|OFF)
Awaiting description.
- **Fix Samples (use opr-10188.71f)** [cannonball_sound_fix_samples] (**ON**|OFF)
Awaiting description.
- **Gear Mode** [cannonball_gear] (**Manual**|Manual Cabinet|Manual 2 Buttons|Automatic)
Awaiting description.
- **Analog Controls (off to allow digital speed setup)** [cannonball_analog] (**ON**|OFF)
Awaiting description.
- **Digital Steer Speed** [cannonball_steer_speed] (**3**|4|5|6|7|8|9|1|2)
Awaiting description.
- **Digital Pedal Speed** [cannonball_pedal_speed] (**4**|5|6|7|8|9|1|2|3)
Awaiting description.
- **Time** [cannonball_dip_time] (**Easy (80s)**|Normal (75s)|Hard (72s)|Very Hard (70s)|Infinite Time)
Awaiting description.
- **Traffic** [cannonball_dip_traffic] (**Normal**|Hard|Very Hard|No Traffic|Easy)
Awaiting description.
- **Freeplay Mode** [cannonball_freeplay] (**OFF**|ON)
Awaiting description.
- **Use Japanese Tracks Version** [cannonball_jap] (**OFF**|ON)
Awaiting description.
- **Use Prototype Stage 1** [cannonball_prototype] (**OFF**|ON)
Awaiting description.
- **Objects Limit Enhanced** [cannonball_level_objects] (**ON**|OFF)
Awaiting description.
- **Original Traffic Patterns Randomization** [cannonball_randomgen] (**ON**|OFF)
Awaiting description.
- **Force AI To Play** [cannonball_force_ai] (**OFF**|ON)
Awaiting description.
- **Fix Original Game Bugs** [cannonball_fix_bugs] (**ON**|OFF)
Awaiting description.
- **Fix Timing Bugs** [cannonball_fix_timer] (**OFF**|ON)
Awaiting description.
- **Display Debug Info For LayOut** [cannonball_layout_debug] (**OFF**|ON)
Awaiting description.
- **New Attract** [cannonball_new_attract] (**ON**|OFF)
Awaiting description.
- **Time Trial Laps** [cannonball_ttrial_laps] (**3**|4|5|1|2)
Awaiting description.
- **Time Trial Traffic Amount** [cannonball_ttrial_traffic] (**3**|4|5|6|7|8|0|1|2)
Awaiting description.
- **Continuous Mode Traffic Amount** [cannonball_cont_traffic] (**3**|4|5|6|7|8|0|1|2)
Awaiting description.
## Joypad
| RetroPad Inputs | User 1 input descriptors |
|------------------------------------------------|--------------------------|
| ![](../image/retropad/retro_b.png) | Accelerate |
| ![](../image/retropad/retro_y.png) | Brake |
| ![](../image/retropad/retro_select.png) | Coin |
| ![](../image/retropad/retro_start.png) | Start |
| ![](../image/retropad/retro_dpad_up.png) | Up |
| ![](../image/retropad/retro_dpad_down.png) | Down |
| ![](../image/retropad/retro_dpad_left.png) | Left |
| ![](../image/retropad/retro_dpad_right.png) | Right |
| ![](../image/retropad/retro_a.png) | Gear |
| ![](../image/retropad/retro_x.png) | Gear |
| ![](../image/retropad/retro_l1.png) | Adjust View |
| ![](../image/retropad/retro_r1.png) | Go Back To Menu |
| ![](../image/retropad/retro_left_stick.png) X | Analog X |
| ![](../image/retropad/retro_left_stick.png) Y | Analog Y |
## External Links
- [Official Cannoball Github Wiki](https://github.com/djyt/cannonball/wiki)
- [Official Cannonball Github Repository](https://github.com/djyt/cannonball)
- [Libretro Cannonball Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/cannonball_libretro.info)
- [Libretro Cannonball Github Repository](https://github.com/libretro/cannonball)
- [Report Libretro Cannonball Core Issues Here](https://github.com/libretro/cannonball/issues)

9
docs/meta/core-list.md
View File

@ -4,6 +4,7 @@
- Atari800
- Beetle bsnes
- Beetle Cygne
- BeetleDC
- Beetle GBA
- Beetle Handy
- Beetle NeoPop
@ -23,14 +24,15 @@
- bsnes Balanced
- bsnes C++98 (v085)
- bsnes Performance
- Cannonball
- Caprice32
- ChaiLove
- Citra
- Citra Canary/Experimental
- Craft
- CrocoDS
- DeSmuME 2015
- DeSmuME
- DeSmuME 2015
- Dinothawr
- Dolphin
- DOSBox
@ -105,7 +107,6 @@
- ProSystem
- PX68k
- QuickNES
- BeetleDC
- REminiscence
- RemoteJoy
- Remote RetroPad
@ -119,8 +120,8 @@
- Stella
- TempGBA
- TGB Dual
- The Powder Toy
- Theodore
- The Powder Toy
- TyrQuake
- UME 2014
- Uzem
@ -135,4 +136,4 @@
- Video Processor
- Virtual Jaguar
- XRick
- Yabause
- Yabause

1
mkdocs.yml
View File

@ -148,6 +148,7 @@ nav:
- 'SNK Emulation':
- 'SNK - Neo Geo Pocket / Color (Beetle NeoPop)': 'library/beetle_neopop.md'
- 'Sega Emulation':
- 'Cannonball': 'library/cannonball.md'
- 'Sega - 32X Compatibility List': 'library/compatibility/32x.md'
- 'Sega - Dreamcast Compatibility List': 'library/compatibility/dc.md'
- 'Sega - Saturn Compatibility List': 'library/compatibility/saturn.md'