NaxdyOrg/NaxGCC-Doc
2
0
Fork 0
Code Issues Pull requests Activity Actions

add info about pro controller mode #5

Merged
Naxdy merged 1 commit from work/procon into main 2024-10-14 19:55:34 +00:00
Conversation 0 Commits 1 Files changed 9 +455 -40
9 changed files with 455 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
book.toml
View file

@ -10,3 +10,12 @@ after = ["links"]
[preprocessor.toc] [preprocessor.toc]
marker = "[[_TOC_]]" marker = "[[_TOC_]]"
[preprocessor.admonish]
command = "mdbook-admonish"
assets_version = "3.0.0" # do not edit: managed by `mdbook-admonish install`
[output]
[output.html]
additional-css = ["./mdbook-admonish.css"]

2
flake.nix
View file

@ -36,7 +36,7 @@
devShells.default = pkgs.mkShell { devShells.default = pkgs.mkShell {
nativeBuildInputs = builtins.attrValues { nativeBuildInputs = builtins.attrValues {
inherit (pkgs) mdbook mdbook-katex mdbook-toc; inherit (pkgs) mdbook mdbook-katex mdbook-toc mdbook-admonish;
}; };
}; };
}); });

341
mdbook-admonish.css Normal file
View file

@ -0,0 +1,341 @@
@charset "UTF-8";
:root {
--md-admonition-icon--admonish-note: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z'/></svg>");
--md-admonition-icon--admonish-abstract: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17 9H7V7h10m0 6H7v-2h10m-3 6H7v-2h7M12 3a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m7 0h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2z'/></svg>");
--md-admonition-icon--admonish-info: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z'/></svg>");
--md-admonition-icon--admonish-tip: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17.66 11.2c-.23-.3-.51-.56-.77-.82-.67-.6-1.43-1.03-2.07-1.66C13.33 7.26 13 4.85 13.95 3c-.95.23-1.78.75-2.49 1.32-2.59 2.08-3.61 5.75-2.39 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.23.1-.47.04-.66-.12a.58.58 0 0 1-.14-.17c-1.13-1.43-1.31-3.48-.55-5.12C5.78 10 4.87 12.3 5 14.47c.06.5.12 1 .29 1.5.14.6.41 1.2.71 1.73 1.08 1.73 2.95 2.97 4.96 3.22 2.14.27 4.43-.12 6.07-1.6 1.83-1.66 2.47-4.32 1.53-6.6l-.13-.26c-.21-.46-.77-1.26-.77-1.26m-3.16 6.3c-.28.24-.74.5-1.1.6-1.12.4-2.24-.16-2.9-.82 1.19-.28 1.9-1.16 2.11-2.05.17-.8-.15-1.46-.28-2.23-.12-.74-.1-1.37.17-2.06.19.38.39.76.63 1.06.77 1 1.98 1.44 2.24 2.8.04.14.06.28.06.43.03.82-.33 1.72-.93 2.27z'/></svg>");
--md-admonition-icon--admonish-success: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m9 20.42-6.21-6.21 2.83-2.83L9 14.77l9.88-9.89 2.83 2.83L9 20.42z'/></svg>");
--md-admonition-icon--admonish-question: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z'/></svg>");
--md-admonition-icon--admonish-warning: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>");
--md-admonition-icon--admonish-failure: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20 6.91 17.09 4 12 9.09 6.91 4 4 6.91 9.09 12 4 17.09 6.91 20 12 14.91 17.09 20 20 17.09 14.91 12 20 6.91z'/></svg>");
--md-admonition-icon--admonish-danger: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11 15H6l7-14v8h5l-7 14v-8z'/></svg>");
--md-admonition-icon--admonish-bug: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a5.985 5.985 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6.002 6.002 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8z'/></svg>");
--md-admonition-icon--admonish-example: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M7 13v-2h14v2H7m0 6v-2h14v2H7M7 7V5h14v2H7M3 8V5H2V4h2v4H3m-1 9v-1h3v4H2v-1h2v-.5H3v-1h1V17H2m2.25-7a.75.75 0 0 1 .75.75c0 .2-.08.39-.21.52L3.12 13H5v1H2v-.92L4 11H2v-1h2.25z'/></svg>");
--md-admonition-icon--admonish-quote: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 17h3l2-4V7h-6v6h3M6 17h3l2-4V7H5v6h3l-2 4z'/></svg>");
--md-details-icon: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42Z'/></svg>");
}
:is(.admonition) {
display: flow-root;
margin: 1.5625em 0;
padding: 0 1.2rem;
color: var(--fg);
page-break-inside: avoid;
background-color: var(--bg);
border: 0 solid black;
border-inline-start-width: 0.4rem;
border-radius: 0.2rem;
box-shadow: 0 0.2rem 1rem rgba(0, 0, 0, 0.05), 0 0 0.1rem rgba(0, 0, 0, 0.1);
}
@media print {
:is(.admonition) {
box-shadow: none;
}
}
:is(.admonition) > * {
box-sizing: border-box;
}
:is(.admonition) :is(.admonition) {
margin-top: 1em;
margin-bottom: 1em;
}
:is(.admonition) > .tabbed-set:only-child {
margin-top: 0;
}
html :is(.admonition) > :last-child {
margin-bottom: 1.2rem;
}
a.admonition-anchor-link {
display: none;
position: absolute;
left: -1.2rem;
padding-right: 1rem;
}
a.admonition-anchor-link:link, a.admonition-anchor-link:visited {
color: var(--fg);
}
a.admonition-anchor-link:link:hover, a.admonition-anchor-link:visited:hover {
text-decoration: none;
}
a.admonition-anchor-link::before {
content: "§";
}
:is(.admonition-title, summary.admonition-title) {
position: relative;
min-height: 4rem;
margin-block: 0;
margin-inline: -1.6rem -1.2rem;
padding-block: 0.8rem;
padding-inline: 4.4rem 1.2rem;
font-weight: 700;
background-color: rgba(68, 138, 255, 0.1);
display: flex;
}
:is(.admonition-title, summary.admonition-title) p {
margin: 0;
}
html :is(.admonition-title, summary.admonition-title):last-child {
margin-bottom: 0;
}
:is(.admonition-title, summary.admonition-title)::before {
position: absolute;
top: 0.625em;
inset-inline-start: 1.6rem;
width: 2rem;
height: 2rem;
background-color: #448aff;
mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"></svg>');
-webkit-mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"></svg>');
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-size: contain;
content: "";
}
:is(.admonition-title, summary.admonition-title):hover a.admonition-anchor-link {
display: initial;
}
details.admonition > summary.admonition-title::after {
position: absolute;
top: 0.625em;
inset-inline-end: 1.6rem;
height: 2rem;
width: 2rem;
background-color: currentcolor;
mask-image: var(--md-details-icon);
-webkit-mask-image: var(--md-details-icon);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-size: contain;
content: "";
transform: rotate(0deg);
transition: transform 0.25s;
}
details[open].admonition > summary.admonition-title::after {
transform: rotate(90deg);
}
:is(.admonition):is(.admonish-note) {
border-color: #448aff;
}
:is(.admonish-note) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(68, 138, 255, 0.1);
}
:is(.admonish-note) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #448aff;
mask-image: var(--md-admonition-icon--admonish-note);
-webkit-mask-image: var(--md-admonition-icon--admonish-note);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-abstract, .admonish-summary, .admonish-tldr) {
border-color: #00b0ff;
}
:is(.admonish-abstract, .admonish-summary, .admonish-tldr) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(0, 176, 255, 0.1);
}
:is(.admonish-abstract, .admonish-summary, .admonish-tldr) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #00b0ff;
mask-image: var(--md-admonition-icon--admonish-abstract);
-webkit-mask-image: var(--md-admonition-icon--admonish-abstract);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-info, .admonish-todo) {
border-color: #00b8d4;
}
:is(.admonish-info, .admonish-todo) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(0, 184, 212, 0.1);
}
:is(.admonish-info, .admonish-todo) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #00b8d4;
mask-image: var(--md-admonition-icon--admonish-info);
-webkit-mask-image: var(--md-admonition-icon--admonish-info);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-tip, .admonish-hint, .admonish-important) {
border-color: #00bfa5;
}
:is(.admonish-tip, .admonish-hint, .admonish-important) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(0, 191, 165, 0.1);
}
:is(.admonish-tip, .admonish-hint, .admonish-important) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #00bfa5;
mask-image: var(--md-admonition-icon--admonish-tip);
-webkit-mask-image: var(--md-admonition-icon--admonish-tip);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-success, .admonish-check, .admonish-done) {
border-color: #00c853;
}
:is(.admonish-success, .admonish-check, .admonish-done) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(0, 200, 83, 0.1);
}
:is(.admonish-success, .admonish-check, .admonish-done) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #00c853;
mask-image: var(--md-admonition-icon--admonish-success);
-webkit-mask-image: var(--md-admonition-icon--admonish-success);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-question, .admonish-help, .admonish-faq) {
border-color: #64dd17;
}
:is(.admonish-question, .admonish-help, .admonish-faq) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(100, 221, 23, 0.1);
}
:is(.admonish-question, .admonish-help, .admonish-faq) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #64dd17;
mask-image: var(--md-admonition-icon--admonish-question);
-webkit-mask-image: var(--md-admonition-icon--admonish-question);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-warning, .admonish-caution, .admonish-attention) {
border-color: #ff9100;
}
:is(.admonish-warning, .admonish-caution, .admonish-attention) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(255, 145, 0, 0.1);
}
:is(.admonish-warning, .admonish-caution, .admonish-attention) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #ff9100;
mask-image: var(--md-admonition-icon--admonish-warning);
-webkit-mask-image: var(--md-admonition-icon--admonish-warning);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-failure, .admonish-fail, .admonish-missing) {
border-color: #ff5252;
}
:is(.admonish-failure, .admonish-fail, .admonish-missing) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(255, 82, 82, 0.1);
}
:is(.admonish-failure, .admonish-fail, .admonish-missing) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #ff5252;
mask-image: var(--md-admonition-icon--admonish-failure);
-webkit-mask-image: var(--md-admonition-icon--admonish-failure);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-danger, .admonish-error) {
border-color: #ff1744;
}
:is(.admonish-danger, .admonish-error) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(255, 23, 68, 0.1);
}
:is(.admonish-danger, .admonish-error) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #ff1744;
mask-image: var(--md-admonition-icon--admonish-danger);
-webkit-mask-image: var(--md-admonition-icon--admonish-danger);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-bug) {
border-color: #f50057;
}
:is(.admonish-bug) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(245, 0, 87, 0.1);
}
:is(.admonish-bug) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #f50057;
mask-image: var(--md-admonition-icon--admonish-bug);
-webkit-mask-image: var(--md-admonition-icon--admonish-bug);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-example) {
border-color: #7c4dff;
}
:is(.admonish-example) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(124, 77, 255, 0.1);
}
:is(.admonish-example) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #7c4dff;
mask-image: var(--md-admonition-icon--admonish-example);
-webkit-mask-image: var(--md-admonition-icon--admonish-example);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
:is(.admonition):is(.admonish-quote, .admonish-cite) {
border-color: #9e9e9e;
}
:is(.admonish-quote, .admonish-cite) > :is(.admonition-title, summary.admonition-title) {
background-color: rgba(158, 158, 158, 0.1);
}
:is(.admonish-quote, .admonish-cite) > :is(.admonition-title, summary.admonition-title)::before {
background-color: #9e9e9e;
mask-image: var(--md-admonition-icon--admonish-quote);
-webkit-mask-image: var(--md-admonition-icon--admonish-quote);
mask-repeat: no-repeat;
-webkit-mask-repeat: no-repeat;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
}
.navy :is(.admonition) {
background-color: var(--sidebar-bg);
}
.ayu :is(.admonition),
.coal :is(.admonition) {
background-color: var(--theme-hover);
}
.rust :is(.admonition) {
background-color: var(--sidebar-bg);
color: var(--sidebar-fg);
}
.rust .admonition-anchor-link:link, .rust .admonition-anchor-link:visited {
color: var(--sidebar-fg);
}

