mirror of
https://github.com/eliasstepanik/strudel-docker.git
synced 2026-01-11 05:38:34 +00:00
Add DOCS for gamepad module
This commit is contained in:
nkymut
parent
f01d51f76a
commit
033b123ae0
96
packages/gamepad/docs/gamepad.mdx
Normal file
96
packages/gamepad/docs/gamepad.mdx
Normal file
@ -0,0 +1,96 @@
|
||||
import { MiniRepl } from '../../../website/src/docs/MiniRepl';
|
||||
|
||||
# Gamepad
|
||||
|
||||
The Gamepad module allows you to integrate gamepad input functionality into your musical patterns. This can be particularly useful for live performances or interactive installations where you want to manipulate sounds using a game controller.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Initialize a gamepad by calling the gamepad() function with an optional index parameter.
|
||||
|
||||
<MiniRepl
|
||||
client:idle
|
||||
tune={`// Initialize gamepad (optional index parameter, defaults to 0)
|
||||
const pad = gamepad(0)`}
|
||||
/>
|
||||
|
||||
## Available Controls
|
||||
|
||||
The gamepad module provides access to buttons and analog sticks as normalized signals (0-1) that can modulate your patterns.
|
||||
|
||||
### Buttons
|
||||
|
||||
| Type | Controls |
|
||||
| ---------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| Face Buttons | `a`, `b`, `x`, `y` (or uppercase `A`, `B`, `X`, `Y`) |
|
||||
| | Toggle versions: `tglA`, `tglB`, `tglX`, `tglY` |
|
||||
| Shoulder Buttons | `lb`, `rb`, `lt`, `rt` (or uppercase `LB`, `RB`, `LT`, `RT`) |
|
||||
| | Toggle versions: `tglLB`, `tglRB`, `tglLT`, `tglRT` |
|
||||
| D-Pad | `up`, `down`, `left`, `right` (or `u`, `d`, `l`, `r` or uppercase) |
|
||||
| | Toggle versions: `tglUp`, `tglDown`, `tglLeft`, `tglRight` (or `tglU`, `tglD`, `tglL`, `tglR`) |
|
||||
|
||||
### Analog Sticks
|
||||
|
||||
| Stick | Controls |
|
||||
| ----------- | ------------------------------ |
|
||||
| Left Stick | `x1`, `y1` (0 to 1 range) |
|
||||
| | `x1_2`, `y1_2` (-1 to 1 range) |
|
||||
| Right Stick | `x2`, `y2` (0 to 1 range) |
|
||||
| | `x2_2`, `y2_2` (-1 to 1 range) |
|
||||
|
||||
## Using Gamepad Inputs
|
||||
|
||||
Once initialized, you can use various gamepad inputs in your patterns. Here are some examples:
|
||||
|
||||
### Button Inputs
|
||||
|
||||
You can use button inputs to control different aspects of your music, such as gain or triggering events.
|
||||
|
||||
<MiniRepl
|
||||
client:idle
|
||||
tune={`const pad = gamepad(0)
|
||||
// Use button values to control amplitude
|
||||
$: sequence([
|
||||
s("bd").gain(pad.X), // X button controls gain
|
||||
s("[hh oh]").gain(pad.tglY), // Y button toggles gain
|
||||
])`}
|
||||
/>
|
||||
|
||||
### Analog Stick Inputs
|
||||
|
||||
Analog sticks can be used for continuous control, such as pitch shifting or panning.
|
||||
|
||||
<MiniRepl
|
||||
client:idle
|
||||
tune={`const pad = gamepad(0)
|
||||
// Use analog stick for continuous control
|
||||
$: note("c4*4".add(pad.y1_2.range(-24,24))) // Left stick Y controls pitch shift
|
||||
.pan(pad.x1_2) // Left stick X controls panning`}
|
||||
/>
|
||||
|
||||
### Button Sequences
|
||||
|
||||
You can define button sequences to trigger specific actions, like playing a sound when a sequence is detected.
|
||||
|
||||
<MiniRepl client:idle tune={`const pad = gamepad(0)
|
||||
// Define button sequences
|
||||
const HADOKEN = [
|
||||
'd', // Down
|
||||
'r', // Right
|
||||
'a', // A
|
||||
]
|
||||
|
||||
const KONAMI = 'uuddlrlrba' //Konami Code ↑↑↓↓←→←→BA
|
||||
|
||||
// Check button sequence (returns 1 when detected, 0 when not within last 1 second)
|
||||
$: sound("hadoken").gain(pad.checkSequence(HADOKEN))`} />
|
||||
|
||||
## Multiple Gamepads
|
||||
|
||||
Strudel supports multiple gamepads. You can specify the gamepad index to connect to different devices.
|
||||
|
||||
<MiniRepl
|
||||
client:idle
|
||||
tune={`const pad1 = gamepad(0); // First gamepad
|
||||
const pad2 = gamepad(1); // Second gamepad`}
|
||||
/>
|
||||
24
pnpm-lock.yaml
generated
24
pnpm-lock.yaml
generated
@ -267,6 +267,16 @@ importers:
|
||||
|
||||
packages/embed: {}
|
||||
|
||||
packages/gamepad:
|
||||
dependencies:
|
||||
'@strudel/core':
|
||||
specifier: workspace:*
|
||||
version: link:../core
|
||||
devDependencies:
|
||||
vite:
|
||||
specifier: ^5.0.10
|
||||
version: 5.4.9(@types/node@22.7.6)(terser@5.36.0)
|
||||
|
||||
packages/hs2js:
|
||||
dependencies:
|
||||
web-tree-sitter:
|
||||
@ -614,6 +624,9 @@ importers:
|
||||
'@strudel/draw':
|
||||
specifier: workspace:*
|
||||
version: link:../packages/draw
|
||||
'@strudel/gamepad':
|
||||
specifier: workspace:*
|
||||
version: link:../packages/gamepad
|
||||
'@strudel/hydra':
|
||||
specifier: workspace:*
|
||||
version: link:../packages/hydra
|
||||
@ -6840,10 +6853,6 @@ packages:
|
||||
resolution: {integrity: sha512-psgxdGMwl5MZM9S3FWee4EgsEaIjahYV5AzGnwUvPhWeITz/j6rKpysQHlQ4USdxvINlb8lKfWGIXwfkrgtqkA==}
|
||||
engines: {node: '>= 10'}
|
||||
|
||||
source-map-js@1.0.2:
|
||||
resolution: {integrity: sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==}
|
||||
engines: {node: '>=0.10.0'}
|
||||
|
||||
source-map-js@1.2.1:
|
||||
resolution: {integrity: sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==}
|
||||
engines: {node: '>=0.10.0'}
|
||||
@ -7740,6 +7749,7 @@ packages:
|
||||
|
||||
workbox-google-analytics@7.0.0:
|
||||
resolution: {integrity: sha512-MEYM1JTn/qiC3DbpvP2BVhyIH+dV/5BjHk756u9VbwuAhu0QHyKscTnisQuz21lfRpOwiS9z4XdqeVAKol0bzg==}
|
||||
deprecated: It is not compatible with newer versions of GA starting with v4, as long as you are using GAv3 it should be ok, but the package is not longer being maintained
|
||||
|
||||
workbox-navigation-preload@7.0.0:
|
||||
resolution: {integrity: sha512-juWCSrxo/fiMz3RsvDspeSLGmbgC0U9tKqcUPZBCf35s64wlaLXyn2KdHHXVQrb2cqF7I0Hc9siQalainmnXJA==}
|
||||
@ -14901,8 +14911,8 @@ snapshots:
|
||||
postcss@8.4.32:
|
||||
dependencies:
|
||||
nanoid: 3.3.7
|
||||
picocolors: 1.0.0
|
||||
source-map-js: 1.0.2
|
||||
picocolors: 1.1.1
|
||||
source-map-js: 1.2.1
|
||||
|
||||
postcss@8.4.47:
|
||||
dependencies:
|
||||
@ -15732,8 +15742,6 @@ snapshots:
|
||||
|
||||
source-map-generator@0.8.0: {}
|
||||
|
||||
source-map-js@1.0.2: {}
|
||||
|
||||
source-map-js@1.2.1: {}
|
||||
|
||||
source-map-support@0.5.21:
|
||||
|
||||
@ -84,6 +84,7 @@ export const SIDEBAR: Sidebar = {
|
||||
{ text: 'Music metadata', link: 'learn/metadata' },
|
||||
{ text: 'CSound', link: 'learn/csound' },
|
||||
{ text: 'Hydra', link: 'learn/hydra' },
|
||||
{ text: 'Input Devices', link: 'learn/input-devices' },
|
||||
],
|
||||
'Pattern Functions': [
|
||||
{ text: 'Introduction', link: 'functions/intro' },
|
||||
|
||||
15
website/src/pages/learn/input-devices.mdx
Normal file
15
website/src/pages/learn/input-devices.mdx
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Input Devices
|
||||
layout: ../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
import { MiniRepl } from '../../docs/MiniRepl';
|
||||
import { JsDoc } from '../../docs/JsDoc';
|
||||
|
||||
import Gamepad from '../../../../packages/gamepad/docs/gamepad.mdx';
|
||||
|
||||
# Input Devices
|
||||
|
||||
Strudel supports various input devices to enhance your live coding experience and create interactive musical performances. You can use gamepads, mobile device sensors, MIDI controllers, and other input devices to control and modulate your patterns in real-time. This section covers how to integrate different input devices with Strudel and use their signals to create dynamic musical expressions.
|
||||
|
||||
<Gamepad />
|
||||
Loading…
x
Reference in New Issue
Block a user