jamtools · mickmister · Mar 29, 2025 · Mar 29, 2025 · Mar 29, 2025
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+Jam Tools Docs
diff --git a/assets/images/deployment-diagram-multiplayer.png b/assets/images/deployment-diagram-multiplayer.png
diff --git a/assets/images/deployment-diagram-singleplayer.png b/assets/images/deployment-diagram-singleplayer.png
diff --git a/assets/scss/common/_custom.scss b/assets/scss/common/_custom.scss
@@ -1 +1,75 @@
 // Put your custom SCSS code here
+
+svg[data-bs-theme-value="dark"], svg[data-bs-theme-value="light"] {
+  display: none !important;
+}
+
+#offcanvasNavMainLabel {
+  display: none !important;
+}
+
+.marquee {
+  --gap: .5rem;
+  display: flex;
+  overflow: hidden;
+  user-select: none;
+  gap: var(--gap);
+  padding-block: var(--space-m);
+  margin-block-start: var(--space-2xl)
+}
+
+@media(prefers-reduced-motion:reduce) {
+  .marquee-content {
+    animation-play-state: paused
+  }
+}
+
+@media (min-width: 768px) {
+  .marquee:hover .marquee-content {
+    animation-play-state: paused
+  }
+}
+
+.marquee-item {
+  display: flex;
+  align-items: center
+}
+
+.marquee-text {
+  margin-inline-start: 1rem;
+  text-wrap: nowrap
+}
+
+.marquee-content {
+  flex-shrink: 0;
+  display: flex;
+  justify-content: space-around;
+  min-width: 100%;
+  gap: 3rem;
+
+  // transform: translateX(-50%);
+  // padding-left: 15vw;
+  animation: scroll 25s linear infinite;
+}
+
+@media(prefers-reduced-motion:no-preference) {
+  .marquee-content {
+    animation-name: scroll;
+    animation-duration: 2 5s;
+    animation-timing-function: linear;
+    animation-iteration-count: infinite;
+    animation-play-state: running;
+    will-change: transform
+  }
+}
+
+@keyframes scroll {
+  0% {
+    transform: translateX(0)
+  }
+
+  100% {
+    transform: translateX(calc(-100% - var(--gap)))
+    // transform: translateX(calc(-100% - 15vw - var(--gap)))
+  }
+}
diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml
@@ -1,4 +1,4 @@
-title = "My Docs"
+title = "Jam Tools"
 baseurl = "http://localhost/"
 canonifyURLs = false
 disableAliases = true

diff --git a/config/_default/languages.toml b/config/_default/languages.toml
@@ -5,7 +5,7 @@
   [en.params]
     languageISO = "EN"
     languageTag = "en-US"
-    footer = 'Brought to you by <a class="text-muted" href="https://thulite.io/">Thulite</a>'
+    footer = ''
     alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'
 
 [de]

diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml
@@ -54,7 +54,7 @@
 [[social]]
   name = "GitHub"
   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
-  url = "https://github.com/thuliteio/doks"
+  url = "https://github.com/jamtools/jamtools"
   post = "v0.1.0"
   weight = 30
 
@@ -73,10 +73,10 @@
 #   pageRef = "/docs/resources"
 #   weight = 30
 
-[[footer]]
-  name = "Privacy Policy"
-  url = "/privacy/"
-  weight = 10
+# [[footer]]
+#   name = "Privacy Policy"
+#   url = "/privacy/"
+#   weight = 10
 
 # [[footer]]
 #   name = "Terms of Service"

diff --git a/config/_default/menus/menus.nl.toml b/config/_default/menus/menus.nl.toml
@@ -23,15 +23,15 @@
 [[social]]
   name = "GitHub"
   pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>"
-  url = "https://github.com/h-enk/doks"
+  url = "https://github.com/jamtools/jamtools"
   post = "v0.1.0"
   weight = 10
 
-[[social]]
-  name = "X"
-  pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
-  url = "https://twitter.com/getdoks"
-  weight = 20
+# [[social]]
+#   name = "X"
+#   pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
+#   url = "https://twitter.com/getdoks"
+#   weight = 20
 
 # [[footer]]
 #   name = "Privacy"

diff --git a/config/_default/params.toml b/config/_default/params.toml
@@ -1,5 +1,5 @@
 # Hugo
-title = "My Docs"
+title = "Jam Tools"
 description = "Congrats on setting up a new Doks project!"
 images = ["cover.png"]
 
@@ -74,7 +74,7 @@ mainSections = ["docs"]
   editPage = false # false (default) or true
   lastMod = false # false (default) or true
   repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer
-  docsRepo = "https://github.com/h-enk/doks"
+  docsRepo = "https://github.com/jamtools/jamtools"
   docsRepoBranch = "main" # main (default), master, or <branch name>
   docsRepoSubPath = "" # "" (none, default) or <sub path>
 

diff --git a/content/_index.md b/content/_index.md
@@ -1,12 +1,12 @@
 ---
-title: "Welcome to Doks"
+title: "Jam Tools"
 description: ""
-lead: "Congrats on setting up a new Doks project!"
+lead: "A streamlined framework to create real-time multiplayer applications, with first-class support for MIDI and IO devices."
 date: 2023-09-07T16:33:54+02:00
 lastmod: 2023-09-07T16:33:54+02:00
 draft: false
 seo:
-  title: "Welcome to Doks" # custom title (optional)
+  title: "Jam Tools" # custom title (optional)
   description: "" # custom description (recommended)
   canonical: "" # custom canonical URL (optional)
   robots: "" # custom robot tags (optional)

