@devaloop/devalang 0.0.1-alpha.16-hotfix.3 → 0.0.1-alpha.18

package/templates/minimal/README.md

@@ -9,12 +9,15 @@
 ![Project Status](https://img.shields.io/badge/status-alpha-red)
 ![Version](https://img.shields.io/npm/v/@devaloop/devalang)
 ![License: MIT](https://img.shields.io/badge/license-MIT-green)
-![Platform](https://img.shields.io/badge/platform-Windows-blue)
+
+![Linux](https://img.shields.io/badge/linux-supported-blue?logo=linux)
+![macOS](https://img.shields.io/badge/macOS-supported-blue?logo=apple)
+![Windows](https://img.shields.io/badge/windows-supported-blue?logo=windows)
 
 ![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
 ![crates](https://img.shields.io/crates/d/devalang)
 
-[![VSCode Extension](https://img.shields.io/visual-studio-marketplace/v/devaloop.devalang-vscode?label=VSCode%20Extension)](https://marketplace.visualstudio.com/items?itemName=devaloop.devalang-vscode)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/devaloop-labs/devalang/.github/workflows/ci.yml)
 
 # 🦊 Devalang (CORE) — Compose music with code
 
@@ -25,12 +28,13 @@ Whether you're building a track, shaping textures, or performing live, Devalang
 
 From studio sketches to live sets, Devalang gives you rhythmic control — with the elegance of code.
 
-> 🚧 Alpha Notice 🚧
+> **🚧 Notice 🚧**
+>
+> Includes synthesis, playback, and rendering features, but is still in early development, and breaking changes may occur.
 >
-> Includes synthesis, playback, and rendering features, but is still in early development.
+> **NEW**: [Devaforge is now available for creating addons](https://github.com/devaloop-labs/devaforge).
 >
-> Currently, Devalang CLI is only available for **Windows**.
-> Linux and macOS binaries will be added in future releases via cross-platform builds.
+> **NEW**: Now available for Windows, Linux, and macOS.
 
 ## 📚 Quick Access
 
@@ -41,81 +45,113 @@ From studio sketches to live sets, Devalang gives you rhythmic control — with
 - [📜 Changelog](./docs/CHANGELOG.md)
 - [💡 Examples](./examples/)
 - [🌐 Project Website](https://devalang.com)
-- [📦 Devalang CLI on npm](https://www.npmjs.com/package/@devaloop/devalang)
+- [📦 Devaforge on npm](https://www.npmjs.com/package/@devaloop/devaforge)
+- [📦 Devalang on npm](https://www.npmjs.com/package/@devaloop/devalang)
 
 ## ⏱️ Try it now !
 
 ### Try Devalang in your browser
 
-> Have a look at the [Playground](https://playground.devalang.com) to try Devalang directly in your browser
+> [Have a look at the Playground to try Devalang directly in your browser](https://playground.devalang.com)
 
-### Try Devalang CLI
+### Try Devalang in your terminal
+
+#### With Node.js
 
 ```bash
-# Install Devalang CLI globally
-npm install -g @devaloop/devalang
+npm install -g @devaloop/devalang@latest
+```
 
-# Create a new Devalang project
+#### With Rust
+
+```bash
+cargo install devalang
+```
+
+#### Initialize a new project (current directory)
+
+```bash
 devalang init --name my-project --template minimal
-cd my-project
 ```
 
+#### Write your first script
+
 Create a new Devalang file `src/index.deva` in the project directory:
 
 ```deva
 # src/index.deva
 
-group main:
-    let lead = synth sine {
+# BPM definition
+bpm 125
+
+# Bank picking (make sure you installed it)
+bank devaloop.808 as my808Bank
+
+group myGroup:
+    # Rhythmic (each beat playing a kick)
+    on beat:
+        .my808Bank.kick 1/4
+
+    # Synth definition with ADSR
+    let myLead = synth sine {
         attack: 0,
         decay: 100,
         sustain: 100,
         release: 100
     }
 
-    # Global automation for this synth (applies to subsequent notes)
-    automate lead:
+    # Global automation
+    automate myLead:
         param volume {
             0% = 0.0
-            100% = 1.0
-        }
-        param pan {
-            0% = -1.0
-            100% = 1.0
+            100% = 0.5
         }
         param pitch {
             0% = -12.0
             100% = 12.0
         }
 
-    lead -> note(C4, {
+    # Notes in a loop with condition
+    for i in [1, 2, 3]:
+        if i == 3:
+            myLead -> note(C5, { duration: 200 })
+            print "Playing note C5 for " + i
+
+    # Pause runtime for 500ms
+    sleep 500
+
+    # Note with automation
+    myLead -> note(C4, {
         duration: 400,
         velocity: 0.8,
-        automate: { pan: { 0%: -1.0, 100%: 0.0 } }
+        automate: {
+            pan: {
+                0%: -1.0,
+                100%: 0.0
+            }
+        }
     })
 
-    lead -> note(E4, { duration: 400 })
-    lead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
-    lead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
+    # Notes with params
+    myLead -> note(E4, { duration: 400 })
+    myLead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
+    myLead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
 
-    for i in [1, 2, 3]:
-        lead -> note(C5, { duration: 200 })
-
-# Play the lead
-
-call main
+# Calling the group to play it
+call myGroup
 ```
 
 ### And the best part ? You can play it directly from the command line:
 
+#### Play the script once
+
 ```bash
-# Play the Devalang file
 devalang play
+```
 
-# Play the Devalang file with watch mode
-devalang play --watch
+#### **LIVE mode** (repeat the playback + watch mode)
 
-# LIVE mode (repeat the playback + watch mode)
+```bash
 devalang play --repeat
 ```
 
@@ -125,40 +161,48 @@ devalang play --repeat
 
 ## ❓ Why Devalang ?
 
-- 🎹 Prototype audio ideas without opening a DAW, even VSCode
+- 🎹 Prototype audio ideas without opening a DAW, even VSCode with our Playground
 - 💻 Integrate sound into code-based workflows
 - 🎛️ Control audio parameters through readable syntax
 - 🧪 Build musical logic with variables and conditions
 - 🔄 Create complex patterns with ease
+- 🎚️ Automate everything
 
 ## 🚀 Features
 
-- 🎵 **Audio Engine**: Integrated audio playback and rendering
-- 🧩 **Module system** for importing and exporting variables between files
-- 📦 **Addon manager** for managing external banks, plugins and more
-- 📜 **Structured AST** generation for debugging and future compilation
-- 🔢 **Basic data types**: strings, numbers, booleans, maps, arrays
-- 👁️ **Watch mode** for `build`, `check` and `play` commands
-- 📂 **Project templates** for quick setup
-- 🎛️ **Custom samples**: easily load and trigger your own audio files
-- 🔄 **Looping and grouping**: create complex patterns with ease
+- ⚡ **Fast Build & Hot Reload** — optimized build process for quicker iteration.
+- 🎵 **Audio Engine & Real-time runner** — low-latency playback, render-to-file, and a realtime runner used by `devalang play` for live feedback.
+- ▶️ **Live mode (watch + repeat)** — edit and hear changes instantly with `devalang play --repeat` and watch mode.
+- 🧩 **Language primitives** — synths, notes, ADSR, maps, arrays, loops, conditionals and functions for expressive musical logic.
+- 🎛️ **Per-note automation & modulators** — `automate` maps, `$mod.*`, `$easing.*` and `$math.*` helpers for envelopes and LFOs.
+- 🧩 **Module system & structured AST** — import/export variables, stable AST output for debugging and tooling.
+- 🧰 **Plugins & Addons (WASM-ready)** — install plugins/banks, `@use` directive, and WASM plugin integration so plugins can render or process audio at runtime.
+- 📦 **Addon manager & Devaforge** — CLI commands to discover/install banks, plugins and templates; `devaforge` helps create addons.
+- ⚙️ **CLI tooling** — `build`, `check`, `play`, `install`, `init`, `discover`, `telemetry` and more with consistent flags (`--watch`, `--debug`, `--compress`).
+- 📂 **Project templates & examples** — quick-start templates and many example projects in `examples/`.
+- 🧑‍💻 **TypeScript API & WASM distribution** — Node-friendly package with TypeScript bindings and a WASM build for browser/Node usage.
+- 🧰 **Editor & formatting support** — VSCode extension and Prettier plugin to edit Devalang with syntax and formatting support.
+- 🎵 **Custom samples & banks** — drop samples into `.deva` and reference them from code; banks of sounds for fast composition.
+- 🔄 **Looping, grouping & scheduling** — precise beat-tied scheduling primitives for complex rhythmic patterns.
 
 ## 📄 Documentation
 
-### Please refer to the [online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
+### [Please refer to the online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
 
-## 🧯 Known issues
+## 📰 What's new
 
-- No smart modules yet, all groups, variables, and samples must be explicitly imported where used
-- No support yet for cross-platform builds (Linux, macOS)
+- **Devaforge**: Introduced a new system for creating and managing addons, including a CLI for addon generation.
+- **Documentation updates**: Improved documentation for clarity and completeness.
+- **Discovering addons**: Introduced a new command to detect addons.
+- **Public TypeScript API**: Added a public TypeScript API for easier integration.
+- **Improved error messages**: Enhanced error messages for better debugging.
+- **Bug fixes**: Various bug fixes and stability improvements.
 
 ## 🧪 Roadmap Highlights
 
 For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
 
-- ⏳ Other statements (e.g `function`, `pattern`, ...)
-- ⏳ Cross-platform support (Linux, macOS)
-- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
+- ⏳ Smart modules
 
 ## 🛡️ License
 

package/templates/welcome/README.md

@@ -9,12 +9,15 @@
 ![Project Status](https://img.shields.io/badge/status-alpha-red)
 ![Version](https://img.shields.io/npm/v/@devaloop/devalang)
 ![License: MIT](https://img.shields.io/badge/license-MIT-green)
-![Platform](https://img.shields.io/badge/platform-Windows-blue)
+
+![Linux](https://img.shields.io/badge/linux-supported-blue?logo=linux)
+![macOS](https://img.shields.io/badge/macOS-supported-blue?logo=apple)
+![Windows](https://img.shields.io/badge/windows-supported-blue?logo=windows)
 
 ![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
 ![crates](https://img.shields.io/crates/d/devalang)
 
-[![VSCode Extension](https://img.shields.io/visual-studio-marketplace/v/devaloop.devalang-vscode?label=VSCode%20Extension)](https://marketplace.visualstudio.com/items?itemName=devaloop.devalang-vscode)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/devaloop-labs/devalang/.github/workflows/ci.yml)
 
 # 🦊 Devalang (CORE) — Compose music with code
 
@@ -25,12 +28,13 @@ Whether you're building a track, shaping textures, or performing live, Devalang
 
 From studio sketches to live sets, Devalang gives you rhythmic control — with the elegance of code.
 
-> 🚧 Alpha Notice 🚧
+> **🚧 Notice 🚧**
+>
+> Includes synthesis, playback, and rendering features, but is still in early development, and breaking changes may occur.
 >
-> Includes synthesis, playback, and rendering features, but is still in early development.
+> **NEW**: [Devaforge is now available for creating addons](https://github.com/devaloop-labs/devaforge).
 >
-> Currently, Devalang CLI is only available for **Windows**.
-> Linux and macOS binaries will be added in future releases via cross-platform builds.
+> **NEW**: Now available for Windows, Linux, and macOS.
 
 ## 📚 Quick Access
 
@@ -41,81 +45,113 @@ From studio sketches to live sets, Devalang gives you rhythmic control — with
 - [📜 Changelog](./docs/CHANGELOG.md)
 - [💡 Examples](./examples/)
 - [🌐 Project Website](https://devalang.com)
-- [📦 Devalang CLI on npm](https://www.npmjs.com/package/@devaloop/devalang)
+- [📦 Devaforge on npm](https://www.npmjs.com/package/@devaloop/devaforge)
+- [📦 Devalang on npm](https://www.npmjs.com/package/@devaloop/devalang)
 
 ## ⏱️ Try it now !
 
 ### Try Devalang in your browser
 
-> Have a look at the [Playground](https://playground.devalang.com) to try Devalang directly in your browser
+> [Have a look at the Playground to try Devalang directly in your browser](https://playground.devalang.com)
 
-### Try Devalang CLI
+### Try Devalang in your terminal
+
+#### With Node.js
 
 ```bash
-# Install Devalang CLI globally
-npm install -g @devaloop/devalang
+npm install -g @devaloop/devalang@latest
+```
 
-# Create a new Devalang project
+#### With Rust
+
+```bash
+cargo install devalang
+```
+
+#### Initialize a new project (current directory)
+
+```bash
 devalang init --name my-project --template minimal
-cd my-project
 ```
 
+#### Write your first script
+
 Create a new Devalang file `src/index.deva` in the project directory:
 
 ```deva
 # src/index.deva
 
-group main:
-    let lead = synth sine {
+# BPM definition
+bpm 125
+
+# Bank picking (make sure you installed it)
+bank devaloop.808 as my808Bank
+
+group myGroup:
+    # Rhythmic (each beat playing a kick)
+    on beat:
+        .my808Bank.kick 1/4
+
+    # Synth definition with ADSR
+    let myLead = synth sine {
         attack: 0,
         decay: 100,
         sustain: 100,
         release: 100
     }
 
-    # Global automation for this synth (applies to subsequent notes)
-    automate lead:
+    # Global automation
+    automate myLead:
         param volume {
             0% = 0.0
-            100% = 1.0
-        }
-        param pan {
-            0% = -1.0
-            100% = 1.0
+            100% = 0.5
         }
         param pitch {
             0% = -12.0
             100% = 12.0
         }
 
-    lead -> note(C4, {
+    # Notes in a loop with condition
+    for i in [1, 2, 3]:
+        if i == 3:
+            myLead -> note(C5, { duration: 200 })
+            print "Playing note C5 for " + i
+
+    # Pause runtime for 500ms
+    sleep 500
+
+    # Note with automation
+    myLead -> note(C4, {
         duration: 400,
         velocity: 0.8,
-        automate: { pan: { 0%: -1.0, 100%: 0.0 } }
+        automate: {
+            pan: {
+                0%: -1.0,
+                100%: 0.0
+            }
+        }
     })
 
-    lead -> note(E4, { duration: 400 })
-    lead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
-    lead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
+    # Notes with params
+    myLead -> note(E4, { duration: 400 })
+    myLead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
+    myLead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
 
-    for i in [1, 2, 3]:
-        lead -> note(C5, { duration: 200 })
-
-# Play the lead
-
-call main
+# Calling the group to play it
+call myGroup
 ```
 
 ### And the best part ? You can play it directly from the command line:
 
+#### Play the script once
+
 ```bash
-# Play the Devalang file
 devalang play
+```
 
-# Play the Devalang file with watch mode
-devalang play --watch
+#### **LIVE mode** (repeat the playback + watch mode)
 
-# LIVE mode (repeat the playback + watch mode)
+```bash
 devalang play --repeat
 ```
 
@@ -125,40 +161,48 @@ devalang play --repeat
 
 ## ❓ Why Devalang ?
 
-- 🎹 Prototype audio ideas without opening a DAW, even VSCode
+- 🎹 Prototype audio ideas without opening a DAW, even VSCode with our Playground
 - 💻 Integrate sound into code-based workflows
 - 🎛️ Control audio parameters through readable syntax
 - 🧪 Build musical logic with variables and conditions
 - 🔄 Create complex patterns with ease
+- 🎚️ Automate everything
 
 ## 🚀 Features
 
-- 🎵 **Audio Engine**: Integrated audio playback and rendering
-- 🧩 **Module system** for importing and exporting variables between files
-- 📦 **Addon manager** for managing external banks, plugins and more
-- 📜 **Structured AST** generation for debugging and future compilation
-- 🔢 **Basic data types**: strings, numbers, booleans, maps, arrays
-- 👁️ **Watch mode** for `build`, `check` and `play` commands
-- 📂 **Project templates** for quick setup
-- 🎛️ **Custom samples**: easily load and trigger your own audio files
-- 🔄 **Looping and grouping**: create complex patterns with ease
+- ⚡ **Fast Build & Hot Reload** — optimized build process for quicker iteration.
+- 🎵 **Audio Engine & Real-time runner** — low-latency playback, render-to-file, and a realtime runner used by `devalang play` for live feedback.
+- ▶️ **Live mode (watch + repeat)** — edit and hear changes instantly with `devalang play --repeat` and watch mode.
+- 🧩 **Language primitives** — synths, notes, ADSR, maps, arrays, loops, conditionals and functions for expressive musical logic.
+- 🎛️ **Per-note automation & modulators** — `automate` maps, `$mod.*`, `$easing.*` and `$math.*` helpers for envelopes and LFOs.
+- 🧩 **Module system & structured AST** — import/export variables, stable AST output for debugging and tooling.
+- 🧰 **Plugins & Addons (WASM-ready)** — install plugins/banks, `@use` directive, and WASM plugin integration so plugins can render or process audio at runtime.
+- 📦 **Addon manager & Devaforge** — CLI commands to discover/install banks, plugins and templates; `devaforge` helps create addons.
+- ⚙️ **CLI tooling** — `build`, `check`, `play`, `install`, `init`, `discover`, `telemetry` and more with consistent flags (`--watch`, `--debug`, `--compress`).
+- 📂 **Project templates & examples** — quick-start templates and many example projects in `examples/`.
+- 🧑‍💻 **TypeScript API & WASM distribution** — Node-friendly package with TypeScript bindings and a WASM build for browser/Node usage.
+- 🧰 **Editor & formatting support** — VSCode extension and Prettier plugin to edit Devalang with syntax and formatting support.
+- 🎵 **Custom samples & banks** — drop samples into `.deva` and reference them from code; banks of sounds for fast composition.
+- 🔄 **Looping, grouping & scheduling** — precise beat-tied scheduling primitives for complex rhythmic patterns.
 
 ## 📄 Documentation
 
-### Please refer to the [online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
+### [Please refer to the online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
 
-## 🧯 Known issues
+## 📰 What's new
 
-- No smart modules yet, all groups, variables, and samples must be explicitly imported where used
-- No support yet for cross-platform builds (Linux, macOS)
+- **Devaforge**: Introduced a new system for creating and managing addons, including a CLI for addon generation.
+- **Documentation updates**: Improved documentation for clarity and completeness.
+- **Discovering addons**: Introduced a new command to detect addons.
+- **Public TypeScript API**: Added a public TypeScript API for easier integration.
+- **Improved error messages**: Enhanced error messages for better debugging.
+- **Bug fixes**: Various bug fixes and stability improvements.
 
 ## 🧪 Roadmap Highlights
 
 For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
 
-- ⏳ Other statements (e.g `function`, `pattern`, ...)
-- ⏳ Cross-platform support (Linux, macOS)
-- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
+- ⏳ Smart modules
 
 ## 🛡️ License
 

package/templates/welcome/src/index.deva

@@ -1,13 +1,61 @@
-# 🦊 Welcome to Devalang !
-# This is your first Devalang program ?
-# Let's start with a simple example that plays a sample in a loop.
+# 🦊 Welcome to Devalang
+# Happy live-coding !
 
-@import { bpmVar, bankVar, loopVar } from './variables.deva'
-@load "../samples/kick-808.wav" as sample
+@import { bpmVar } from './variables.deva'
+@load "../samples/kick-808.wav" as myKick
 
+# BPM definition
 bpm bpmVar
 
-bank bankVar
+group myGroup:
+    # Rhythmic (each beat playing a kick)
+    on beat:
+        .myKick 1/4
 
-loop loopVar:
-    .sample auto
+    # Synth definition with ADSR
+    let myLead = synth sine {
+        attack: 0,
+        decay: 100,
+        sustain: 100,
+        release: 100
+    }
+
+    # Global automation
+    automate myLead:
+        param volume {
+            0% = 0.0
+            100% = 0.5
+        }
+        param pitch {
+            0% = -12.0
+            100% = 12.0
+        }
+
+    # Notes in a loop with condition
+    for i in [1, 2, 3]:
+        if i == 3:
+            myLead -> note(C5, { duration: 200 })
+            print "Playing note C5 for " + i
+
+    # Pause runtime for 500ms
+    sleep 500
+
+    # Note with automation
+    myLead -> note(C4, {
+        duration: 400,
+        velocity: 0.8,
+        automate: {
+            pan: {
+                0%: -1.0,
+                100%: 0.0
+            }
+        }
+    })
+
+    # Notes with params
+    myLead -> note(E4, { duration: 400 })
+    myLead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
+    myLead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
+
+# Calling the group to play it
+call myGroup

package/templates/welcome/src/variables.deva

@@ -1,5 +1,3 @@
-let bpmVar = 120
-let bankVar = 808
-let loopVar = 10
+let bpmVar = 135
 
-@export { bpmVar, bankVar, loopVar }
+@export { bpmVar }