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.

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

Updated references to profile edit pointing to the ctrl app #112

Merged
merged 1 commit into from
Dec 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/pug/alpakka.pug
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ block page
h2 No bloat software
p: i "Gaming peripherals and bloatware apps, name a more iconic duo"
p No drivers, no overlays, no bloat. The Alpakka firmware emulates as a standard keyboard, mouse, and Xinput gamepad at hardware level; so it just works out of the box in Windows and Linux, and every game launcher.
p Instead of having per-game configurations, the firmware includes #[+a('alpakka/manual/profiles') per-genre profiles], which are also editable in an optional configuration app: #[+a('alpakka/manual/ctrl_app') Ctrl app] (Work in progress).
p Instead of having per-game configurations, the firmware includes #[+a('alpakka/manual/profiles') per-genre profiles], which are also editable in an optional configuration app: #[+a('alpakka/manual/ctrl_app') Ctrl app].


div.box.image.colored(style='border-radius:10px')
Expand Down Expand Up @@ -55,7 +55,7 @@ block page
li #[+done(1)] 3D-printed prototypes.
li #[+done(1)] Closed alpha testing (5 testers).
li #[+done(1)] Reference designs.
li #[+done(0)] More built-in profiles / Edit profiles.
li #[+done(1)] Edit profiles.
li #[+done(0)] Wireless.
li #[+done(0)] Vibration.

Expand Down
6 changes: 4 additions & 2 deletions src/pug/alpakka/components.pug
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,11 @@ block page
td Alpakka PCB ready-to-order files
td: +ax('https://github.com/inputlabs/alpakka_pcb/releases/latest') GitHub
tr
td Alpakka PCB with soldered SMD components.
td Alpakka PCB (Partially soldered)
td: +ax('https://inputlabs.squarespace.com/everyone/p/alpakka-pcb') Input Labs shop
tr
td Alpakka PCB (Fully soldered)
td: +ax('https://inputlabs.squarespace.com/everyone/p/alpakka-pcb-soldered') Input Labs shop

div.box
h2 Case and buttons
Expand Down Expand Up @@ -70,7 +73,6 @@ block page
td Protopasta PLA Conductive
td: +ax('https://www.proto-pasta.com/collections/conductive/products/conductive-pla') Protopasta shop


div.box
h2 Electronics
p This includes the micro-controller, as well as through-hole components. Those are usually not soldered by the PCB manufacturer, so you may want to solder them yourself, and later you may even want to to replace worn components. See #[+a('manual/specs') specs].
Expand Down
1 change: 0 additions & 1 deletion src/pug/alpakka/manual/_manual.pug
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ block page
+wikilink('dev') Firmware development
+wikilink('dev_unix') Setup in Linux
+wikilink('dev_windows') Setup in Windows
+wikilink('dev_profiles') Modify profiles
div.inactive PCB development #[i (soon)]
div.inactive Case mods #[i (soon)]

Expand Down
11 changes: 8 additions & 3 deletions src/pug/alpakka/manual/calibrate.pug
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@ block append title

block content
h2 Calibrate
hr

hr
h3 What is calibration
p The thumbstick X/Y axis potentiometers, and the angular rate sensor (gyro), are components that require calibration at least once to be #[em perfectly centered and accurate]. Otherwise its analog electrical signal could be misinterpreted and assigned wrong values.
hr

hr
h3 When to calibrate
ul
li The very first time the controller is used.
li If the firmware is updated.
li If the thumbstick output is not centered (eg: your character keeps moving when you are not touching the thumbstick).
li If the gyro output is not centered (eg: mouse cursor keeps moving in a particular direction when the controller is held still).
li Approximately each 1000 hours of use.

hr
h3 How to calibrate in the Ctrl app

img.wm.mr.mt(src='/static/manual/ctrl_app_calibrate.png')