diff --git a/content/docs/build-process-and-platform-entrypoints.md b/content/docs/build-process-and-platform-entrypoints.md
diff --git a/content/docs/changelog.md b/content/docs/changelog.md
diff --git a/content/docs/code-examples/_index.md b/content/docs/code-examples/_index.md
@@ -0,0 +1,17 @@
+---
+title: "Code Examples"
+description: ""
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 1000
+toc: true
+sidebar:
+  collapsed: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
diff --git a/content/docs/code-examples/examples-games/_index.md b/content/docs/code-examples/examples-games/_index.md
@@ -0,0 +1,17 @@
+---
+title: "Games"
+description: ""
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 1100
+toc: true
+sidebar:
+  collapsed: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
diff --git a/content/docs/guides/example.md → ...cs/code-examples/examples-games/euchre.md b/content/docs/guides/example.md → ...cs/code-examples/examples-games/euchre.md
@@ -1,21 +1,21 @@
----
-title: "Example Guide"
-description: "Guides lead a user through a specific task they want to accomplish, often with a sequence of steps."
-summary: ""
-date: 2023-09-07T16:04:48+02:00
-lastmod: 2023-09-07T16:04:48+02:00
-draft: false
-weight: 810
-toc: true
-seo:
-  title: "" # custom title (optional)
-  description: "" # custom description (recommended)
-  canonical: "" # custom canonical URL (optional)
-  robots: "" # custom robot tags (optional)
----
-
-Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.
-
-## Further reading
-
-- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
+---
+title: "Euchre"
+description: "A simple MIDI arpeggiator"
+summary: ""
+date: 2023-09-07T16:04:48+02:00
+lastmod: 2023-09-07T16:04:48+02:00
+draft: false
+weight: 810
+toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
+
+Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.
+
+## Further reading
+
+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/content/docs/code-examples/examples-games/tic-tac-toe.md b/content/docs/code-examples/examples-games/tic-tac-toe.md
@@ -0,0 +1,21 @@
+---
+title: "Tic-Tac-Toe"
+description: "A simple MIDI arpeggiator"
+summary: ""
+date: 2023-09-07T16:04:48+02:00
+lastmod: 2023-09-07T16:04:48+02:00
+draft: false
+weight: 810
+toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
+
+Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.
+
+## Further reading
+
+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/content/docs/code-examples/examples-music/_index.md b/content/docs/code-examples/examples-music/_index.md
@@ -0,0 +1,17 @@
+---
+title: "Music"
+description: ""
+summary: ""
+date: 2023-09-07T16:06:50+02:00
+lastmod: 2023-09-07T16:06:50+02:00
+draft: false
+weight: 1000
+toc: true
+sidebar:
+  collapsed: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
diff --git a/content/docs/code-examples/examples-music/control-daw-from-phone.md b/content/docs/code-examples/examples-music/control-daw-from-phone.md
@@ -0,0 +1,29 @@
+---
+title: "DAW Control from Phone"
+description: "A simple MIDI arpeggiator"
+summary: ""
+date: 2023-09-07T16:04:48+02:00
+lastmod: 2023-09-07T16:04:48+02:00
+draft: false
+weight: 810
+toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
+
+Basic recording, and arming tracks using midi
+
+and messing around with effects
+
+and some additional stuff about robotjs
+
+have a youtube video demoing each of these examples. or maybe on youtube video with the timestamp seeked. or something like that
+
+
+
+## Further reading
+
+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/content/docs/code-examples/examples-music/gutar-hero-guitar.md b/content/docs/code-examples/examples-music/gutar-hero-guitar.md
diff --git a/content/docs/code-examples/examples-music/midi-arpeggiator.md b/content/docs/code-examples/examples-music/midi-arpeggiator.md
@@ -0,0 +1,21 @@
+---
+title: "MIDI Arpeggiator"
+description: "A simple MIDI arpeggiator"
+summary: ""
+date: 2023-09-07T16:04:48+02:00
+lastmod: 2023-09-07T16:04:48+02:00
+draft: false
+weight: 810
+toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
+
+Go from simple to advanced MIDI arpeggiators
+
+## Further reading
+
+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
diff --git a/content/docs/introduction/_index.md b/content/docs/introduction/_index.md
@@ -0,0 +1,17 @@
+---
+title: "Introduction"
+description: ""
+summary: ""
+date: 2023-09-07T16:12:37+02:00
+lastmod: 2023-09-07T16:12:37+02:00
+draft: false
+weight: 1
+toc: true
+sidebar:
+  collapsed: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
diff --git a/content/docs/introduction/overview.md b/content/docs/introduction/overview.md
@@ -0,0 +1,24 @@
+---
+title: "Overview"
+description: "Reference pages are ideal for outlining how things work in terse and clear terms."
+summary: ""
+date: 2023-09-07T16:13:18+02:00
+lastmod: 2023-09-07T16:13:18+02:00
+draft: false
+weight: 10
+toc: true
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  robots: "" # custom robot tags (optional)
+---
+
+Check out [Get Started]() and [Code Examples]() to start building your amazing application!
+
+---
+
+The framework behind Jam Tools applications consists of the following components:
+
+- [Springboard](../../springboard/overview) - Full stack React framework that supports compilation into multiple server and client platforms, provided by the [`springboard`](https://npmjs.com/package/springboard) package.
+- [Jam Tools](./jamtools/overview) - The functionality on top of Springboard related to interacting with MIDI and IO devices, provided by the [`@jamtools/core`](https://npmjs.com/package/@jamtools/core) package.