From 18e160eced7e5904b8dc052e47b0f1150aee9d37 Mon Sep 17 00:00:00 2001 From: Kevin Nguyen Date: Fri, 6 Oct 2023 22:02:43 -0700 Subject: [PATCH] Update markdown links to add-ons --- README.md | 2 +- docs/development.md | 4 ++-- docs/faq-ps4-ps5-compatibility.md | 26 +++++++++++++++++++++++--- docs/faq.md | 4 ++-- docs/rgb-leds.md | 2 +- docs/usage.md | 2 +- 6 files changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3919be0ad..1132e5b9a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Full documentation can be found at * 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. diff --git a/docs/development.md b/docs/development.md index 7a2760a44..96d05d3d7 100644 --- a/docs/development.md +++ b/docs/development.md @@ -265,11 +265,11 @@ Start in the GP2040-CE folder ?> We're moving away from compile time configuration, in favor of runtime configuration. -There are two simple options for building GP2040-CE for your board. You can either edit an existing board definition, or create your own. Several example configurations are located in the repository **[configs](https://github.com/OpenStickFoundation/GP2040-CE/tree/main/configs)** folder. This document will outline setting up a new build configuration. +There are two simple options for building GP2040-CE for your board. You can either edit an existing board definition, or create your own. Several example configurations are located in the repository **[configs](https://github.com/OpenStickCommunity/GP2040-CE/tree/main/configs)** folder. This document will outline setting up a new build configuration. ### Board Configuration Folder -Each subfolder in [`configs`](https://github.com/OpenStickFoundation/GP2040-CE/tree/main/configs) contains a separate board configuration, which consists of the following: +Each subfolder in [`configs`](https://github.com/OpenStickCommunity/GP2040-CE/tree/main/configs) contains a separate board configuration, which consists of the following: | Name | Required? | Description | | ----------- | --------- | ----------- | diff --git a/docs/faq-ps4-ps5-compatibility.md b/docs/faq-ps4-ps5-compatibility.md index 638a23616..2709b2a81 100644 --- a/docs/faq-ps4-ps5-compatibility.md +++ b/docs/faq-ps4-ps5-compatibility.md @@ -12,7 +12,7 @@ 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.md#ps4-mode) in the `Web Configurator - Add-ons` section of the documentation. +For more information, refer to [PS4 Mode](add-ons/ps4-mode) in the `Web Configurator - Add-ons` section of the documentation. ## What is PS Passthrough? @@ -20,7 +20,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.md#ps-passthrough) in the `Web Configurator - Add-ons` section of the documention. +For more information, refer to [PS Passthrough](add-ons/ps-passthrough) in the `Web Configurator - Add-ons` section of the documention. ## Why does my controller stop responding after a while on PS4 or PS5? @@ -41,7 +41,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](web-configurator?id=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), 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. @@ -50,3 +50,23 @@ If you're using an OLED display, the input mode will change from `PS4` to `PS4:A The GP2040-CE project will not provide ***any*** files or information related to acquiring these keys and files. !> **Do not ask via any of communication channels (e.g. social media, direct messages, Github Issues, GP2040-CE) as this will result in a permanent blacklist/ban.** + +## What controller or dongle do I use for PS Passthrough? + +This depends on whether you are aiming to avoid the 8 minute timeout on PS4 or are looking to get your controller working on PS5. + +### Playstation 4 + +For avoiding the 8 minute timeout on PS4, any PS4 controller or converter should work unless the device is not a valid and accepted as a proper controller on its own with a PS4. + +### Playstation 5 + +For PS5 compatibility, there are a number of devices that the PS5 recognizes as a "specialty" controller (e.g. arcade stick, racing wheel, flight sim joystick, etc.) where the developer of the game has supported the use of "specialty" controllers. Any device works as a specialty PS4 controller (arcade stick/racing wheel/flight sim joystick) or a dongle that allows a controller to authenticates as such should work for games that support it. Note that this is not all games, but most fighting games and vehicle simulators do. + +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) +- [N5 for PXN Game Steering Wheel](https://pxn-game.com/products/n5-for-pxn-game-steering-wheel) +- PCBs from Licensed PS4 Arcade Sticks + +Because your experience and purchased products may vary, GP2040-CE will not bear the responsibility of providing specific recommendations beyond these known working devices. \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index aa2531233..de0d5d044 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -14,13 +14,13 @@ 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.md#ps4-mode). +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). ### 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.md#player-number-x-input-only) 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.md) to force each board to a specific player number. ### Does GP2040-CE really have less than 1 ms of input latency? diff --git a/docs/rgb-leds.md b/docs/rgb-leds.md index e79161d63..c21a3208d 100644 --- a/docs/rgb-leds.md +++ b/docs/rgb-leds.md @@ -4,7 +4,7 @@ GP2040-CE requires that addressable RGB LEDs be used for nearly all LED functions. -The exception to this are [Player LEDs](web-configurator.md#player-leds-xinput), which can use pulse width modulation (PWM) to vary the brightness of the LEDs. +The exception to this are [Player LEDs](add-ons/player-number.md), which can use pulse width modulation (PWM) to vary the brightness of the LEDs. ## RGB LED Hotkeys diff --git a/docs/usage.md b/docs/usage.md index 4f7153732..9a2e266d7 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -83,4 +83,4 @@ A number of hotkeys are enabled by default and if you are encountering issues wi ## Add-Ons and Additional Features -There are a number of add-ons that expand the functionality of GP2040-CE, such as [analog stick emulation](add-ons#analog) and [turbo functions](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 [Add-Ons page](add-ons) for more information on the individual add-ons. \ No newline at end of file +There are a number of add-ons that expand the functionality of GP2040-CE, such as [analog stick emulation](add-ons/analog) and [turbo functions](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 [Add-Ons page](add-ons) for more information on the individual add-ons. \ No newline at end of file