Add copy and reset commands

alisomay · Dec 18, 2024 · 4d0fd9a · 4d0fd9a
1 parent 53aac74
commit 4d0fd9a
Show file tree

Hide file tree

Showing 19 changed files with 2,386 additions and 67 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/externals/rytm/API_DOCS.md b/externals/rytm/API_DOCS.md
@@ -31,6 +31,8 @@ Also do not forget to check the max help files and max reference for the `rytm`
   - `set` Sets data to the `rytm` external.
   - `load` Loads either full or partial project data using `.rytm` or `.sysex` files.
   - `save` Saves either full or partial project data using `.rytm` or `.sysex` files.
+  - `copy` Copies full patterns and kits in the external.
+  - `reset` Resets the external to its default state.
   - `loglevel` `rytm` also logs to stdout with different levels of verbosity using [`tracing`](https://docs.rs/tracing/latest/tracing/) this selector is used to set the log level in runtime.
 - `<object-type>` A symbol which defines the type of the object.
   - `pattern` A pattern.
@@ -117,6 +119,24 @@ Examples:
 - `save ~/Desktop/project.rytm`
 - `save settings ~/Desktop/settings.sysex`
 
+## Copy format
+
+The copy format is used to copy full patterns and kits in the external.
+
+`copy <object> <index> [<target-index>]`
+
+Depending on the type of the object `<index>` can be either a source index or a target index.
+For work buffer objects `<index>` is the target index. On the other hand for non-work buffer objects `<index>` is the source index.
+
+Examples:
+
+- `copy pattern 1 2`
+- `copy pattern 1` -> _Copies the pattern to the work buffer._
+- `copy kit 1 2`
+- `copy kit 1` -> _Copies the kit to the work buffer._
+- `copy pattern_wb 1`
+- `copy kit_wb 1`
+
 ## Get format
 
 The get format is used to get data from the `rytm` external.

diff --git a/externals/rytm/README.md b/externals/rytm/README.md
@@ -146,11 +146,16 @@ Accepted formats are:
 This is done by starting our messages with `get` selector.
 The details of the format and the output format are explained in the [api docs](API_DOCS.md).
 
-#### Setting data in the `rytm` external
+#### Setting data in `rytm` external
 
 This is done by starting our messages with `set` selector.
 The details of the format and the input format are explained in the [api docs](API_DOCS.md).
 
+#### Copying patterns and kits in `rytm` external
+
+This is done by starting our messages with `copy` selector.
+The details of the format and the input format are explained in the [api docs](API_DOCS.md).
+
 #### Parameter locking
 
 The pattern structure holds the parameter lock pool for that pattern.