h3 To start the calibration procedure
hr
h3 How to calibrate directly in the controller
ul
li Leave the thumbstick in its most natural centered position.
li Put the controller resting on a flat surface.
Expand Down
9 changes: 4 additions & 5 deletions src/pug/alpakka/manual/ctrl_app.pug
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ block content
h2 Ctrl app
hr
p An #[em optional] app for Input Labs devices, able to run diagnostics, configure the controller settings, and modify profile mappings.
p The app is hosted at #[+ax('http://ctrl.inputlabs.io') ctrl.inputlabs.io] and it is compatible with Windows, Linux and the Steam Deck; without the need to install any additional software in your computer.
p The app is hosted at #[+ax('http://ctrl.inputlabs.io') ctrl.inputlabs.io] and it is compatible with Windows, Linux and the Steam Deck; without the need to install any additional software in your computer (but it must be used with a WebUSB compatible browser).
p The source code is available at #[+ax(org.repo+'ctrl') GitHub] and it is open source.
p Some features are missing since the application is still under active development.
p  

img.wm.mr(src='/static/manual/ctrl_app_screenshot_1.png')
img.wm.mr(src='/static/manual/ctrl_app_screenshot_2.png')

img.wm.mr.mt(src='/static/manual/ctrl_app_logs.png')

img.wm.mr.mt(src='/static/manual/ctrl_app_profiles.png')
102 changes: 0 additions & 102 deletions src/pug/alpakka/manual/dev_profiles.pug

This file was deleted.

5 changes: 1 addition & 4 deletions src/pug/alpakka/manual/profiles.pug
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,5 @@ block content
hr

h3 Create or edit profiles
p While most of people won't need to tinker with profiles, we understand that some players will have to, either because physical constrains or because very specific niche games.
p We are still developing the #[+a('ctrl_app') Ctrl app] in which profiles can be modified. Meanwhile another way to tweak profiles is to edit and compile the firmware yourself. See #[+a('dev_profiles') Modify Profiles] page.
p Also please remember you can #[+a('/contribute') Contribute] with Input Labs, and help us developing these.
p Alternatively, the Steam input configurator UI can also be used to remap controls.
p While most of people won't need to tinker with profiles, we understand that some players will have to, either because physical constrains or because very specific niche games. So we made possible to edit profiles directly in the #[+a('ctrl_app') Ctrl app].

36 changes: 25 additions & 11 deletions src/pug/alpakka/manual/tune.pug
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,19 @@ block content
hr

p Tune settings define how the controller works at a fundamental level, independently from the operative system. these settings are applied to all profiles, and will be stored in the controller memory even if the controller is powered off.
p Tune settings are configurable by the user directly on the controller:
p Tune settings are configurable directly on the controller, or also in the Ctrl app.

hr
h3 In the Ctrl app

ul
li Settings tab in the header.

img.wm.mr.mt(src='/static/manual/ctrl_app_settings.png')

hr
h3 In the controller

ul
li Hold the #[em Home #[+home]] button.
li Hold the #[em Directional Hat #[+hat]] either up, down, left or right. Each direction tune a different option (see below).
Expand Down Expand Up @@ -53,16 +65,19 @@ block content
div + hold Hat left #[+hat]←
td.center
img(src='/static/manual/led_tune_left_0.png' width='50px')
div 5%
div Low
div 8%
i (Default)
td
td.center
img(src='/static/manual/led_tune_left_1.png' width='50px')
div 10%
div Mid
div 12%
td
td.center
img(src='/static/manual/led_tune_left_2.png' width='50px')
div 15%
div High
div 20%
tr
td.middle
h3 Touch sensitivity
Expand Down Expand Up @@ -106,21 +121,20 @@ block content
div 4K

hr
h3 Protocol mode
h3 Settings description

h4 Protocol mode
p Defines how the controller communicates with the computer operating system, XInput for either Windows or Linux are the most recommended, but in some cases the generic gamepad mode can also be useful (eg. Retro games and simulators).
hr

