Skip to content

Commit

Permalink
Update docs with minor improvements for add-on discoverability (OpenS…
Browse files Browse the repository at this point in the history
…tickCommunity#513)

* Update docs with minor improvements for add-on discoverability

* Change from direct URL links to markdown links and fix typo
  • Loading branch information
CryHavoc21 authored Sep 12, 2023
1 parent dca1fdd commit 5ceafb4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

## Links

[Downloads](https://gp2040-ce.info/#/download) | [Installation](https://gp2040-ce.info/#/installation) | [Wiring](https://gp2040-ce.info/#/wiring) | [Usage](https://gp2040-ce.info/#/usage) | [FAQ](https://gp2040-ce.info/#/faq)
[Downloads](https://gp2040-ce.info/#/download) | [Installation](https://gp2040-ce.info/#/installation) | [Wiring](https://gp2040-ce.info/#/wiring) | [Usage](https://gp2040-ce.info/#/usage) | [FAQ](https://gp2040-ce.info/#/faq) | [GitHub](https://github.com/OpenStickCommunity/GP2040-CE)

Full documentation can be found at <https://gp2040-ce.info>

Expand All @@ -38,7 +38,7 @@ Full documentation can be found at <https://gp2040-ce.info>
* Left and Right stick emulation via D-pad inputs as well as dedicated toggle switches.
* Dual direction via D-pad + LS/RS.
* Reversed input via a button.
* Turbo and Turbo LED with selectable speed
* [Turbo and Turbo LED](https://gp2040-ce.info/#/web-configurator-add-ons?id=turbo) with selectable speed
* Per-button RGB LED support.
* PWM Player indicator LED support (XInput only).
* Multiple LED profiles support.
Expand Down
4 changes: 3 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,12 @@ Unlike other controllers, Keyboard gets different keys for directional buttons.

?> You can change the key mappings for Keyboard mode in [Webconfig mode](web-configurator.md)

## Additional Features: Turbo & LS/RS Emulation
## Additional Features and Add-Ons

Please note that the documentation for these new features is yet to be written. A future version will include updated docs.

There are a number of add-ons that expand the functionality of GP2040-CE, such as [analog stick emulation](web-configurator-add-ons#analog) and [turbo functions](web-configurator-add-ons#turbo). Due to the large number of add-ons created by the community, they are located in a separate documentation page. Navigate to [Web Configurator - Add-ons](web-configurator-add-ons) for more information.

## Bootsel Mode

To boot into Bootsel mode (to flash your controller for example), hold the <hotkey v-bind:buttons='["S1", "S2", "Up"]'></hotkey> button combination then plug in your controller.
Expand Down
8 changes: 4 additions & 4 deletions docs/web-configurator-add-ons.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Add-Ons Configuration

This section is for custom add-ons that can be enabled to expand the functionality of GP2040-CE. Please note that not all add-ons may work together. These should be considered experimental.
This section is for custom add-ons that can be enabled to expand the functionality of GP2040-CE. Some of these add-ons are experimental. Please note that not all add-ons may work together.

## BOOTSEL Button Configuration

Expand All @@ -24,7 +24,7 @@ Please note that this can only be used on devices that have a BOOTSEL button. P

* `Analog Stick 1 X Pin` - The GPIO pin used for the Analog Stick 1 X value. Only ADC pins 26, 27, 28 and 29 are allowed here.
* `Analog Stick 1 Y Pin` - The GPIO pin used for the Analog Stick 1 Y value. Only ADC pins 26, 27, 28 and 29 are allowed here.
* `Analog Stick 1 Mode` - Choose if Analog Stick 1 is to be used for Left Analog or Right Analog.
* `Analog Stick 1 Mode` - Choose if Analog Stick 1 is to be used for Left Analog or Right Analog.
* `Analog Stick 1 Invert` - Choose if you would like to flip the X or Y axis Analog Stick 1 inputs (or both).
* `Analog Stick 2 X Pin` - The GPIO pin used for the Analog Stick 2 X value. Only ADC pins 26, 27, 28 and 29 are allowed here.
* `Analog Stick 2 Y Pin` - The GPIO pin used for the Analog Stick 2 Y value. Only ADC pins 26, 27, 28 and 29 are allowed here.
Expand Down Expand Up @@ -216,7 +216,7 @@ These addons are predicated on having and using a USB Host Port on the device. T

![GP2040-CE Configurator - PS Passthrough](assets/images/gpc-add-ons-ps-passthrough.png)

Enabling this add-on will allow you to use a licenced 3rd party device to authenticate off of. This addon requires that you have something like the ![USB Passthrough Board](https://github.com/OpenStickCommunity/Hardware/tree/main/USB%20Passthrough%20Board) or a board with a USB passthrough port on it already. If you have passthrough enabled you can turn off the above `PS4 Mode` addon as the two will not work together. Please also ensure that under the `Settings` section you have chosen PS4 mode and picked if you want the GP2040-CE unit to function as a controller or as a fightstick.
Enabling this add-on will allow you to use a licenced 3rd party device to authenticate off of. This addon requires that you have something like the ![USB Passthrough Board](https://github.com/OpenStickCommunity/Hardware/tree/main/USB%20Passthrough%20Board) or a board with a USB passthrough port on it already. If you have passthrough enabled you can turn off the above `PS4 Mode` addon as the two will not work together. Please also ensure that under the `Settings` section you have chosen PS4 mode and picked if you want the GP2040-CE unit to function as a controller or as a fightstick.

### Keyboard Host Configuration

Expand All @@ -232,4 +232,4 @@ This example wiring diagram is applicable to both the PS Passthrough and the Key
* `VCC` - Connects to 5V power (Example: VBUS on the Raspberry Pi Pico)
* `D+` - Connects to the `D+` GPIO Pin above, set in the Web Configurator. (Example: GPIO0 on the Raspberry Pi Pico)
* `D-` - Connects to the `D-` GPIO Pin above, automatically set based on D+. (Example: GPIO1 on the Raspberry Pi Pico)
* `GND` - Connects to a ground pin, any `GND` pin will work. (Example: GND on the Raspberry Pi Pico)
* `GND` - Connects to a ground pin, any `GND` pin will work. (Example: GND on the Raspberry Pi Pico)

0 comments on commit 5ceafb4

Please sign in to comment.