libretro / libretro/docs

Create documentation for Turbo Fire (suggested documentation added)

Open
#638 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
346
Forks
860
Avg merge
5d 16h
Merged PRs (30d)
7

Description

Documents

Do not currently exist

Proposed changes

Documentation for usage of Turbo Fire function should be created. RetroArch>Settings>Input>Turbo Fire. I can't seem to get the Turbo Fire to work, but I'm not sure I'm using it correctly or understand it's intended function due to the lack of documentation. Description of the general intended function of the Turbo Fire, Turbo Modes, and Turbo Default Button would be much appreciated. There seems to be a lot of confusion in the community about how Turbo Fire is intended to work.

The most info I was able to find are some comments in the source code (see below).

if (turbo_mode > INPUT_TURBO_MODE_CLASSIC)
{
/* Pressing turbo button toggles turbo mode on or off.
* Holding the button will
* pass through, else the pressed state will be modulated by a
* periodic pulse defined by the configured duty cycle.

else if (turbo_mode == INPUT_TURBO_MODE_SINGLEBUTTON_HOLD &&
/* If turbo button is held, all buttons pressed except
* for D-pad will go into a turbo mode. Until the button is
* released again, the input state will be modulated by a
* periodic pulse defined by the configured duty cycle.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Turbo Fire settings path in RetroArch and the source-code comments included in the issue. Document the intended behavior of Turbo Fire, Turbo Modes, and Turbo Default Button, including how the listed modes respond to pressing or holding the turbo button; done means users can understand and use these settings.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.