Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation - Separate Add-On Pages #561

Merged
merged 8 commits into from
Oct 8, 2023
Merged

Update Documentation - Separate Add-On Pages #561

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f313ad2
Add expanding add-on sidebar element
InfraredAces Oct 5, 2023
d13ff2c
Breakout Add-ons into separate pages
InfraredAces Oct 7, 2023
18e160e
Update markdown links to add-ons
InfraredAces Oct 7, 2023
c2caf81
Close tags in README
InfraredAces Oct 7, 2023
ad5399c
Correct minor typos in README
InfraredAces Oct 7, 2023
75f10d6
Update README.md
InfraredAces Oct 8, 2023
d21e845
Update docs/faq-ps4-ps5-compatibility.md
InfraredAces Oct 8, 2023
1efefab
Update docs/faq-ps4-ps5-compatibility.md
InfraredAces Oct 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
<p align="center">
<a href="https://gp2040-ce.info">
<img alt="GP2040-CE" src="https://raw.githubusercontent.com/OpenStickCommunity/GP2040-CE/main/docs/assets/images/gp2040-ce-logo.png">
<img alt="GP2040-CE" src="https://raw.githubusercontent.com/OpenStickCommunity/GP2040-CE/main/docs/assets/images/gp2040-ce-logo.png" />
</a>
</p>

<p align="center">
Multiplatform Gamepad Firmware for RP2040
Multi-platform Gamepad Firmware for RP2040
InfraredAces marked this conversation as resolved.
Show resolved Hide resolved
</p>

<p align="center">
<img src="https://img.shields.io/github/license/OpenStickCommunity/GP2040-CE">
<img src="https://img.shields.io/github/actions/workflow/status/OpenStickCommunity/GP2040-CE/cmake.yml">
<br>
<img src="https://img.shields.io/badge/inputlag.science-0.86%20ms-blue">
<img src="https://img.shields.io/badge/MiSTer%20latency-0.765%20ms-blue">
<img src="https://img.shields.io/github/license/OpenStickCommunity/GP2040-CE" />
<img src="https://img.shields.io/github/actions/workflow/status/OpenStickCommunity/GP2040-CE/cmake.yml" />
<br />
<img src="https://img.shields.io/badge/inputlag.science-0.86%20ms-blue" />
<img src="https://img.shields.io/badge/MiSTer%20latency-0.765%20ms-blue" />
</p>

<p>
GP2040-CE (Community Edition) is a gamepad firmware for the Raspberry Pi Pico and other boards based on the RP2040 microcontrollers that combines multiplatform compatibility, low latency and a rich feature set to provide endless customization possibilities without sacrificing performance.
GP2040-CE (Community Edition) is a gamepad firmware for the Raspberry Pi Pico and other boards based on the RP2040 microcontrollers that combines multi-platform compatibility, low latency and a rich feature set to provide endless customization possibilities without sacrificing performance.
</p>

<p>
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](https://gp2040-ce.info/#/add-ons?id=turbo) with selectable speed
* [Turbo and Turbo LED](https://gp2040-ce.info/#/add-ons/turbo) with selectable speed
* Per-button RGB LED support.
* PWM Player indicator LED support (XInput only).
* Multiple LED profiles support.
Expand Down Expand Up @@ -70,7 +70,7 @@ Want to help improve GP2040-CE? There are a bunch of ways to contribute!

### Community Participation

Have an idea for a cool new feature, or just want to discuss some technical details with the devs? Join the [OpenStick GP2040-CE Discord](https://discord.gg/k2pxhke7q8) server to participate in our active and ever-growing community!
Have an idea for a cool new feature, or just want to discuss some technical details with the developers? Join the [OpenStick GP2040-CE Discord](https://discord.gg/k2pxhke7q8) server to participate in our active and ever-growing community!

### Pull Requests

Expand All @@ -87,7 +87,7 @@ Please respect the coding style of the file(s) you are working in, and enforce t
* [bitbank2](https://github.com/bitbank2) for the [OneBitDisplay](https://github.com/bitbank2/OneBitDisplay) and [BitBang_I2C](https://github.com/bitbank2/BitBang_I2C) libraries, which were ported for use with the Pico SDK
* [arntsonl](https://github.com/arntsonl) for the amazing cleanup and feature additions that brought us to v0.5.0
* [alirin222](https://github.com/alirin222) for the awesome turbo code ([@alirin222](https://twitter.com/alirin222) on Twitter)
* [deeebug](https://github.com/deeebug) for improvements to the web-UI and fixing the PS3 homebutton issue
* [deeebug](https://github.com/deeebug) for improvements to the web-UI and fixing the PS3 home button issue
* [TheTrain](https://github.com/TheTrainGoes/GP2040-Projects) and [Fortinbra](https://github.com/Fortinbra) for helping keep our community chugging along
* [PassingLink](https://github.com/passinglink/passinglink) for the technical details and code for PS4 implementation
* [Youssef Habchi](https://youssef-habchi.com/) for allowing us to purchase a licence to use Road Rage font for the porject
* [Youssef Habchi](https://youssef-habchi.com/) for allowing us to purchase a license to use Road Rage font for the project
26 changes: 22 additions & 4 deletions docs/_sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
- [Home](README "GP2040-CE | RP2040 Gamepad Firmware Documentation")
- [Download](download "GP2040-CE | Download")

[**Home**](README "GP2040-CE | RP2040 Gamepad Firmware Documentation")
[**Download**](download "GP2040-CE | Download")
**General**

- [Introduction](introduction "GP2040-CE | Introduction")
- [Firmware Installation](installation "GP2040-CE | Firmware Installation")
- [Usage](usage "GP2040-CE | Usage")
Expand All @@ -19,6 +17,26 @@

- [Web Configurator](web-configurator "GP2040-CE | Web Configurator")
- [Add-Ons](add-ons "GP2040-CE | Web Configurator - Add-ons")
- [Analog](add-ons/analog.md)
- [BOOTSEL Button](add-ons/bootsel-button.md)
- [Buzzer Speaker](add-ons/buzzer-speaker.md)
- [Dual Directional Input](add-ons/dual-direction-input.md)
- [Extra Button](add-ons/extra-button.md)
- [Focus Mode](add-ons/focus-mode.md)
- [I2C Analog ADS1219](add-ons/i2c-analog-ads1219.md)
- [Input Reverse](add-ons/input-reverse.md)
- [Joystick Selection Slider](add-ons/joystick-selection-slider.md)
- [On-board LED](add-ons/on-board-led.md)
- [Player Number](add-ons/player-number.md)
- [PS4 Mode](add-ons/ps4-mode.md)
- [SNES Input](add-ons/snes-input.md)
- [SOCD Selection Slider](add-ons/socd-selection-slider.md)
- [Tilt Input](add-ons/tilt-input.md)
- [Turbo](add-ons/turbo.md)
- [USB Host Based Add-ons](add-ons/usb-host-based-add-ons.md)
- [PS Passthrough](add-ons/ps-passthrough.md)
- [Keyboard Host](add-ons/keyboard-host.md)
- [Wii Extensions](add-ons/wii-extensions.md)

**Controller Building**

Expand Down
Loading