h3 Thumbstick deadzone
h4 Thumbstick deadzone
p Defines how much of the inner movement of the thumbstick will be ignored, increase this according to your thumbstick wear (thumbstick centering spring will get softer over time). Please check #[+a('calibrate') Calibration] instructions before tweaking this parameter.
hr

h3 Touch sensitivity
h4 Touch sensitivity
p Defines how sensitive the touch surface is. Depending on which conductive material was used on the touch surface you may want to tweak this parameter:
ul
li The automatic setting will adjust the sensitivity dynamically.
li Set a higher fixed sensitivity if the detection is not registered consistently.
li Set a lower fixed sensitivity if the detection is taking too long to be released after the finger is lifted.
hr

h3 Mouse sensitivity
h4 Mouse sensitivity
p Defines how sensitive the mouse emulation is, using recommended values for different display resolution with the default OS sensitivity. This is similar to changing the DPI on a traditional mouse. Check #[+a('setup') OS setup] and #[+a('mouse') Mouse] for more details.
4 changes: 2 additions & 2 deletions src/pug/blog/report_17.pug
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ block content

p The app is accessible at #[+ax('https://ctrl.inputlabs.io') ctrl.inputlabs.io] and it is compatible with #[em Windows], #[em Linux], and the #[em Steam Deck]. (Requires an internet browser with WebUSB support).

img.wm.mr.mt(src='/static/manual/ctrl_app_screenshot_1.png')
img.wm.mr.mt(src='/static/manual/ctrl_app_screenshot_2.png')
img.wm.mr.mt(src='/static/manual/ctrl_app_logs_old.png')
img.wm.mr.mt(src='/static/manual/ctrl_app_profiles_old.png')
hr

h3 Research with Pico-W Bluetooth continues
Expand Down
6 changes: 3 additions & 3 deletions src/pug/blog/report_19.pug
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ block content
p In addition to some minor improvements and fixes, this version provides the ability to #[em edit profiles conveniently in the app] and have changes immediately stored and reflected in the Alpakka.

br
img(src='/static/manual/ctrl_app_screenshot_3.png').wm
img(src='/static/manual/ctrl_app_profiles.png').wm

hr
h3 Wireless communication progress
Expand All @@ -37,14 +37,14 @@ block content

hr
h3 Bug tracking
p Something we have not been exercising consistently is the tracking of pending tasks and bugs at individual repositories level. So now we are now doing a bit better:
p Something we have not been exercising consistently is the tracking of pending tasks and bugs at individual repositories level. So now we are doing a bit better:
ul
li: +ax('https://github.com/inputlabs/alpakka_firmware/issues') Alpakka firmware open issues
li: +ax('https://github.com/inputlabs/ctrl/issues') Ctrl app open issues

p This is not only making our lifes easier (so we do not have to rememeber all of that), but makes the project much more transparent, and easy for anyone to check the status of features and bugs, to comment, or even to contribute.

hr
p Enjoy the winter solstice celebrations!
p Enjoy the solstice celebrations!

p - Marcos and Michael <3
11 changes: 7 additions & 4 deletions src/pug/contribute/open_source.pug
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,13 @@ block page
true
)

div.box
h2 Feedback
p Input Labs is a #[em community-driven] effort, so you make us all better by simply using our stuff, and sharing your feedback and ideas with the other members.
p Join our #[+ax(org.discord) Discord] server and take part in technical or casual discussions.
+boximglink(
'/static/community/repo_ctrl.png',
org.repo+'ctrl',
'Ctrl app',
true,
true
)

div.box
h2 Become a tester
Expand Down
Binary file added src/static/community/repo_ctrl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/static/manual/ctrl_app_calibrate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/static/manual/ctrl_app_logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/static/manual/ctrl_app_profiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/static/manual/ctrl_app_screenshot_3.png
Binary file not shown.
Binary file added src/static/manual/ctrl_app_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading