Skip to content

Commit

Permalink
Documentation - Minor Corrections (#621)
Browse files Browse the repository at this point in the history
* Link Input Label/Hotkey Combos to Buttons page

* Deduplicate text in page

* Minor corrections
  • Loading branch information
InfraredAces authored Nov 15, 2023
1 parent 77dd456 commit aab52b7
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 25 deletions.
Binary file removed site/docs/assets/boards/ReflexEncoder.jpg
Binary file not shown.
2 changes: 1 addition & 1 deletion site/docs/development/contribution-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ Never made an open source contribution before? Wondering how contributions work

## Documentation

Documentation is one of the easiest ways to get started contributing to GP2040-CE. Finding places where the documentation is wrong or incomplete and fixing those is easy! We also very badly need someone to edit our documentation, so if you have editing skills but aren’t sure where or how to jump in please [reach out for help](getting-help-support "GP2040-CE | Getting Help")!
Documentation is one of the easiest ways to get started contributing to GP2040-CE. Finding places where the documentation is wrong or incomplete and fixing those is easy! We also very badly need someone to edit our documentation, so if you have editing skills but aren’t sure where or how to jump in please [reach out for help](../getting-help-support.mdx)!
4 changes: 2 additions & 2 deletions site/docs/development/documentation-versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ npm run docusaurus docs:version X.X.X

When tagging a new version, the document versioning mechanism will:

- Copy the full docs/ folder contents into a new versioned_docs/version-[versionName]/ folder.
- Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-[versionName]-sidebars.json.
- Copy the full docs/ folder contents into a new versioned_docs/version-\{versionName\}/ folder.
- Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-\{versionName\}-sidebars.json.
- Append the new version number to versions.json.

## Updating Documentation
Expand Down
3 changes: 0 additions & 3 deletions site/docs/faq/faq-general.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,12 @@ This will depend on the platform you will be playing on:

### Will GP2040-CE natively support PS5, Xbox One, or Xbox Series consoles?

These consoles implement security measures that prevent unauthorized accessories from being used. The process of cracking or bypassing that security may not be legal everywhere. These consoles could be supported in the future if a user-friendly and completely legal implementation method is found, such as the implementation of [PS4 Mode](../add-ons/ps4-mode.mdx).
These consoles implement security measures that prevent unauthorized accessories from being used. The process of cracking or bypassing that security may not be legal everywhere. These consoles could be supported in the future if a user-friendly and completely legal implementation method is found, such as the implementation of [PS4 Mode](../add-ons/ps4-mode.mdx).

### Can I use multiple controllers with GP2040-CE on the same system?

Yes! Each GP2040-CE board is treated as a separate controller. Be sure to only run the embedded web configurator for each controller one at a time.

If you're installing boards with GP2040-CE in an arcade cabinet, check out the [Player Number add-on](../add-ons/player-number.mdx) to force each board to a specific player number.
If you're installing boards with GP2040-CE in an arcade cabinet, check out the [Player Number add-on](../add-ons/player-number.mdx) to force each board to a specific player number.

### Does GP2040-CE really have less than 1 ms of input latency?
Expand All @@ -43,7 +41,6 @@ Not at all! The RP2040 processor of the Pico has two cores. GP2040-CE dedicates

### Why do the buttons have weird labels like B3, A1, S2, etc.?

GP2040-CE uses a generic system for handling button inputs that resembles a traditional PlayStation controller layout with a few extra buttons. This means 4 face buttons (B1-B4), 4 shoulder buttons (L1, L2, R1, R2), Select and Start (S1, S2), 2 stick buttons (L3, R3) and 2 auxiliary buttons for things like Home and Capture (A1, A2) on the Switch. The GP2040-CE documentation and web configurator both provide a dropdown to change the button labels to more familiar controller layouts. You can refer to the button mapping table on the [GP2040-CE Usage](../usage.mdx#buttons) page.
GP2040-CE uses a generic system for handling button inputs that resembles a traditional PlayStation controller layout with a few extra buttons. This means 4 face buttons (B1-B4), 4 shoulder buttons (L1, L2, R1, R2), Select and Start (S1, S2), 2 stick buttons (L3, R3) and 2 auxiliary buttons for things like Home and Capture (A1, A2) on the Switch. The GP2040-CE documentation and web configurator both provide a dropdown to change the button labels to more familiar controller layouts. You can refer to the button mapping table on the [GP2040-CE Usage](../usage.mdx#buttons) page.

## Technical Questions
Expand Down
13 changes: 3 additions & 10 deletions site/docs/faq/faq-ps4-ps5-compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ PS4 mode is an add-on that grants GP2040-CE compatibility with the Playstation 4

The team behind Passing Link are in no way affiliated with the GP2040-CE project, however the work and information they've made available was greatly appreciated so we could bring this highly-requested feature to our users.

For more information, refer to [PS4 Mode](../add-ons/ps4-mode.mdx) in the `Web Configurator - Add-ons` section of the documentation.
For more information, refer to [PS4 Mode](../add-ons/ps4-mode.mdx) in the `Web Configurator - Add-ons` section of the documentation.

## What is PS Passthrough?
Expand All @@ -30,8 +29,7 @@ PS Passthrough is an add-on that grants GP2040-CE compatibility with the Playsta

Depending on the controller or dongle used, you may be limited to only Playstation 4 support.

For more information, refer to [PS Passthrough](../add-ons/ps-passthrough) in the `Web Configurator - Add-ons` section of the documentation.
For more information, refer to [PS Passthrough](../add-ons/ps-passthrough) in the `Web Configurator - Add-ons` section of the documentation.
For more information, refer to [PS Passthrough](../add-ons/ps-passthrough.mdx) in the `Web Configurator - Add-ons` section of the documentation.

## Why does my controller stop responding after a while on PS4 or PS5?

Expand All @@ -52,7 +50,7 @@ The 8-minute timeout works like this:

## How do I avoid the 8-Minute Timeout?

GP2040-CE allows you to upload the files required to authenticate your device via the [PS4 Mode add-on](../add-ons/ps4-mode), which effectively removes this timeout issue.
GP2040-CE allows you to upload the files required to authenticate your device via the [PS4 Mode add-on](../add-ons/ps4-mode.mdx), which effectively removes this timeout issue.

If you're using an OLED display, the input mode will change from `PS4` to `PS4:AS` to indicate your device has successfully authenticated with the PS4/PS5 console.

Expand All @@ -64,11 +62,6 @@ The GP2040-CE project will not provide **_any_** files or information related to

**Do not ask via any of communication channels (e.g. social media, direct messages, Github Issues, GP2040-CE Discord) as this will result in a permanent blacklist/ban.**

:::
:::danger

**Do not ask via any of communication channels (e.g. social media, direct messages, Github Issues, GP2040-CE Discord) as this will result in a permanent blacklist/ban.**

:::

## What controller or dongle do I use for PS Passthrough?
Expand All @@ -85,7 +78,7 @@ For PS5 compatibility, there are a number of devices that the PS5 recognizes as

Some devices that do work for PS5 include, but are not limited to;

- [MagicBoots FPS Adapter Joysick Converter for PS4 v1.1](https://www.mayflash.com/product/MAGPS4.html)
- [MagicBoots FPS Adapter Joystick Converter for PS4 v1.1](https://www.mayflash.com/product/MAGPS4.html)
- [N5 for PXN Game Steering Wheel](https://pxn-game.com/products/n5-for-pxn-game-steering-wheel)
- PCBs from Licensed PS4 Arcade Sticks

Expand Down
8 changes: 5 additions & 3 deletions site/docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: "Introduction to GP2040-CE"

# Introduction

Your controller has a control board in it that processes your inputs and translates that to commands that your computer or game console understands. GP2040-CE is firmware that facilitates this process, providing compatibility with a number of consoles and input modes. In addition to this, there are many other useful features through the Web Configurator and the system of community developed add-ons.
Your controller has a board in it that processes your inputs and translates that to commands that your computer or game console understands. GP2040-CE is firmware that facilitates this process, providing compatibility with a number of consoles and input modes. In addition to this, there are many other useful features through the Web Configurator and the system of community developed add-ons.

Not sure if your board can run GP2040-CE? As long as it has a RP2040 microprocessor, it's likely that it can. If your current controller board does not, there are a large number of hobbyist boards from the community that do support GP2040-CE.

Expand All @@ -28,6 +28,8 @@ This section of the documentation is primarily geared towards end users who are

## Additional Resources

If you feel ready to start customizing your controller's functions or building your own device, have a look at the `Web Configurator` or `Controller Building` section in the sidebar.
If you feel ready to start customizing your controller's functions, have a look at the [`Web Configurator`](./web-configurator/web-configurator.mdx) section of documentation.

If you want to go even deeper into the firmware to compile your own configuration of the firmware or even contributing to the code, have a look at the `Developing GP2040-CE` section in the sidebar.
If you want to build your own device, check out the `Controller Building` section in the sidebar.

If you want to go even deeper into the firmware to compile your own configuration of the firmware or even contributing to the code, have a look at the [`Contribute`](./development/contribution-guide.mdx) section of the documentation.
2 changes: 0 additions & 2 deletions site/docs/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ GP2040-CE uses generic button labeling for gamepad state, which is then converte

<InputTable />

<InputTable />

If your controller is missing dedicated buttons for any specific inputs, check the [Hotkeys page](./hotkeys.mdx) on how to map a button combination that will emulate those missing inputs.

:::note
Expand Down
12 changes: 8 additions & 4 deletions site/src/components/LabelSelector.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@ const useLabelSelector = create<State & Actions>()(
set({ selected });
},
}),
{ name: 'SelectedLabel' }
)
{ name: 'SelectedLabel' },
),
);

const customStyles = {
Expand Down Expand Up @@ -235,5 +235,9 @@ export function Hotkey({ buttons }) {
.map((input) => labelData[selected.value][input])
.join(' + ');

return <code>{hotKeyCombo}</code>;
}
return (
<a href="/usage#buttons">
<code>{hotKeyCombo}</code>
</a>
);
}

0 comments on commit aab52b7

Please sign in to comment.