24
src/assembly.md
View file

@ -2,7 +2,9 @@
This is an illustrated guide to making a NaxGCC, using photos taken of a NaxGCC board version 1.0.0. This is an illustrated guide to making a NaxGCC, using photos taken of a NaxGCC board version 1.0.0.
> **NOTE:** Assembling a NaxGCC is conceptually very similar to assembling a Phob 2.0, therefore many sections of this guide (including images) have been taken straight from the official PhobGCC assembly guide. Note that though some images may depict a PhobGCC, the steps are still applicable to the NaxGCC. In parts where the hardware differs, newer images have been used. ```admonish note
Assembling a NaxGCC is conceptually very similar to assembling a Phob 2.0, therefore many sections of this guide (including images) have been taken straight from the official PhobGCC assembly guide. Note that though some images may depict a PhobGCC, the steps are still applicable to the NaxGCC. In parts where the hardware differs, newer images have been used.
```
<img src="./assets/naxgcc-board-irl.jpg" style="display: block; margin-left: auto; margin-right: auto;" /> <img src="./assets/naxgcc-board-irl.jpg" style="display: block; margin-left: auto; margin-right: auto;" />
@ -120,9 +122,11 @@ Insert magnets into the magnet wells, making sure that the magnets are all orien
**If the magnets are not horizontal then the stick will not function.** **If the magnets are not horizontal then the stick will not function.**
> **NOTE:** The magnets should be inserted to have their polarity aligned, that is to say **if you were to remove the magnet mounts and hold them opposite each other, they should attract one another without attempting to flip orientation**. Mounting them differently may cause cross-axis interference, which can (and probably will) lead to erratic stick behavior. The NaxGCC firmware is especially sensitive to this. ```admonish note
> The magnets should be inserted to have their polarity aligned, that is to say **if you were to remove the magnet mounts and hold them opposite each other, they should attract one another without attempting to flip orientation**. Mounting them differently may cause cross-axis interference, which can (and probably will) lead to erratic stick behavior. The NaxGCC firmware is especially sensitive to this.
> If you're inserting your magnets into already-glued magnet mounts, you may use a third magnet to ensure you're inserting both the same way. **The third magnet should attract to both magnets you're inserting the same way around, without attempting to flip orientation.** It is recommended to mark the third magnet, so you don't forget which way it should be oriented.
If you're inserting your magnets into already-glued magnet mounts, you may use a third magnet to ensure you're inserting both the same way. **The third magnet should attract to both magnets you're inserting the same way around, without attempting to flip orientation.** It is recommended to mark the third magnet, so you don't forget which way it should be oriented.
```
<img src="./assets/asm-stickbox-withmagnets.png" style="display: block; margin-left: auto; margin-right: auto;" /> <img src="./assets/asm-stickbox-withmagnets.png" style="display: block; margin-left: auto; margin-right: auto;" />
@ -134,7 +138,9 @@ Set the stickboxes aside to cure.
The NaxGCC only makes use of the digital trigger paddles, as such it is highly recommended to modify the `L` & `R` triggers to include a 3D-printed stopper in order to raise their height and make them more comfortable to use. You can find the 3D-printable stopper files in the [NaxGCC-HW git repo](https://git.naxdy.org/NaxdyOrg/NaxGCC-HW/releases). Simply print two stoppers (or have someone print them for you) and slide them into the hole at the bottom of the triggers. The NaxGCC only makes use of the digital trigger paddles, as such it is highly recommended to modify the `L` & `R` triggers to include a 3D-printed stopper in order to raise their height and make them more comfortable to use. You can find the 3D-printable stopper files in the [NaxGCC-HW git repo](https://git.naxdy.org/NaxdyOrg/NaxGCC-HW/releases). Simply print two stoppers (or have someone print them for you) and slide them into the hole at the bottom of the triggers.
> **NOTE:** Be careful when reassembling the controller, as slightly depressing the triggers may cause the rubber to be pushed out. ```admonish warning
Be careful when reassembling the controller, as slightly depressing the triggers may cause the rubber to be pushed out.
```
### Board Preparation ### Board Preparation
@ -258,9 +264,13 @@ If you're using an OEM top shell, you will need to modify it to allow the USB ca
More advanced modders, feel free to use a dremel or a drill to make a cleaner hole. More advanced modders, feel free to use a dremel or a drill to make a cleaner hole.
> **NOTE:** When melting or sanding, take care to wear breathing protection and work in a well-ventilated area. The fumes from melting plastic are toxic, and inhaling microplastics is not particularly good for your health either. ```admonish danger
When melting or sanding, take care to wear breathing protection and work in a well-ventilated area. The fumes from melting plastic are toxic, and inhaling microplastics is not particularly good for your health either.
```
> **NOTE:** It is highly recommended to only do this with a soldering iron that has exchangeable tips, as the plastic will stick to the tip and reduce its usefulness for actual soldering. Conical tips are best expended for this, since they aren't very good at making surface contact for soldering anyway. ```admonish tip
It is highly recommended to only do this with a soldering iron that has exchangeable tips, as the plastic will stick to the tip and reduce its usefulness for actual soldering. Conical tips are best expended for this, since they aren't very good at making surface contact for soldering anyway.
```
The end result should look something like this: The end result should look something like this:

47
src/configuration.md
View file

@ -63,7 +63,9 @@ Finally, after having tuned your snapback, you'll probably want to select your p
These are all options you have while config mode is active. Config mode is activated by simultaneously pressing `A+X+Y+Start`. These are all options you have while config mode is active. Config mode is activated by simultaneously pressing `A+X+Y+Start`.
> **NOTE:** When entering config mode, ensure you do not _hold_ the `A+X+Y+Start` combo for multiple seconds. The reason is that the same combo is used to _exit_ config mode, and keeping it held during config mode activation will cause you to immediately leave it again. It is recommended to enter config mode by holding `A+X+Y` and simply _tapping_ `Start`. ```admonish caution
When entering config mode, ensure you do not _hold_ the `A+X+Y+Start` combo for multiple seconds. The reason is that the same combo is used to _exit_ config mode, and keeping it held during config mode activation will cause you to immediately leave it again. It is recommended to enter config mode by holding `A+X+Y` and simply _tapping_ `Start`.
```
--- ---
@ -87,7 +89,9 @@ When in the measurement phase, the other stick's position (the one you're **not*
- If the other stick is centered, let go of the stick you're calibrating and press `A` to record that position. - If the other stick is centered, let go of the stick you're calibrating and press `A` to record that position.
- If the other stick is not centered, move the stick you're calibrating into that position, ensuring that it is perfectly located within the notch, and press `A` to measure that position. - If the other stick is not centered, move the stick you're calibrating into that position, ensuring that it is perfectly located within the notch, and press `A` to measure that position.
**NOTE:** If you don't have a notch in the position the other stick indicates, simply let go of the stick you're calibrating and press `A` to advance. This notch will then be marked as "Inactive" by the firmware. ```admonish note
If you don't have a notch in the position the other stick indicates, simply let go of the stick you're calibrating and press `A` to advance. This notch will then be marked as "Inactive" by the firmware.
```
- You **must measure all four cardinal directions (East, North, West, South) and all four diagonal directions** or calibration will not work. - You **must measure all four cardinal directions (East, North, West, South) and all four diagonal directions** or calibration will not work.
@ -145,7 +149,9 @@ When the other stick's position returns to center, or resumes displaying the act
**Button Combo (C-Stick):** `A+Z+X/Y+Du/Dd` **Button Combo (C-Stick):** `A+Z+X/Y+Du/Dd`
> **NOTE:** This feature is currently unused for the C-Stick. While you can still adjust the values, changing them won't actually affect the stick's behavior. ```admonish note
This feature is currently unused for the C-Stick. While you can still adjust the values, changing them won't actually affect the stick's behavior.
```
Button combos for adjusting values for the C-Stick are the same as for the analog stick, with an added press of the `Z` button. Button combos for adjusting values for the C-Stick are the same as for the analog stick, with an added press of the `Z` button.
@ -201,7 +207,9 @@ Press `L+Start` while in config mode to display the waveshaping values on each s
**Button Combo (C-Stick):** `L+Z+A+Du/Dd` **Button Combo (C-Stick):** `L+Z+A+Du/Dd`
> **NOTE:** This feature has simply been ported over from the PhobGCC for compatibility reasons, but is not very useful for Super Smash Bros. Ultimate. It is recommended to leave this setting at its default value of `100`. ```admonish note
This feature has simply been ported over from the PhobGCC for compatibility reasons, but is not very useful for Super Smash Bros. Ultimate. It is recommended to leave this setting at its default value of `100`.
```
Button combos for adjusting values for the C-Stick are the same as for the analog stick, with an added press of the `Z` button. Button combos for adjusting values for the C-Stick are the same as for the analog stick, with an added press of the `Z` button.
@ -223,7 +231,9 @@ The Stick Scaling setting allows the user to adjust what value the stick can rea
**Button Combo (C-Stick):** `R+Z+A+Du/Dd` **Button Combo (C-Stick):** `R+Z+A+Du/Dd`
> **NOTE:** This feature has simply been ported over from the PhobGCC for compatibility reasons, but is not very useful for Super Smash Bros. Ultimate. It is recommended to leave this setting at its default value of `6`. ```admonish note
This feature has simply been ported over from the PhobGCC for compatibility reasons, but is not very useful for Super Smash Bros. Ultimate. It is recommended to leave this setting at its default value of `6`.
```
Button combos for adjusting values for the C-Stick are the same as for the analog stick, with an added press of the `Z` button. Button combos for adjusting values for the C-Stick are the same as for the analog stick, with an added press of the `Z` button.
@ -284,11 +294,28 @@ Cycles the input consistency setting through its three modes and displays which
For more information about the different input consistency modes, consult the [Input Consistency Mode](./input-consistency.md#input-consistency-modes) list. For more information about the different input consistency modes, consult the [Input Consistency Mode](./input-consistency.md#input-consistency-modes) list.
> **NOTE:** This setting will only become active upon unplugging and replugging the controller. The controller will then indicate the mode it's in by changing its device name. You can then use your operating system's device viewer to have a look at the device name and determine which mode is currently active. For example, under Linux you can run `lsusb -v` and look for `NaxGCC`: ```admonish note
> This setting will only become active upon unplugging and replugging the controller. The controller will then indicate the mode it's in by changing its device name. You can then use your operating system's device viewer to have a look at the device name and determine which mode is currently active. For example, under Linux you can run `lsusb -v` and look for `NaxGCC`:
> <img src="./assets/consistency-mode.png" style="display: block; margin-left: auto; margin-right: auto;" />
> <img src="./assets/consistency-mode.png" style="display: block; margin-left: auto; margin-right: auto;" />
> <img src="./assets/consistency-mode-2.png" style="display: block; margin-left: auto; margin-right: auto;" /> <img src="./assets/consistency-mode-2.png" style="display: block; margin-left: auto; margin-right: auto;" />
```
---
## Pro Controller Mode
`Since: v1.2.0`
**Button Combo:** `Start` while plugging in the controller
Makes the NaxGCC present itself as a Nintendo Switch Pro Controller instead of a GameCube adapter with 1 controller connected. While in this mode, pressing `Z+Start` will behave like pressing the home button on a regular Pro Controller. Additionally, pressing `L` will press both `L` and `ZL` at the same time.
If you unplug your controller, then plug it in again _without_ holding `Start`, it will once again show up as a regular GameCube controller.
```admonish note
Switch firmware version 19.0.0 suffers from a known issue with GCC adapters (including NaxGCC, which pretends to be one). It is recommended to use Pro Controller Mode if you are on Switch firmware version 19.0.0. If not, it is entirely up to personal preference.
```
--- ---

22
src/input-consistency.md
View file

@ -2,7 +2,9 @@
This is a rather technical document about USB polling, input latency, and the issues that arise with input consistency. If you only care about the NaxGCC's solutions to this problem, and not the background knowledge, you can skip ahead to the [Input Consistency Modes](#input-consistency-modes) section. This is a rather technical document about USB polling, input latency, and the issues that arise with input consistency. If you only care about the NaxGCC's solutions to this problem, and not the background knowledge, you can skip ahead to the [Input Consistency Modes](#input-consistency-modes) section.
> **NOTE:** "Input consistency" and "input integrity" are used interchangeably in this document, and refer to the predictability with regards to the frame on which your input will come out. ```admonish note
"Input consistency" and "input integrity" are used interchangeably in this document, and refer to the predictability with regards to the frame on which your input will come out.
```
[[_TOC_]] [[_TOC_]]
@ -61,7 +63,9 @@ The original full-length videos of the experiment are saved and uploaded to my Y
- [OG controller mode](https://www.youtube.com/watch?v=UG7NFoMiE-Y) - [OG controller mode](https://www.youtube.com/watch?v=UG7NFoMiE-Y)
- [Input consistency mode](https://www.youtube.com/watch?v=MNcWOTF9fLk) - [Input consistency mode](https://www.youtube.com/watch?v=MNcWOTF9fLk)
> **NOTE:** Repetition of this experiment is important, because in theory, it is possible to get "lucky" by plugging in the controller during the first $8.\overline{6}\mathrm{ms}$ of a frame capture window, and then never unplugging it, which would result in a theoretical $\approx100\%$ accuracy. However, this is not a realistic scenario, and the experiment has been repeated multiple times to ensure that the results are consistent. ```admonish note
Repetition of this experiment is important, because in theory, it is possible to get "lucky" by plugging in the controller during the first $8.\overline{6}\mathrm{ms}$ of a frame capture window, and then never unplugging it, which would result in a theoretical $\approx100\%$ accuracy. However, this is not a realistic scenario, and the experiment has been repeated multiple times to ensure that the results are consistent.
```
# Input Consistency Modes # Input Consistency Modes
@ -75,18 +79,22 @@ In regular mode, the NaxGCC will not attempt to modify the polling rate of the c
Same as Regular mode, except it asks to be polled at 1000Hz instead of 125Hz. This is useful if you're planning to use your controller on pretty much any device that isn't the Nintendo Switch. This mode carries the lowest latency, so if the device you're connecting to supports it, it is recommended to use this mode. Same as Regular mode, except it asks to be polled at 1000Hz instead of 125Hz. This is useful if you're planning to use your controller on pretty much any device that isn't the Nintendo Switch. This mode carries the lowest latency, so if the device you're connecting to supports it, it is recommended to use this mode.
> **NOTE:** This is not recommended for use on the Switch, because it carries no benefit over Regular mode, and may actually lead to incompatibilities with other connected devices. ```admonish note
This is not recommended for use on the Switch, because it carries no benefit over Regular mode, and may actually lead to incompatibilities with other connected devices.
```
### Consistency Mode ### Consistency Mode
In consistency mode, the NaxGCC introduces a variable delay in order to wait responding to a poll request from the console until exactly $8.\overline{3}\mathrm{ms}$ (half a frame) have elapsed since the last status update. This ensures that the controller is polled exactly twice as often as the game updates and (nearly) eliminates the chance of your inputs being misinterpreted. This is the recommended mode for competitive play, and is the default mode for the NaxGCC. In consistency mode, the NaxGCC introduces a variable delay in order to wait responding to a poll request from the console until exactly $8.\overline{3}\mathrm{ms}$ (half a frame) have elapsed since the last status update. This ensures that the controller is polled exactly twice as often as the game updates and (nearly) eliminates the chance of your inputs being misinterpreted. This is the recommended mode for competitive play, and is the default mode for the NaxGCC.
> **NOTE:** While this is not exactly in-spec behavior for a USB device, it is still within the realm of what is generally considered to be "acceptable" with USB, and has been extensively tested to ensure that it does not cause any issues with the console. ```admonish note
While this is not exactly in-spec behavior for a USB device, it is still within the realm of what is generally considered to be "acceptable" with USB, and has been extensively tested to ensure that it does not cause any issues with the console.
```
### "Super Hack" Mode ### "Super Hack" Mode
In "super hack" mode, the NaxGCC abstains from responding to the console's poll requests until the controller state has changed, _and_ at least $8.\overline{3}\mathrm{ms}$ have elapsed since the last poll request. This ensures that, for inputs made more than $8.\overline{3}\mathrm{ms}$ apart, the latency is minimized, since the state is immediately dispatched to, and interpreted by, the console, at a slight cost to input integrity for inputs made less than $8.\overline{3}\mathrm{ms}$ apart. In "super hack" mode, the NaxGCC abstains from responding to the console's poll requests until the controller state has changed, _and_ at least $8.\overline{3}\mathrm{ms}$ have elapsed since the last poll request. This ensures that, for inputs made more than $8.\overline{3}\mathrm{ms}$ apart, the latency is minimized, since the state is immediately dispatched to, and interpreted by, the console, at a slight cost to input integrity for inputs made less than $8.\overline{3}\mathrm{ms}$ apart.
> **WARNING:** This mode is currently experimental, as it is still undergoing extensive testing, and is currently **not** recommended for tournament play. ```admonish note
"Super Hack" does not refer to this being a hack that is super, but rather something that is super hacky, since this pretty much out of spec behavior for a USB HID. However, it works!
> **NOTE:** "Super Hack" does not refer to this being a hack that is super, but rather something that is super hacky, since this pretty much out of spec behavior for a USB HID. ```

20
src/jlcpcb-parts-ordering.md
View file

@ -22,9 +22,13 @@ Since the NaxGCC board is fully integrated, all of the non-GCC components are so
The following parts usually have low stock and pre-ordering them is advised: The following parts usually have low stock and pre-ordering them is advised:
> **NOTE:** These part quantities are for a single NaxGCC board. You need to multiply them by the number of boards you plan to order. ```admonish note
These part quantities are for a single NaxGCC board. You need to multiply them by the number of boards you plan to order.
```
> **NOTE:** You can only order PCBs in quantities of 5, 10, 15, 20, 25, 30, 50, or more. Do not order SMD components for amounts other than these or you will either have unused extra parts or unpopulated PCBs later. ```admonish note
You can only order PCBs in quantities of 5, 10, 15, 20, 25, 30, 50, or more. Do not order SMD components for amounts other than these or you will either have unused extra parts or unpopulated PCBs later.
```
- [1x RP2040](https://jlcpcb.com/partdetail/RaspberryPi-RP2040/C2040) - [1x RP2040](https://jlcpcb.com/partdetail/RaspberryPi-RP2040/C2040)
- [1x Winbond NOR Flash Chip](https://jlcpcb.com/partdetail/WinbondElec-W25Q128JVSIQ/C97521)$^1$ - [1x Winbond NOR Flash Chip](https://jlcpcb.com/partdetail/WinbondElec-W25Q128JVSIQ/C97521)$^1$
@ -46,7 +50,9 @@ Some of the parts may be in stock and be available immediately. You must wait un
## Purchasing the NaxGCC board from JLCPCB ## Purchasing the NaxGCC board from JLCPCB
> **NOTE:** Once your pre-ordered SMD Components have come in (report as "Complete" in the parts order history), you may proceed to ordering boards. If they are not in, the parts will not be present on your board, and your board will not be functional. ```admonish warning
Once your pre-ordered SMD Components have come in (report as "Complete" in the parts order history), you may proceed to ordering boards. If they are not in, the parts will not be present on your board, and your board will not be functional.
```
Download the files available in the [NaxGCC-HW git repo](https://git.naxdy.org/NaxdyOrg/NaxGCC-HW/releases) in the releases section as shown below: Download the files available in the [NaxGCC-HW git repo](https://git.naxdy.org/NaxdyOrg/NaxGCC-HW/releases) in the releases section as shown below:
@ -70,9 +76,13 @@ Once you've checked that the size is set to `96.07x125.5mm`, you can progress wi
Scroll down to PCB Assembly and toggle it on the right. Select Standard PCBA Type (Not available for large orders or colors), the top side, and confirm parts placement as seen below. Scroll down to PCB Assembly and toggle it on the right. Select Standard PCBA Type (Not available for large orders or colors), the top side, and confirm parts placement as seen below.
> **NOTE:** For large orders such as more than 50 boards or different colors, Standard Assembly is required. This attaches removable rails to the PCB at a significant extra cost. ```admonish note
For large orders such as more than 50 boards or different colors, Standard Assembly is required. This attaches removable rails to the PCB at a significant extra cost.
```
> **NOTE:** If arranging group buys or purchasing in large quantities, we strongly suggest using Standard PCBA so DOA boards are less likely. ```admonish note
If arranging group buys or purchasing in large quantities, we strongly suggest using Standard PCBA so DOA boards are less likely.
```
<img src="./assets/jlc-assembly-config.png" style="display: block; margin-left: auto; margin-right: auto;" /> <img src="./assets/jlc-assembly-config.png" style="display: block; margin-left: auto; margin-right: auto;" />

10
src/phob2-to-naxgcc.md
View file

@ -22,9 +22,11 @@ The alternative method involves modifying only your controller shell to allow a
You will also need a **right-angle micro USB cable** to connect to the Phob board. This is because the clearance between the board and the shell is very tight, and a regular micro USB cable will not fit. Alternatively, you can drill or melt a hole in the top part of the shell, but this is not recommended as it will make the controller less comfortable to hold. You will also need a **right-angle micro USB cable** to connect to the Phob board. This is because the clearance between the board and the shell is very tight, and a regular micro USB cable will not fit. Alternatively, you can drill or melt a hole in the top part of the shell, but this is not recommended as it will make the controller less comfortable to hold.
> **NOTE:** When choosing a right-angle micro USB cable to buy, keep in mind that the wide side of the trapezoid connector is going to be facing upwards when the controller is held normally. Most right-angle micro USB cables have the wide side facing downwards, so you will need to find one that fits this particular use case. Here's an example of what it _should_ look like: ```admonish note
> When choosing a right-angle micro USB cable to buy, keep in mind that the wide side of the trapezoid connector is going to be facing upwards when the controller is held normally. Most right-angle micro USB cables have the wide side facing downwards, so you will need to find one that fits this particular use case. Here's an example of what it _should_ look like:
> <img src="./assets/angle-usb.png" style="display: block; margin-left: auto; margin-right: auto;" />
> &nbsp; <img src="./assets/angle-usb.png" style="display: block; margin-left: auto; margin-right: auto;" />
&nbsp;
```
After flashing the firmware and making all the necessary modifications, it's now time to go ahead and [configure your controller](./configuration.md) to your liking. Enjoy your new NaxGCC! After flashing the firmware and making all the necessary modifications, it's now time to go ahead and [configure your controller](./configuration.md) to your liking. Enjoy your new NaxGCC!

20
src/update-firmware.md
View file

@ -2,7 +2,9 @@
Keeping your firmware up-to-date is recommended to ensure you benefit from the latest features, fixes, and improvements to performance. New versions of the firmware are published at the [official NaxGCC-FW repo's release page](https://git.naxdy.org/NaxdyOrg/NaxGCC-FW/releases) Keeping your firmware up-to-date is recommended to ensure you benefit from the latest features, fixes, and improvements to performance. New versions of the firmware are published at the [official NaxGCC-FW repo's release page](https://git.naxdy.org/NaxdyOrg/NaxGCC-FW/releases)
> **NOTE:** Take care not to accidentally download the _nightly_ release, as these are experimental and may not be stable, unless you want to be a guinea pig for new features. ```admonish caution
Take care not to accidentally download the _nightly_ release, as these are experimental and may not be stable, unless you want to be a guinea pig for new features.
```
## Flashing your controller for the first time ## Flashing your controller for the first time
@ -14,14 +16,20 @@ Simply plug in your NaxGCC to your computer. It will show up as a regular mass-s
If you already have a controller with firmware on it, updating is easy. Simply plug in your NaxGCC to your computer while keeping the `A+X+Y` buttons held. The controller will show up as a mass-storage device, similar to when you first plugged it in. Drag & drop the new firmware binary onto the device, and you're done! If you already have a controller with firmware on it, updating is easy. Simply plug in your NaxGCC to your computer while keeping the `A+X+Y` buttons held. The controller will show up as a mass-storage device, similar to when you first plugged it in. Drag & drop the new firmware binary onto the device, and you're done!
> **NOTE:** Major firmware updates (e.g. `1.x.x` to `2.x.x`), **WILL** cause your configuration and calibration to be reset! For these updates, it is recommended to write down your config values for things such as snapback, stick smoothing, etc. before updating. Also make sure to set aside some time to recalibrate your sticks after updating. ```admonish warning
> Major firmware updates (e.g. `1.x.x` to `2.x.x`), **WILL** cause your configuration and calibration to be reset! For these updates, it is recommended to write down your config values for things such as snapback, stick smoothing, etc. before updating. Also make sure to set aside some time to recalibrate your sticks after updating.
> Minor firmware updates (e.g. `1.0.x` to `1.1.x`) and fix updates (e.g. `1.0.0` to `1.0.1`) will not cause your configuration to be reset, and you can safely update without having to recalibrate.
> **NOTE:** If holding the `A+X+Y` buttons doesn't work, e.g. because the connection was interrupted during the last flashing of the firmware, and the controller is stuck in a non-functional state, you must take it apart and press the `BOOTSEL` switch on the controller board itself. This is a small button located near the center of the board. Hold this button down while plugging in the controller to your computer, and it will show up as a mass-storage device. You can then drag & drop the firmware binary onto it. Minor firmware updates (e.g. `1.0.x` to `1.1.x`) and fix updates (e.g. `1.0.0` to `1.0.1`) will not cause your configuration to be reset, and you can safely update without having to recalibrate.
```
```admonish note
If holding the `A+X+Y` buttons doesn't work, e.g. because the connection was interrupted during the last flashing of the firmware, and the controller is stuck in a non-functional state, you must take it apart and press the `BOOTSEL` switch on the controller board itself. This is a small button located near the center of the board. Hold this button down while plugging in the controller to your computer, and it will show up as a mass-storage device. You can then drag & drop the firmware binary onto it.
```
## Downgrading your firmware ## Downgrading your firmware
If you ever need to downgrade your firmware, the process is the same as updating. Simply plug in your NaxGCC to your computer while keeping the `A+X+Y` buttons held. The controller will show up as a mass-storage device, similar to when you first plugged it in. Drag & drop the old firmware binary onto the device, and you're done! If you ever need to downgrade your firmware, the process is the same as updating. Simply plug in your NaxGCC to your computer while keeping the `A+X+Y` buttons held. The controller will show up as a mass-storage device, similar to when you first plugged it in. Drag & drop the old firmware binary onto the device, and you're done!
> **NOTE:** The same rules as for updating apply here. Major downgrades will cause your configuration and calibration to be reset, while minor downgrades and fix downgrades will not. ```admonish note
The same rules as for updating apply here. Major downgrades will cause your configuration and calibration to be reset, while minor downgrades and fix downgrades will not.
```