diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/enable-disable-global-control.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/enable-disable-global-control.png new file mode 100644 index 000000000..500fe2a54 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/enable-disable-global-control.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/home.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/home.png new file mode 100644 index 000000000..3343d88e2 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/home.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/playtime.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/playtime.png new file mode 100644 index 000000000..87355e0da Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/playtime.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/projection.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/projection.png new file mode 100644 index 000000000..51fc9129e Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/projection.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/show-helgobox-plugin.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/show-helgobox-plugin.png new file mode 100644 index 000000000..22c436049 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/navbar/show-helgobox-plugin.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/dim.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/dim.png new file mode 100644 index 000000000..cd2911799 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/dim.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/full-screen.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/full-screen.png new file mode 100644 index 000000000..0209faaac Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/full-screen.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/helgobox-info.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/helgobox-info.png new file mode 100644 index 000000000..1bc60bfb5 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/helgobox-info.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/help.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/help.png new file mode 100644 index 000000000..7a3cfb405 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/help.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/hide-window.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/hide-window.png new file mode 100644 index 000000000..c726afe26 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/hide-window.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/move-window.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/move-window.png new file mode 100644 index 000000000..89f8b6666 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/move-window.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/panic-midi.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/panic-midi.png new file mode 100644 index 000000000..8131ddb54 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/panic-midi.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/pause-arrangement.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/pause-arrangement.png new file mode 100644 index 000000000..296de4f13 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/pause-arrangement.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/play-arrangement.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/play-arrangement.png new file mode 100644 index 000000000..aa483f41e Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/play-arrangement.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/redo.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/redo.png new file mode 100644 index 000000000..15858cd06 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/redo.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/refresh.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/refresh.png new file mode 100644 index 000000000..ba9e32c91 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/refresh.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/save-project.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/save-project.png new file mode 100644 index 000000000..96e9ed07f Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/save-project.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/settings.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/settings.png new file mode 100644 index 000000000..ec1e45ad1 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/settings.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/stop-arrangement.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/stop-arrangement.png new file mode 100644 index 000000000..22d17b65c Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/stop-arrangement.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/theme-mode.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/theme-mode.png new file mode 100644 index 000000000..dc420e1e3 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/theme-mode.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/theme-switcher.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/theme-switcher.png new file mode 100644 index 000000000..c87898460 Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/theme-switcher.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/toggle-nav-bar.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/toggle-nav-bar.png new file mode 100644 index 000000000..cfc17d8bc Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/toggle-nav-bar.png differ diff --git a/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/undo.png b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/undo.png new file mode 100644 index 000000000..0aa31b99a Binary files /dev/null and b/doc/helgobox/modules/ROOT/images/generated/screenshots/elements/title-bar/undo.png differ diff --git a/doc/helgobox/modules/ROOT/images/helgobox/screenshots/app-window.png b/doc/helgobox/modules/ROOT/images/screenshots/app-window.png similarity index 100% rename from doc/helgobox/modules/ROOT/images/helgobox/screenshots/app-window.png rename to doc/helgobox/modules/ROOT/images/screenshots/app-window.png diff --git a/doc/helgobox/modules/ROOT/images/helgobox/screenshots/plugin-window.png b/doc/helgobox/modules/ROOT/images/screenshots/plugin-window.png similarity index 100% rename from doc/helgobox/modules/ROOT/images/helgobox/screenshots/plugin-window.png rename to doc/helgobox/modules/ROOT/images/screenshots/plugin-window.png diff --git a/doc/helgobox/modules/ROOT/nav.adoc b/doc/helgobox/modules/ROOT/nav.adoc index 25b37b01e..650c367bf 100644 --- a/doc/helgobox/modules/ROOT/nav.adoc +++ b/doc/helgobox/modules/ROOT/nav.adoc @@ -1,3 +1,11 @@ * xref:introduction.adoc[] * xref:installation.adoc[] -* xref:usage.adoc[] \ No newline at end of file +* xref:usage.adoc[] +* xref:plug-in.adoc[] +** xref:plug-in/user-interface.adoc[] +* xref:app.adoc[] +** xref:app/user-interface.adoc[] +*** xref:app/user-interface/title-bar.adoc[] +*** xref:app/user-interface/navigation-bar.adoc[] +*** xref:app/user-interface/keyboard-shortcuts.adoc[] +* xref:reaper-actions.adoc[] \ No newline at end of file diff --git a/doc/helgobox/modules/ROOT/pages/app.adoc b/doc/helgobox/modules/ROOT/pages/app.adoc new file mode 100644 index 000000000..f56111c0d --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/app.adoc @@ -0,0 +1,6 @@ += Helgobox App + +At the moment, the app primarily provides the user interface for xref:playtime::introduction.adoc[Playtime], but it will contain more stuff in the future. + +.App window +image::screenshots/app-window.png[] diff --git a/doc/helgobox/modules/ROOT/pages/app/user-interface.adoc b/doc/helgobox/modules/ROOT/pages/app/user-interface.adoc new file mode 100644 index 000000000..966a2c602 --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/app/user-interface.adoc @@ -0,0 +1,6 @@ += User interface + +The Helgobox instrument plug-in's user interface primarily provides the user interface for link:https://www.helgoboss.org/projects/realearn[ReaLearn]. Refer to the xref:realearn::user-interface.adoc[] section of the ReaLearn Reference for details. + +.Plug-in window +image::screenshots/plugin-window.png[] diff --git a/doc/helgobox/modules/ROOT/pages/app/user-interface/keyboard-shortcuts.adoc b/doc/helgobox/modules/ROOT/pages/app/user-interface/keyboard-shortcuts.adoc new file mode 100644 index 000000000..e31ee4e2d --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/app/user-interface/keyboard-shortcuts.adoc @@ -0,0 +1,41 @@ += Keyboard shortcuts + +Within the app, you can use the following keyboard shortcuts. + +|=== +|Shortcut |Purpose + +|kbd:[Esc] +|Hides the app window. + +By default, you can quickly bring it back by pressing kbd:[Shift+Cmd/Ctrl+P]. + +|kbd:[F] +|Toggle full-screen mode + +|kbd:[Shift+Cmd/Ctrl+H] +|Executes the REAPER action xref:helgobox::reaper-actions.adoc#toggle-app-focus[]. + +|=== + +Depending on the currently selected page, more keyboard shortcuts are available: + +- xref:playtime::user-interface/keyboard-shortcuts.adoc[Playtime shortcuts] + +[TIP] +==== +**Normal REAPER's keyboard shortcuts are generally disabled when the app is focused!** + +This prevents conflicts and ensures flexibility for adding more app shortcuts in the future. + +If you want to use a certain REAPER shortcut while the app is focused, you must make it global: + +. Open menu:Actions[Show action list...] +. Press btn:[Find shortcut...] +. Press the shortcut key ++ +The action list should jump to the action mapped to that key. +. Double-click the desired shortcut in the "Shortcuts for selected action" list +. Change the property "Scope" to **Global** +. Press btn:[OK] +==== diff --git a/doc/helgobox/modules/ROOT/pages/app/user-interface/navigation-bar.adoc b/doc/helgobox/modules/ROOT/pages/app/user-interface/navigation-bar.adoc new file mode 100644 index 000000000..8d348316b --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/app/user-interface/navigation-bar.adoc @@ -0,0 +1,14 @@ += Navigation bar + +The bar on the left is the _Navigation bar_. +Its main purpose is to switch between different user interface pages. + +include::partial$generated/elements/navbar/home.adoc[] + +include::partial$generated/elements/navbar/projection.adoc[] + +include::partial$generated/elements/navbar/playtime.adoc[] + +include::partial$generated/elements/navbar/enable-disable-global-control.adoc[] + +include::partial$generated/elements/navbar/show-helgobox-plugin.adoc[] diff --git a/doc/helgobox/modules/ROOT/pages/app/user-interface/title-bar.adoc b/doc/helgobox/modules/ROOT/pages/app/user-interface/title-bar.adoc new file mode 100644 index 000000000..785ae12be --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/app/user-interface/title-bar.adoc @@ -0,0 +1,39 @@ += Title bar + +The bar on the top of the app window is the _Title bar_. + +include::partial$generated/elements/title-bar/hide-window.adoc[] + +include::partial$generated/elements/title-bar/full-screen.adoc[] + +include::partial$generated/elements/title-bar/move-window.adoc[] + +include::partial$generated/elements/title-bar/toggle-nav-bar.adoc[] + +include::partial$generated/elements/title-bar/theme-mode.adoc[] + +include::partial$generated/elements/title-bar/dim.adoc[] + +include::partial$generated/elements/title-bar/settings.adoc[] + +include::partial$generated/elements/title-bar/refresh.adoc[] + +include::partial$generated/elements/title-bar/undo.adoc[] + +include::partial$generated/elements/title-bar/redo.adoc[] + +include::partial$generated/elements/title-bar/theme-switcher.adoc[] + +include::partial$generated/elements/title-bar/panic-midi.adoc[] + +include::partial$generated/elements/title-bar/save-project.adoc[] + +include::partial$generated/elements/title-bar/play-arrangement.adoc[] + +include::partial$generated/elements/title-bar/stop-arrangement.adoc[] + +include::partial$generated/elements/title-bar/pause-arrangement.adoc[] + +include::partial$generated/elements/title-bar/help.adoc[] + +include::partial$generated/elements/title-bar/helgobox-info.adoc[] \ No newline at end of file diff --git a/doc/helgobox/modules/ROOT/pages/plug-in.adoc b/doc/helgobox/modules/ROOT/pages/plug-in.adoc new file mode 100644 index 000000000..a18859870 --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/plug-in.adoc @@ -0,0 +1 @@ += Helgobox Instrument Plug-In diff --git a/doc/helgobox/modules/ROOT/pages/plug-in/user-interface.adoc b/doc/helgobox/modules/ROOT/pages/plug-in/user-interface.adoc new file mode 100644 index 000000000..c91a03a1d --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/plug-in/user-interface.adoc @@ -0,0 +1 @@ += User interface \ No newline at end of file diff --git a/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc b/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc new file mode 100644 index 000000000..3ee91057a --- /dev/null +++ b/doc/helgobox/modules/ROOT/pages/reaper-actions.adoc @@ -0,0 +1,30 @@ += REAPER actions + +== General actions + +Helgobox provides a few global REAPER actions. + +You can find those actions directly in the menu menu:Extensions[Helgobox]. +Alternatively, search for "helgobox" in REAPER's action list (menu:Actions[Show action list...]). + +[TIP] +==== +On Linux, you currently need to add at least one Helgobox FX instance to make the actions available. + +This is likely going to change in the future. +For the time being, it can be useful to put a Helgobox instance on REAPER's monitoring FX chain in order to have access to those actions at all times. +==== + +Helgobox/General: Show welcome screen:: +Shows the welcome screen that was displayed after the first installation of Helgobox. + +[#toggle-app-focus] +Helgobox/General: Toggle app focus kbd:[Shift+Cmd/Ctrl+H]:: +Switches focus between REAPER and the xref:app.adoc[]. + +== Product-specific actions + +The products contained in Helgobox provide additional actions: + +- xref:realearn::reaper-actions.adoc[ReaLearn actions] +- xref:playtime::reaper-actions.adoc[Playtime actions] diff --git a/doc/helgobox/modules/ROOT/pages/usage.adoc b/doc/helgobox/modules/ROOT/pages/usage.adoc index 4d8baeea8..0b11c5dd6 100644 --- a/doc/helgobox/modules/ROOT/pages/usage.adoc +++ b/doc/helgobox/modules/ROOT/pages/usage.adoc @@ -1,4 +1,4 @@ -= Usage += Basic usage This section illustrates the basics of using Helgobox. For more information, please refer to the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference]. @@ -11,24 +11,17 @@ Helgobox is fired up just like any other VST instrument in REAPER: By adding an . Select menu:Insert virtual instrument on new track...[] . Double-click entry "VSTi: Helgobox - ReaLearn & Playtime (Helgoboss)" -Initially, you see the Helgobox instrument plug-in, which primarily provides the user interface for link:https://www.helgoboss.org/projects/realearn[ReaLearn]: +Initially, you see the xref:plug-in.adoc[]: .Plug-in window -image::helgobox/screenshots/plugin-window.png[] +image::screenshots/plugin-window.png[] == Show the Helgobox App -Helgobox also provides an App, which primarily provides the user interface for link:https://www.helgoboss.org/projects/playtime[Playtime]. -Each Helgobox instance can display its own App window, embedded into REAPER: +Each Helgobox instance can display its own xref:app.adoc[] window, embedded into REAPER: . Open the Helgobox instrument plug-in . Press menu:Menu[Show App] .App window -image::helgobox/screenshots/app-window.png[] - -As an alternative, you can use the convenient btn:[Playtime] button in REAPER's main toolbar. -If you don't see it, do this: - -. Select menu:Extensions[Helgobox > Show welcome screen] -. Check "Add Playtime button to main toolbar" +image::screenshots/app-window.png[] diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/enable-disable-global-control.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/enable-disable-global-control.adoc new file mode 100644 index 000000000..13d29cf24 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/enable-disable-global-control.adoc @@ -0,0 +1,10 @@ +[#navbar-enable-disable-global-control] +== Enable/disable global control + +image:generated/screenshots/elements/navbar/enable-disable-global-control.png[Enable/disable global control, role="related thumb right"] + +Enables or disables the usage of global controllers for this Helgobox instance. + +If enabled, all connected controllers that you have equipped will load their corresponding main preset. You can configure controllers using the settings button in the window title bar. + +If disabled, global controllers will be ignored in this instance. You still have the freedom to create a custom control experience using ReaLearn. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/home.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/home.adoc new file mode 100644 index 000000000..0e6a97fa7 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/home.adoc @@ -0,0 +1,6 @@ +[#navbar-home] +== Home + +image:generated/screenshots/elements/navbar/home.png[Home, role="related thumb right"] + +Shows the Helgobox welcome page. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/playtime.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/playtime.adoc new file mode 100644 index 000000000..f9f6308c3 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/playtime.adoc @@ -0,0 +1,6 @@ +[#navbar-playtime] +== Playtime + +image:generated/screenshots/elements/navbar/playtime.png[Playtime, role="related thumb right"] + +Shows the Playtime Clip Matrix associated with this Helgobox instance. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/projection.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/projection.adoc new file mode 100644 index 000000000..751b15e80 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/projection.adoc @@ -0,0 +1,8 @@ +[#navbar-projection] +== ReaLearn Projection + +image:generated/screenshots/elements/navbar/projection.png[ReaLearn Projection, role="related thumb right"] + +Shows the ReaLearn Projection page for this Helgobox instance. + +The main part of ReaLearn can be found in the Helgobox plug-in! The app only contains the Projection feature of ReaLearn. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/show-helgobox-plugin.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/show-helgobox-plugin.adoc new file mode 100644 index 000000000..e954d45bb --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/navbar/show-helgobox-plugin.adoc @@ -0,0 +1,6 @@ +[#navbar-show-helgobox-plugin] +== Show Helgobox plug-in + +image:generated/screenshots/elements/navbar/show-helgobox-plugin.png[Show Helgobox plug-in, role="related thumb right"] + +Opens the Helgobox plug-in which is controlled by this app. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/dim.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/dim.adoc new file mode 100644 index 000000000..45d935e81 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/dim.adoc @@ -0,0 +1,6 @@ +[#title-bar-dim] +== Dim + +image:generated/screenshots/elements/title-bar/dim.png[Dim, role="related thumb right"] + +Toggles between a transparent and opaque window. Useful for quickly having a look what REAPER is doing under the hood ;) diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/full-screen.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/full-screen.adoc new file mode 100644 index 000000000..aeaca17a9 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/full-screen.adoc @@ -0,0 +1,6 @@ +[#title-bar-full-screen] +== Full screen + +image:generated/screenshots/elements/title-bar/full-screen.png[Full screen, role="related thumb right"] + +Toggles between full-screen and windowed mode. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/helgobox-info.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/helgobox-info.adoc new file mode 100644 index 000000000..0a32476bd --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/helgobox-info.adoc @@ -0,0 +1,6 @@ +[#title-bar-helgobox-info] +== Helgobox Info + +image:generated/screenshots/elements/title-bar/helgobox-info.png[Helgobox Info, role="related thumb right"] + +Shows the version number of this Helgobox installation as well as the ID of the Helgobox instance to which this App window is connected. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/help.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/help.adoc new file mode 100644 index 000000000..c99fc525e --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/help.adoc @@ -0,0 +1,6 @@ +[#title-bar-help] +== Help + +image:generated/screenshots/elements/title-bar/help.png[Help, role="related thumb right"] + +Shows a help menu diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/hide-window.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/hide-window.adoc new file mode 100644 index 000000000..9dd32e87b --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/hide-window.adoc @@ -0,0 +1,8 @@ +[#title-bar-hide-window] +== Hide window + +image:generated/screenshots/elements/title-bar/hide-window.png[Hide window, role="related thumb right"] + +Hides the app window. + +You can show it again by pressing Shift+Cmd+P (customizable in REAPER action window, see action "Show/hide Playtime") or the Playtime button in the REAPER toolbar. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/move-window.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/move-window.adoc new file mode 100644 index 000000000..697bee79f --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/move-window.adoc @@ -0,0 +1,6 @@ +[#title-bar-move-window] +== Move window + +image:generated/screenshots/elements/title-bar/move-window.png[Move window, role="related thumb right"] + +Drag this button to move the window. Useful when the window is very narrow, in which case the main drag area in the center will disappear. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/panic-midi.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/panic-midi.adoc new file mode 100644 index 000000000..d099ebe24 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/panic-midi.adoc @@ -0,0 +1,6 @@ +[#title-bar-panic-midi] +== Panic + +image:generated/screenshots/elements/title-bar/panic-midi.png[Panic, role="related thumb right"] + +Attempts to stop any playing or even hanging MIDI notes. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/pause-arrangement.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/pause-arrangement.adoc new file mode 100644 index 000000000..f5ed7b933 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/pause-arrangement.adoc @@ -0,0 +1,6 @@ +[#title-bar-pause-arrangement] +== Pause arrangement + +image:generated/screenshots/elements/title-bar/pause-arrangement.png[Pause arrangement, role="related thumb right"] + +Pauses the REAPER arrangement diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/play-arrangement.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/play-arrangement.adoc new file mode 100644 index 000000000..733c84db0 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/play-arrangement.adoc @@ -0,0 +1,6 @@ +[#title-bar-play-arrangement] +== Play arrangement + +image:generated/screenshots/elements/title-bar/play-arrangement.png[Play arrangement, role="related thumb right"] + +Starts playing the REAPER arrangement diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/redo.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/redo.adoc new file mode 100644 index 000000000..cfefdbb8f --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/redo.adoc @@ -0,0 +1,6 @@ +[#title-bar-redo] +== Redo + +image:generated/screenshots/elements/title-bar/redo.png[Redo, role="related thumb right"] + + diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/refresh.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/refresh.adoc new file mode 100644 index 000000000..f1e7748ed --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/refresh.adoc @@ -0,0 +1,8 @@ +[#title-bar-refresh] +== Refresh + +image:generated/screenshots/elements/title-bar/refresh.png[Refresh, role="related thumb right"] + +Refreshes the displayed information. + +Pressing this button shouldn't be necessary in normal operation, but there might be bugs that prevent Helgobox from displaying the latest information automatically. In this case, this button can help. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/save-project.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/save-project.adoc new file mode 100644 index 000000000..83c574ae0 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/save-project.adoc @@ -0,0 +1,6 @@ +[#title-bar-save-project] +== Save project + +image:generated/screenshots/elements/title-bar/save-project.png[Save project, role="related thumb right"] + +Saves the REAPER project diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/settings.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/settings.adoc new file mode 100644 index 000000000..62829e173 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/settings.adoc @@ -0,0 +1,6 @@ +[#title-bar-settings] +== User interface settings + +image:generated/screenshots/elements/title-bar/settings.png[User interface settings, role="related thumb right"] + +Lets you adjust various settings related to the user interface. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/stop-arrangement.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/stop-arrangement.adoc new file mode 100644 index 000000000..f80742340 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/stop-arrangement.adoc @@ -0,0 +1,6 @@ +[#title-bar-stop-arrangement] +== Stop arrangement + +image:generated/screenshots/elements/title-bar/stop-arrangement.png[Stop arrangement, role="related thumb right"] + +Stops the REAPER arrangement diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/theme-mode.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/theme-mode.adoc new file mode 100644 index 000000000..fa40348e3 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/theme-mode.adoc @@ -0,0 +1,6 @@ +[#title-bar-theme-mode] +== Theme mode + +image:generated/screenshots/elements/title-bar/theme-mode.png[Theme mode, role="related thumb right"] + +Switches between dark, light and automatic theme mode. In automatic theme mode, the app will adopt your system settings. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/theme-switcher.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/theme-switcher.adoc new file mode 100644 index 000000000..9087f67de --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/theme-switcher.adoc @@ -0,0 +1,6 @@ +[#title-bar-theme-switcher] +== Quick theme switcher + +image:generated/screenshots/elements/title-bar/theme-switcher.png[Quick theme switcher, role="related thumb right"] + +This switches through a few hand-picked combinations of theme-related user interface settings. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/toggle-nav-bar.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/toggle-nav-bar.adoc new file mode 100644 index 000000000..f68232e37 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/toggle-nav-bar.adoc @@ -0,0 +1,6 @@ +[#title-bar-toggle-nav-bar] +== Toggle navigation bar + +image:generated/screenshots/elements/title-bar/toggle-nav-bar.png[Toggle navigation bar, role="related thumb right"] + +Shows/hides the navigation bar on the left. diff --git a/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/undo.adoc b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/undo.adoc new file mode 100644 index 000000000..ba41a48c8 --- /dev/null +++ b/doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/undo.adoc @@ -0,0 +1,6 @@ +[#title-bar-undo] +== Undo + +image:generated/screenshots/elements/title-bar/undo.png[Undo, role="related thumb right"] + + diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell.png new file mode 100644 index 000000000..a55b524b4 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/exclusive-mode.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/exclusive-mode.png new file mode 100644 index 000000000..ab8d99dde Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/exclusive-mode.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/follow-scenes.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/follow-scenes.png new file mode 100644 index 000000000..aaa6d021c Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/follow-scenes.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/has-overrides.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/has-overrides.png new file mode 100644 index 000000000..f4bf664d6 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/has-overrides.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/label.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/label.png new file mode 100644 index 000000000..46aa466ee Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/label.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/stop.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/stop.png new file mode 100644 index 000000000..16b598f38 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell/stop.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffer-fallback-count.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffer-fallback-count.png new file mode 100644 index 000000000..3132064be Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffer-fallback-count.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffer-miss-count.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffer-miss-count.png new file mode 100644 index 000000000..6d99cab3d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffer-miss-count.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-avg.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-avg.png new file mode 100644 index 000000000..a10bc9cfc Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-avg.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-max.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-max.png new file mode 100644 index 000000000..99794c226 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-max.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-min.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-min.png new file mode 100644 index 000000000..a044a867b Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-min.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/tempo-buffer-size.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/tempo-buffer-size.png new file mode 100644 index 000000000..c4c67ef3f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/info-panel/stats/tempo-buffer-size.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell.png new file mode 100644 index 000000000..86e6f6659 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/settings.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/settings.png new file mode 100644 index 000000000..e65b23aa9 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/settings.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/stop.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/stop.png new file mode 100644 index 000000000..8622b8534 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/stop.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/add-column.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/add-column.png new file mode 100644 index 000000000..0443122ac Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/add-column.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/add-row.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/add-row.png new file mode 100644 index 000000000..329f7964e Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/add-row.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/scroll-indicator.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/scroll-indicator.png new file mode 100644 index 000000000..307169758 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix/scroll-indicator.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell.png new file mode 100644 index 000000000..ced92a6ea Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/label.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/label.png new file mode 100644 index 000000000..8d31aa3a3 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/label.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/play-scene.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/play-scene.png new file mode 100644 index 000000000..3fd87b2d9 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/play-scene.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell.png new file mode 100644 index 000000000..25059e38d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/clip-count.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/clip-count.png new file mode 100644 index 000000000..5602aed34 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/clip-count.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/content.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/content.png new file mode 100644 index 000000000..79fe1e43f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/content.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/record.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/record.png new file mode 100644 index 000000000..ca465ae34 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/record.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/trigger.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/trigger.png new file mode 100644 index 000000000..f17192ce0 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/slot-cell/trigger.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-color.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-color.png new file mode 100644 index 000000000..1fff73276 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-color.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-expert-settings.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-expert-settings.png new file mode 100644 index 000000000..344e7e15f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-expert-settings.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-length.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-length.png new file mode 100644 index 000000000..ad242ac1a Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-length.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-looped.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-looped.png new file mode 100644 index 000000000..8f4d19930 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-looped.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-midi-channel-original.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-midi-channel-original.png new file mode 100644 index 000000000..b9d67f4ce Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-midi-channel-original.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-midi-channel.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-midi-channel.png new file mode 100644 index 000000000..713532647 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-midi-channel.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-name.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-name.png new file mode 100644 index 000000000..f4fefb45b Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-name.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-pitch.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-pitch.png new file mode 100644 index 000000000..c39597c62 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-pitch.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-reset-behavior.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-reset-behavior.png new file mode 100644 index 000000000..6107311be Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-reset-behavior.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-section.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-section.png new file mode 100644 index 000000000..ee1c78e8f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-section.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-source-cut-start.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-source-cut-start.png new file mode 100644 index 000000000..446e0bd1d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-source-cut-start.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-source-info.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-source-info.png new file mode 100644 index 000000000..1e239fbdd Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-source-info.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-start-position.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-start-position.png new file mode 100644 index 000000000..db8283452 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-start-position.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-start-timing.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-start-timing.png new file mode 100644 index 000000000..6c7d1be0d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-start-timing.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-stop-timing.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-stop-timing.png new file mode 100644 index 000000000..e25688ec8 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-stop-timing.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-sync-to-project-tempo.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-sync-to-project-tempo.png new file mode 100644 index 000000000..2ba70a778 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-sync-to-project-tempo.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-velocity-sensitivity.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-velocity-sensitivity.png new file mode 100644 index 000000000..b015f2910 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-velocity-sensitivity.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-volume.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-volume.png new file mode 100644 index 000000000..d5b805e20 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/clip-volume.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/track-panel.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/track-panel.png new file mode 100644 index 000000000..abe05963d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/todo/track-panel.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-sequence-picker.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-sequence-picker.png new file mode 100644 index 000000000..61b820a75 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-sequence-picker.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-sequencer.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-sequencer.png new file mode 100644 index 000000000..e2956c71d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-sequencer.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-start-timing.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-start-timing.png new file mode 100644 index 000000000..18515d20d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/matrix-start-timing.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/metronome.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/metronome.png new file mode 100644 index 000000000..6e9181b09 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/metronome.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/open-ended-recording.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/open-ended-recording.png new file mode 100644 index 000000000..6a6822ed8 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/open-ended-recording.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/pane-toggler.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/pane-toggler.png new file mode 100644 index 000000000..618eb93e3 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/pane-toggler.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/play-rate.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/play-rate.png new file mode 100644 index 000000000..592be37ea Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/play-rate.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/play-stop-matrix-sequence.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/play-stop-matrix-sequence.png new file mode 100644 index 000000000..c66f2941f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/play-stop-matrix-sequence.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/record-matrix-sequence.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/record-matrix-sequence.png new file mode 100644 index 000000000..9cdcb6e28 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/record-matrix-sequence.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/show-hide-midi-triggers.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/show-hide-midi-triggers.png new file mode 100644 index 000000000..fdfe62967 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/show-hide-midi-triggers.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/smart-record.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/smart-record.png new file mode 100644 index 000000000..6bf58bca7 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/smart-record.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/start-stop-playback.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/start-stop-playback.png new file mode 100644 index 000000000..6501daa78 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/start-stop-playback.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tap-tempo.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tap-tempo.png new file mode 100644 index 000000000..0daac0c71 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tap-tempo.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tempo-section.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tempo-section.png new file mode 100644 index 000000000..e2dada082 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tempo-section.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tempo.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tempo.png new file mode 100644 index 000000000..57c9565db Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/tempo.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/time-signature.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/time-signature.png new file mode 100644 index 000000000..a22d420c6 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/time-signature.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/transport-section.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/transport-section.png new file mode 100644 index 000000000..f002aea74 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/transport-section.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/visual-metronome.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/visual-metronome.png new file mode 100644 index 000000000..440172930 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/visual-metronome.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/write-to-arrangement.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/write-to-arrangement.png new file mode 100644 index 000000000..29e794caf Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/toolbar/write-to-arrangement.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel.png new file mode 100644 index 000000000..abe05963d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/arm.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/arm.png new file mode 100644 index 000000000..649878aeb Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/arm.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/fx-chain.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/fx-chain.png new file mode 100644 index 000000000..dea3cfd65 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/fx-chain.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/header.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/header.png new file mode 100644 index 000000000..abe05963d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/header.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-auto.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-auto.png new file mode 100644 index 000000000..ed8da740f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-auto.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-off.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-off.png new file mode 100644 index 000000000..8b4bd1921 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-off.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-on.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-on.png new file mode 100644 index 000000000..d9ccae269 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring-on.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring.png new file mode 100644 index 000000000..7a72ed195 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-monitoring.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-type-indicator.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-type-indicator.png new file mode 100644 index 000000000..bf40f59aa Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input-type-indicator.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input.png new file mode 100644 index 000000000..bfd5c21da Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/input.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/instrument-fx.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/instrument-fx.png new file mode 100644 index 000000000..826e0842f Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/instrument-fx.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/label.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/label.png new file mode 100644 index 000000000..63aef2926 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/label.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/map-to-midi-channel.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/map-to-midi-channel.png new file mode 100644 index 000000000..96811d0fc Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/map-to-midi-channel.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/midi-channel-filter.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/midi-channel-filter.png new file mode 100644 index 000000000..ed63026cd Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/midi-channel-filter.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/mute.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/mute.png new file mode 100644 index 000000000..ee61f5aee Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/mute.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pan.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pan.png new file mode 100644 index 000000000..1ed18f3e6 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pan.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-critical.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-critical.png new file mode 100644 index 000000000..7859cb8c7 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-critical.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-significant.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-significant.png new file mode 100644 index 000000000..f3c54f9b8 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-significant.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-tiny.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-tiny.png new file mode 100644 index 000000000..a40bd471b Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/pdc-tiny.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/routing.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/routing.png new file mode 100644 index 000000000..de336490d Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/routing.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/solo.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/solo.png new file mode 100644 index 000000000..e450bd81c Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/solo.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/volume.png b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/volume.png new file mode 100644 index 000000000..6592d2c8e Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/elements/track-panel/volume.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen-areas.png b/doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen-areas.png new file mode 100644 index 000000000..a8edd05c9 Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen-areas.png differ diff --git a/doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen.png b/doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen.png new file mode 100644 index 000000000..20f35a5fb Binary files /dev/null and b/doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen.png differ diff --git a/doc/playtime/modules/ROOT/images/playtime/screenshots/main-screen-areas.png b/doc/playtime/modules/ROOT/images/playtime/screenshots/main-screen-areas.png deleted file mode 100644 index ddc1a887d..000000000 Binary files a/doc/playtime/modules/ROOT/images/playtime/screenshots/main-screen-areas.png and /dev/null differ diff --git a/doc/playtime/modules/ROOT/images/playtime/screenshots/main-screen.png b/doc/playtime/modules/ROOT/images/playtime/screenshots/main-screen.png deleted file mode 100644 index e73e75015..000000000 Binary files a/doc/playtime/modules/ROOT/images/playtime/screenshots/main-screen.png and /dev/null differ diff --git a/doc/playtime/modules/ROOT/nav.adoc b/doc/playtime/modules/ROOT/nav.adoc index 24e27924b..91d57031c 100644 --- a/doc/playtime/modules/ROOT/nav.adoc +++ b/doc/playtime/modules/ROOT/nav.adoc @@ -1,4 +1,15 @@ * xref:introduction.adoc[] * xref:installation.adoc[] * xref:key-concepts.adoc[] -* xref:user-interface.adoc[] \ No newline at end of file +* xref:user-interface.adoc[] +** xref:user-interface/title-bar.adoc[] +** xref:user-interface/navigation-bar.adoc[] +** xref:user-interface/toolbar.adoc[] +** xref:user-interface/matrix.adoc[] +** xref:user-interface/track-area.adoc[] +** xref:user-interface/inspector.adoc[] +** xref:user-interface/info-panel.adoc[] +*** xref:user-interface/keyboard-shortcuts.adoc[] +* xref:further-concepts.adoc +** xref:further-concepts/general.adoc[] +* xref:reaper-actions.adoc[] \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/further-concepts.adoc b/doc/playtime/modules/ROOT/pages/further-concepts.adoc new file mode 100644 index 000000000..3a57602a4 --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/further-concepts.adoc @@ -0,0 +1 @@ += Further concepts \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/further-concepts/general.adoc b/doc/playtime/modules/ROOT/pages/further-concepts/general.adoc new file mode 100644 index 000000000..847d43175 --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/further-concepts/general.adoc @@ -0,0 +1,8 @@ += General + +[#pdc] +== Plugin delay compensation (PDC) + +Some FX (effects and instruments) add latency to a track due to internal processing. This can happen even with FX that's not on the track itself, but somewhere downstream in the signal flow, e.g. on the master track. + +REAPER and Playtime apply plug-in delay compensation (PDC) in order to fix the timing. That means they start processing content ahead of time in order to make up for the latency. PDC ensures that all tracks stay perfectly synchronized by delaying other tracks to match the plugin's latency. This prevents timing issues and maintains phase alignment in your project, ensuring accurate playback and mixing. \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/installation.adoc b/doc/playtime/modules/ROOT/pages/installation.adoc index c963fc714..c0ed56e22 100644 --- a/doc/playtime/modules/ROOT/pages/installation.adoc +++ b/doc/playtime/modules/ROOT/pages/installation.adoc @@ -1,3 +1,9 @@ = Installation -See xref:helgobox::installation.adoc[installation instructions for Helgobox], the plug-in that contains Playtime. \ No newline at end of file +At first, please follow the xref:helgobox::installation.adoc[installation instructions for Helgobox], the plug-in that contains Playtime. + +After installing Helgobox, the easiest way to access Playtime is by using the convenient btn:[Playtime] button in REAPER's main toolbar. +If you don't see it, do this: + +. Select menu:Extensions[Helgobox > Show welcome screen] +. Check "Add Playtime button to main toolbar" diff --git a/doc/playtime/modules/ROOT/pages/reaper-actions.adoc b/doc/playtime/modules/ROOT/pages/reaper-actions.adoc new file mode 100644 index 000000000..5878943cf --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/reaper-actions.adoc @@ -0,0 +1,7 @@ += REAPER actions + +Playtime provides the following REAPER actions in addition to the xref:helgobox::reaper-actions.adoc[general actions]. + +[#show-hide-playtime] +Helgobox/Playtime: Show/hide Playtime kbd:[Shift+Cmd/Ctrl+P]:: +If there's no Helgobox instance with a Playtime matrix in the current project, this action adds one and shows the matrix. If there is one already, it shows or hides the app. \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/user-interface.adoc b/doc/playtime/modules/ROOT/pages/user-interface.adoc index e264e9855..32d77d97f 100644 --- a/doc/playtime/modules/ROOT/pages/user-interface.adoc +++ b/doc/playtime/modules/ROOT/pages/user-interface.adoc @@ -1,7 +1,7 @@ = User interface .Main screen -image::playtime/screenshots/main-screen.png[] +image::generated/screenshots/main/main-screen.png[] .Areas of the main screen -image::playtime/screenshots/main-screen-areas.png[] \ No newline at end of file +image::generated/screenshots/main/main-screen-areas.png[] \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/user-interface/info-panel.adoc b/doc/playtime/modules/ROOT/pages/user-interface/info-panel.adoc new file mode 100644 index 000000000..7727c78cd --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/info-panel.adoc @@ -0,0 +1,27 @@ += Info panel + +The info panel displays context-sensitive help, statistics and warnings. + +== Help + +This tab displays helpful information about the item under the mouse. + +== Warnings + +In certain situations, you might see a warning button, that upon clicking will show you further details about the warnings. + +== Stats + +This tab displays information about the current state of the Playtime engine. + +include::partial$generated/elements/info-panel/stats/tempo-buffer-size.adoc[] + +include::partial$generated/elements/info-panel/stats/pre-buffered-blocks-playing-min.adoc[] + +include::partial$generated/elements/info-panel/stats/pre-buffered-blocks-playing-avg.adoc[] + +include::partial$generated/elements/info-panel/stats/pre-buffered-blocks-playing-max.adoc[] + +include::partial$generated/elements/info-panel/stats/pre-buffer-fallback-count.adoc[] + +include::partial$generated/elements/info-panel/stats/pre-buffer-miss-count.adoc[] diff --git a/doc/playtime/modules/ROOT/pages/user-interface/inspector.adoc b/doc/playtime/modules/ROOT/pages/user-interface/inspector.adoc index f12a8c9ad..3bc7f7275 100644 --- a/doc/playtime/modules/ROOT/pages/user-interface/inspector.adoc +++ b/doc/playtime/modules/ROOT/pages/user-interface/inspector.adoc @@ -1 +1,5 @@ -= Inspector \ No newline at end of file += Inspector + +The inspector on the right displays details about the currently selected cell. + +TODO \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/user-interface/keyboard-shortcuts.adoc b/doc/playtime/modules/ROOT/pages/user-interface/keyboard-shortcuts.adoc new file mode 100644 index 000000000..7b929e3bc --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/keyboard-shortcuts.adoc @@ -0,0 +1,54 @@ += Keyboard shortcuts + +Playtime provides keyboard shortcuts in addition to the xref:helgobox::app/user-interface/keyboard-shortcuts.adoc[general ones]. + +|=== +|Shortcut |Purpose + +|kbd:[Cmd+Z] +|Invokes Playtime's undo function. + +|kbd:[Cmd+R] +|Invokes Playtime's redo function. + +|kbd:[Backspace/Delete] +|Deletes the currently selected column or row, or clears the selected slot's contents. + +|kbd:[Cmd/Ctrl+C] +|Copies the currently selected row or slot contents to the clipboard. + +|kbd:[Cmd/Ctrl+X] +|Cuts the currently selected row or slot contents to the clipboard. + +|kbd:[Cmd/Ctrl+V] +|Pastes row or slot contents from the clipboard to the currently selected row or slot. + +|kbd:[Space] +|Starts or stops playback. + +|kbd:[F2] +|Renames the currently selected column, row, clip or track. + +|kbd:[T] +|Taps the tempo. + +|kbd:[M] +|Toggles the metronome. + +|kbd:[E] +|Edits the first clip in the currently selected slot. + +|kbd:[Q] +|Quantizes the first clip in the currently selected slot. + +|kbd:[O] +|Overdubs the first clip in the currently selected slot, if it's a MIDI clip. + +|kbd:[A] +|Exports the complete matrix or the currently selected column, row or clip to the arrangement. + +|kbd:[Shift+Cmd/Ctrl+P] +|Executes the REAPER action xref:reaper-actions.adoc#show-hide-playtime[]. + +|=== + diff --git a/doc/playtime/modules/ROOT/pages/user-interface/matrix.adoc b/doc/playtime/modules/ROOT/pages/user-interface/matrix.adoc new file mode 100644 index 000000000..9b92132ef --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/matrix.adoc @@ -0,0 +1,46 @@ += Matrix + +== General + +include::partial$generated/elements/matrix/add-column.adoc[] + +include::partial$generated/elements/matrix/add-row.adoc[] + +include::partial$generated/elements/matrix/scroll-indicator.adoc[] + + +include::partial$generated/elements/matrix-cell.adoc[] + +include::partial$generated/elements/matrix-cell/stop.adoc[] + +include::partial$generated/elements/matrix-cell/settings.adoc[] + + +include::partial$generated/elements/column-cell.adoc[] + +include::partial$generated/elements/column-cell/exclusive-mode.adoc[] + +include::partial$generated/elements/column-cell/follow-scenes.adoc[] + +include::partial$generated/elements/column-cell/has-overrides.adoc[] + +include::partial$generated/elements/column-cell/stop.adoc[] + +include::partial$generated/elements/column-cell/label.adoc[] + + +include::partial$generated/elements/row-cell.adoc[] + +include::partial$generated/elements/row-cell/play-scene.adoc[] + +include::partial$generated/elements/row-cell/label.adoc[] + +include::partial$generated/elements/slot-cell.adoc[] + +include::partial$generated/elements/slot-cell/trigger.adoc[] + +include::partial$generated/elements/slot-cell/record.adoc[] + +include::partial$generated/elements/slot-cell/content.adoc[] + +include::partial$generated/elements/slot-cell/clip-count.adoc[] \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/user-interface/navigation-bar.adoc b/doc/playtime/modules/ROOT/pages/user-interface/navigation-bar.adoc new file mode 100644 index 000000000..049cefce4 --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/navigation-bar.adoc @@ -0,0 +1,3 @@ += Navigation bar + +Buttons shown in the navigation bar are not specific to Playtime. See xref:helgobox::app/user-interface/navigation-bar.adoc[] in the Helgobox documentation. \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/user-interface/title-bar.adoc b/doc/playtime/modules/ROOT/pages/user-interface/title-bar.adoc new file mode 100644 index 000000000..50df85014 --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/title-bar.adoc @@ -0,0 +1,5 @@ += Title bar + +Most buttons shown in the title bar are not specific to Playtime. See xref:helgobox::app/user-interface/title-bar.adoc[] in the Helgobox documentation. + +TODO Playtime-specific parts \ No newline at end of file diff --git a/doc/playtime/modules/ROOT/pages/user-interface/toolbar.adoc b/doc/playtime/modules/ROOT/pages/user-interface/toolbar.adoc new file mode 100644 index 000000000..faf0f6e83 --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/toolbar.adoc @@ -0,0 +1,35 @@ += Toolbar + +include::partial$generated/elements/toolbar/tempo-section.adoc[] + +include::partial$generated/elements/toolbar/metronome.adoc[] + +include::partial$generated/elements/toolbar/tempo.adoc[] + +include::partial$generated/elements/toolbar/tap-tempo.adoc[] + +include::partial$generated/elements/toolbar/time-signature.adoc[] + +include::partial$generated/elements/toolbar/play-rate.adoc[] + +include::partial$generated/elements/toolbar/transport-section.adoc[] + +include::partial$generated/elements/toolbar/smart-record.adoc[] + +include::partial$generated/elements/toolbar/start-stop-playback.adoc[] + +include::partial$generated/elements/toolbar/matrix-start-timing.adoc[] + +include::partial$generated/elements/toolbar/matrix-sequencer.adoc[] + +include::partial$generated/elements/toolbar/record-matrix-sequence.adoc[] + +include::partial$generated/elements/toolbar/matrix-sequence-picker.adoc[] + +include::partial$generated/elements/toolbar/play-stop-matrix-sequence.adoc[] + +include::partial$generated/elements/toolbar/write-to-arrangement.adoc[] + +include::partial$generated/elements/toolbar/show-hide-midi-triggers.adoc[] + +include::partial$generated/elements/toolbar/pane-toggler.adoc[] diff --git a/doc/playtime/modules/ROOT/pages/user-interface/track-area.adoc b/doc/playtime/modules/ROOT/pages/user-interface/track-area.adoc new file mode 100644 index 000000000..24e80ad98 --- /dev/null +++ b/doc/playtime/modules/ROOT/pages/user-interface/track-area.adoc @@ -0,0 +1,49 @@ += Track area + +include::partial$generated/elements/track-panel/header.adoc[] + +include::partial$generated/elements/track-panel/input-type-indicator.adoc[] + +include::partial$generated/elements/track-panel/label.adoc[] + +== Track input section + +include::partial$generated/elements/track-panel/input.adoc[] + +include::partial$generated/elements/track-panel/midi-channel-filter.adoc[] + +include::partial$generated/elements/track-panel/map-to-midi-channel.adoc[] + +include::partial$generated/elements/track-panel/input-monitoring.adoc[] + +include::partial$generated/elements/track-panel/input-monitoring-off.adoc[] + +include::partial$generated/elements/track-panel/input-monitoring-auto.adoc[] + +include::partial$generated/elements/track-panel/input-monitoring-on.adoc[] + +== Track output section + +=== PDC info + +If the track is affected by xref:further-concepts/general.adoc#pdc[], a small icon will light up. + +include::partial$generated/elements/track-panel/pdc-tiny.adoc[] +include::partial$generated/elements/track-panel/pdc-significant.adoc[] +include::partial$generated/elements/track-panel/pdc-critical.adoc[] + +include::partial$generated/elements/track-panel/pan.adoc[] + +include::partial$generated/elements/track-panel/volume.adoc[] + +include::partial$generated/elements/track-panel/instrument-fx.adoc[] + +include::partial$generated/elements/track-panel/fx-chain.adoc[] + +include::partial$generated/elements/track-panel/routing.adoc[] + +include::partial$generated/elements/track-panel/arm.adoc[] + +include::partial$generated/elements/track-panel/mute.adoc[] + +include::partial$generated/elements/track-panel/solo.adoc[] diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/column-cell.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell.adoc new file mode 100644 index 000000000..437d8d991 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell.adoc @@ -0,0 +1,6 @@ +[#column-cell] +== Column header cell + +image:generated/screenshots/elements/column-cell.png[Column header cell, role="related thumb right"] + +This cell represents the complete column, including all of its slots. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/exclusive-mode.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/exclusive-mode.adoc new file mode 100644 index 000000000..e6ff0e355 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/exclusive-mode.adoc @@ -0,0 +1,8 @@ +[#column-cell-exclusive-mode] +=== Exclusive mode + +image:generated/screenshots/elements/column-cell/exclusive-mode.png[Exclusive mode, role="related thumb right"] + +This lights up if the column is in exclusive mode, which means that only one slot at a time can be playing. + +You can also click here to toggle exclusive mode on/off. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/follow-scenes.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/follow-scenes.adoc new file mode 100644 index 000000000..91072e4dc --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/follow-scenes.adoc @@ -0,0 +1,8 @@ +[#column-cell-follow-scenes] +=== Follow scenes + +image:generated/screenshots/elements/column-cell/follow-scenes.png[Follow scenes, role="related thumb right"] + +This lights up if the column follows scenes. + +You can also click here to follow/unfollow. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/has-overrides.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/has-overrides.adoc new file mode 100644 index 000000000..419b3e443 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/has-overrides.adoc @@ -0,0 +1,6 @@ +[#column-cell-has-overrides] +=== Has overrides + +image:generated/screenshots/elements/column-cell/has-overrides.png[Has overrides, role="related thumb right"] + +This lights up if the column overrides at least one matrix setting. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/label.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/label.adoc new file mode 100644 index 000000000..2f64bb1a8 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/label.adoc @@ -0,0 +1,6 @@ +[#column-cell-label] +=== Column label + +image:generated/screenshots/elements/column-cell/label.png[Column label, role="related thumb right"] + +Selects this column cell. This makes the inspector show settings related to this column. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/stop.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/stop.adoc new file mode 100644 index 000000000..3e651e6de --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/column-cell/stop.adoc @@ -0,0 +1,8 @@ +[#column-cell-stop] +=== Stop column + +image:generated/screenshots/elements/column-cell/stop.png[Stop column, role="related thumb right"] + +A single click stops all playing clips in this column according to their stop timing. + +A double click stops all playing clips in this column instantly. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffer-fallback-count.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffer-fallback-count.adoc new file mode 100644 index 000000000..4e25b4313 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffer-fallback-count.adoc @@ -0,0 +1,8 @@ +[#info-panel-stats-pre-buffer-fallback-count] +=== Pre-buffer fallbacks so far + +image:generated/screenshots/elements/info-panel/stats/pre-buffer-fallback-count.png[Pre-buffer fallbacks so far, role="related thumb right"] + +The number of times in which any audio clip's dynamic pre-buffer couldn't provide the desired pre-rendered audio content, but the static pre-buffer was able to provide it instead. + +It's normal that this rises when playing audio clips, especially when using "Immediate" start timing. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffer-miss-count.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffer-miss-count.adoc new file mode 100644 index 000000000..35d9494d0 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffer-miss-count.adoc @@ -0,0 +1,8 @@ +[#info-panel-stats-pre-buffer-miss-count] +=== Pre-buffer misses so far + +image:generated/screenshots/elements/info-panel/stats/pre-buffer-miss-count.png[Pre-buffer misses so far, role="related thumb right"] + +The number of times in which any audio clip's dynamic pre-buffer couldn't provide the desired pre-rendered audio content and even the static pre-buffer failed to provide it. + +If this rises from time to time, it's usually no reason to worry. Often the non-provided audio content lies within the count-in section of a clip, which is most likely silence anyway. However, if this continuously rises, it's not good and you will might experience audio dropouts or even completely silent clips. In this case, increasing REAPER's audio device buffer size and/or decreasing the sample rate might help. You can also try to increase Playtime's tempo latency. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-avg.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-avg.adoc new file mode 100644 index 000000000..55597fe66 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-avg.adoc @@ -0,0 +1,6 @@ +[#info-panel-stats-pre-buffered-blocks-playing-avg] +=== Pre-buffered blocks playing (avg) + +image:generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-avg.png[Pre-buffered blocks playing (avg), role="related thumb right"] + +The average number of pre-buffered blocks among currently playing audio clips. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-max.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-max.adoc new file mode 100644 index 000000000..076575f7f --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-max.adoc @@ -0,0 +1,6 @@ +[#info-panel-stats-pre-buffered-blocks-playing-max] +=== Pre-buffered blocks playing (max) + +image:generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-max.png[Pre-buffered blocks playing (max), role="related thumb right"] + +The largest encountered number of pre-buffered blocks among currently playing audio clips. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-min.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-min.adoc new file mode 100644 index 000000000..b272f3b53 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/pre-buffered-blocks-playing-min.adoc @@ -0,0 +1,6 @@ +[#info-panel-stats-pre-buffered-blocks-playing-min] +=== Pre-buffered blocks playing (min) + +image:generated/screenshots/elements/info-panel/stats/pre-buffered-blocks-playing-min.png[Pre-buffered blocks playing (min), role="related thumb right"] + +The smallest encountered number of pre-buffered blocks among currently playing audio clips. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/tempo-buffer-size.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/tempo-buffer-size.adoc new file mode 100644 index 000000000..f687f1594 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/info-panel/stats/tempo-buffer-size.adoc @@ -0,0 +1,8 @@ +[#info-panel-stats-tempo-buffer-size] +=== Tempo buffer size (in blocks) + +image:generated/screenshots/elements/info-panel/stats/tempo-buffer-size.png[Tempo buffer size (in blocks), role="related thumb right"] + +The current size of the tempo buffer in blocks. + +The tempo buffer size determines how many audio blocks Playtime may look ahead in order to pre-render audio clips with the correct tempo and sample rate. It is influenced by the "Tempo latency" setting. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell.adoc new file mode 100644 index 000000000..7a0b8fbae --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell.adoc @@ -0,0 +1,6 @@ +[#matrix-cell] +== Matrix cell + +image:generated/screenshots/elements/matrix-cell.png[Matrix cell, role="related thumb right"] + +This cell represents the complete matrix including all columns, rows and slots. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell/settings.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell/settings.adoc new file mode 100644 index 000000000..45da63c44 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell/settings.adoc @@ -0,0 +1,6 @@ +[#matrix-cell-settings] +=== Matrix settings + +image:generated/screenshots/elements/matrix-cell/settings.png[Matrix settings, role="related thumb right"] + +Selects the matrix settings cell. This makes the inspector show settings related to the complete matrix. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell/stop.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell/stop.adoc new file mode 100644 index 000000000..95da46198 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/matrix-cell/stop.adoc @@ -0,0 +1,8 @@ +[#matrix-cell-stop] +=== Stop matrix + +image:generated/screenshots/elements/matrix-cell/stop.png[Stop matrix, role="related thumb right"] + +A single click stops all playing clips according to their stop timing. + +A double click stops all playing clips instantly. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/matrix/add-column.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/matrix/add-column.adoc new file mode 100644 index 000000000..42170874e --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/matrix/add-column.adoc @@ -0,0 +1,6 @@ +[#matrix-add-column] +=== Add column + +image:generated/screenshots/elements/matrix/add-column.png[Add column, role="related thumb right"] + +Adds a new column to the matrix diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/matrix/add-row.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/matrix/add-row.adoc new file mode 100644 index 000000000..da2a4301d --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/matrix/add-row.adoc @@ -0,0 +1,6 @@ +[#matrix-add-row] +=== Add row + +image:generated/screenshots/elements/matrix/add-row.png[Add row, role="related thumb right"] + +Adds a new row to the matrix diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/matrix/scroll-indicator.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/matrix/scroll-indicator.adoc new file mode 100644 index 000000000..b68b86ad8 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/matrix/scroll-indicator.adoc @@ -0,0 +1,6 @@ +[#matrix-scroll-indicator] +=== Scroll indicator + +image:generated/screenshots/elements/matrix/scroll-indicator.png[Scroll indicator, role="related thumb right"] + +This arrow tells that you are not seeing the complete matrix at once. It continues in the indicated direction. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/row-cell.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/row-cell.adoc new file mode 100644 index 000000000..8d0ee5500 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/row-cell.adoc @@ -0,0 +1,6 @@ +[#row-cell] +== Row header cell + +image:generated/screenshots/elements/row-cell.png[Row header cell, role="related thumb right"] + +This cell represents the complete row, including all of its slots. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/row-cell/label.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/row-cell/label.adoc new file mode 100644 index 000000000..6aba5a35b --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/row-cell/label.adoc @@ -0,0 +1,6 @@ +[#row-cell-label] +=== Row label + +image:generated/screenshots/elements/row-cell/label.png[Row label, role="related thumb right"] + +Selects this row cell. This makes the inspector show settings related to this row. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/row-cell/play-scene.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/row-cell/play-scene.adoc new file mode 100644 index 000000000..c80c1ba18 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/row-cell/play-scene.adoc @@ -0,0 +1,6 @@ +[#row-cell-play-scene] +=== Play scene + +image:generated/screenshots/elements/row-cell/play-scene.png[Play scene, role="related thumb right"] + +Plays all clips in this row whose column follows scenes. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell.adoc new file mode 100644 index 000000000..8163a348e --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell.adoc @@ -0,0 +1,6 @@ +[#slot-cell] +== Slot cell + +image:generated/screenshots/elements/slot-cell.png[Slot cell, role="related thumb right"] + +This cell represents a slot in the matrix. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/clip-count.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/clip-count.adoc new file mode 100644 index 000000000..4e8959eb9 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/clip-count.adoc @@ -0,0 +1,6 @@ +[#slot-cell-clip-count] +=== Number of clips + +image:generated/screenshots/elements/slot-cell/clip-count.png[Number of clips, role="related thumb right"] + +Shows the number of clips contained in this slot if there's more than one. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/content.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/content.adoc new file mode 100644 index 000000000..e4560203b --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/content.adoc @@ -0,0 +1,8 @@ +[#slot-cell-content] +=== Slot content + +image:generated/screenshots/elements/slot-cell/content.png[Slot content, role="related thumb right"] + +Selects this slot cell. This makes the inspector show settings for each clip in this slot. + +A double click on a filled slot cell opens the waveform view or the MIDI editor of the primary clip in this slot. A double click on an empty slot cell creates an empty MIDI clip. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/record.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/record.adoc new file mode 100644 index 000000000..63672a189 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/record.adoc @@ -0,0 +1,6 @@ +[#slot-cell-record] +=== Record clip + +image:generated/screenshots/elements/slot-cell/record.png[Record clip, role="related thumb right"] + +Starts recording a new clip into this slot. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/trigger.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/trigger.adoc new file mode 100644 index 000000000..84d94a336 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/slot-cell/trigger.adoc @@ -0,0 +1,8 @@ +[#slot-cell-trigger] +=== Trigger slot + +image:generated/screenshots/elements/slot-cell/trigger.png[Trigger slot, role="related thumb right"] + +Plays, retriggers or stops all clips in this slot depending on the trigger behavior configured for the matrix. + +**Stop:** A single click stops all contained clips according to their stop timing. A double click stops all contained clips instantly. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-color.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-color.adoc new file mode 100644 index 000000000..45db893ca --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-color.adoc @@ -0,0 +1,8 @@ +[#todo-clip-color] +== Color + +image:generated/screenshots/elements/todo/clip-color.png[Color, role="related thumb right"] + +Lets you pick a color for this clip from the matrix color palette. + +If you choose the "Auto" color, the clip will be displayed using the same color as the containing track. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-expert-settings.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-expert-settings.adoc new file mode 100644 index 000000000..54fff97fa --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-expert-settings.adoc @@ -0,0 +1,6 @@ +[#todo-clip-expert-settings] +== Expert settings ⊕ + +image:generated/screenshots/elements/todo/clip-expert-settings.png[Expert settings ⊕, role="related thumb right"] + +It's usually not necessary to touch the settings in this section. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-length.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-length.adoc new file mode 100644 index 000000000..68a0ed3b2 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-length.adoc @@ -0,0 +1,8 @@ +[#todo-clip-length] +== Length + +image:generated/screenshots/elements/todo/clip-length.png[Length, role="related thumb right"] + +Crops the clip to a specific length, starting from the start position. + +If the length exceeds the end of the source, Playtime will insert silence. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-looped.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-looped.adoc new file mode 100644 index 000000000..547a7d887 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-looped.adoc @@ -0,0 +1,6 @@ +[#todo-clip-looped] +== Looped + +image:generated/screenshots/elements/todo/clip-looped.png[Looped, role="related thumb right"] + +If enabled, the clip will loop until you stop it. If disabled, it will become a "One shot". diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-midi-channel-original.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-midi-channel-original.adoc new file mode 100644 index 000000000..03cde7bf2 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-midi-channel-original.adoc @@ -0,0 +1,6 @@ +[#todo-clip-midi-channel-original] +== Original + +image:generated/screenshots/elements/todo/clip-midi-channel-original.png[Original, role="related thumb right"] + +Simply keeps the original channel, doesn't apply any channel transformation. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-midi-channel.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-midi-channel.adoc new file mode 100644 index 000000000..c701b5147 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-midi-channel.adoc @@ -0,0 +1,6 @@ +[#todo-clip-midi-channel] +== MIDI channel + +image:generated/screenshots/elements/todo/clip-midi-channel.png[MIDI channel, role="related thumb right"] + +Allows you to re-route the MIDI events in this clip to a MIDI channel of your choice. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-name.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-name.adoc new file mode 100644 index 000000000..3b9936e8b --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-name.adoc @@ -0,0 +1,6 @@ +[#todo-clip-name] +== Name + +image:generated/screenshots/elements/todo/clip-name.png[Name, role="related thumb right"] + +Give your clip a descriptive name! diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-pitch.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-pitch.adoc new file mode 100644 index 000000000..e2436a3d9 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-pitch.adoc @@ -0,0 +1,6 @@ +[#todo-clip-pitch] +== Pitch + +image:generated/screenshots/elements/todo/clip-pitch.png[Pitch, role="related thumb right"] + +Allows you to adjust the pitch of this clip. In case of MIDI, only integers are supported. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-reset-behavior.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-reset-behavior.adoc new file mode 100644 index 000000000..7ca7234b4 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-reset-behavior.adoc @@ -0,0 +1,6 @@ +[#todo-clip-reset-behavior] +== Reset behavior + +image:generated/screenshots/elements/todo/clip-reset-behavior.png[Reset behavior, role="related thumb right"] + +Determines which MIDI reset messages Playtime sends before and/or after playing the clip. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-section.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-section.adoc new file mode 100644 index 000000000..c44e4b71b --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-section.adoc @@ -0,0 +1,8 @@ +[#todo-clip-section] +== Section ⊖ + +image:generated/screenshots/elements/todo/clip-section.png[Section ⊖, role="related thumb right"] + +Here you can define which part of the audio or MIDI clip you want to play. + +You can play with the section start position and length as part of a performance! This distinguishes it from the more permanent "Source cut" settings in the expert section. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-source-cut-start.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-source-cut-start.adoc new file mode 100644 index 000000000..43f1d45d9 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-source-cut-start.adoc @@ -0,0 +1,10 @@ +[#todo-clip-source-cut-start] +== Source cut: Start + +image:generated/screenshots/elements/todo/clip-source-cut-start.png[Source cut: Start, role="related thumb right"] + +Sets the start position within the source material. + +This is usually set by Playtime itself only, right after recording an audio clip, in order to crop away the count-in phase of the recording. + +You may set this yourself, but you should be careful with it as it can easily destroy timing. Using this with MIDI clips is not recommended. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-source-info.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-source-info.adoc new file mode 100644 index 000000000..682fb6a45 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-source-info.adoc @@ -0,0 +1,6 @@ +[#todo-clip-source-info] +== Source info + +image:generated/screenshots/elements/todo/clip-source-info.png[Source info, role="related thumb right"] + +Displays information about the source of this clip, e.g. the audio file. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-start-position.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-start-position.adoc new file mode 100644 index 000000000..39a6ffced --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-start-position.adoc @@ -0,0 +1,6 @@ +[#todo-clip-start-position] +== Start position + +image:generated/screenshots/elements/todo/clip-start-position.png[Start position, role="related thumb right"] + +Sets the start position within the clip. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-start-timing.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-start-timing.adoc new file mode 100644 index 000000000..f9b05321f --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-start-timing.adoc @@ -0,0 +1,6 @@ +[#todo-clip-start-timing] +== Start timing + +image:generated/screenshots/elements/todo/clip-start-timing.png[Start timing, role="related thumb right"] + +This overrides the start timing defined in the column or matrix settings. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-stop-timing.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-stop-timing.adoc new file mode 100644 index 000000000..d36fa3773 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-stop-timing.adoc @@ -0,0 +1,6 @@ +[#todo-clip-stop-timing] +== Stop timing + +image:generated/screenshots/elements/todo/clip-stop-timing.png[Stop timing, role="related thumb right"] + +This overrides the stop timing defined in the column or matrix settings. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-sync-to-project-tempo.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-sync-to-project-tempo.adoc new file mode 100644 index 000000000..e7cc80817 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-sync-to-project-tempo.adoc @@ -0,0 +1,7 @@ +[#todo-clip-sync-to-project-tempo] +== Sync to project tempo + +image:generated/screenshots/elements/todo/clip-sync-to-project-tempo.png[Sync to project tempo, role="related thumb right"] + +Whether to adjust the playback tempo of the clip to the project tempo. You usually want to have this enabled for rhythmic material. + diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-velocity-sensitivity.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-velocity-sensitivity.adoc new file mode 100644 index 000000000..0e29f78ed --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-velocity-sensitivity.adoc @@ -0,0 +1,6 @@ +[#todo-clip-velocity-sensitivity] +== Velocity sensitivity + +image:generated/screenshots/elements/todo/clip-velocity-sensitivity.png[Velocity sensitivity, role="related thumb right"] + +This overrides the velocity sensitivity defined in the column or matrix settings. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-volume.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-volume.adoc new file mode 100644 index 000000000..0b8e07f63 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/todo/clip-volume.adoc @@ -0,0 +1,6 @@ +[#todo-clip-volume] +== Volume + +image:generated/screenshots/elements/todo/clip-volume.png[Volume, role="related thumb right"] + +Allows you to set the volume of this clip. In case of MIDI, it will adjust the velocity of played MIDI notes. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-sequence-picker.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-sequence-picker.adoc new file mode 100644 index 000000000..9d36e349c --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-sequence-picker.adoc @@ -0,0 +1,6 @@ +[#toolbar-matrix-sequence-picker] +=== Matrix sequence picker + +image:generated/screenshots/elements/toolbar/matrix-sequence-picker.png[Matrix sequence picker, role="related thumb right"] + +Pick the active matrix sequence diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-sequencer.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-sequencer.adoc new file mode 100644 index 000000000..57b058680 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-sequencer.adoc @@ -0,0 +1,6 @@ +[#toolbar-matrix-sequencer] +== Matrix sequencer + +image:generated/screenshots/elements/toolbar/matrix-sequencer.png[Matrix sequencer, role="related thumb right"] + +The matrix sequencer allows you to record play and stop interactions with the matrix and write them to the arrangement when satisfied. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-start-timing.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-start-timing.adoc new file mode 100644 index 000000000..8352e2cb2 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/matrix-start-timing.adoc @@ -0,0 +1,8 @@ +[#toolbar-matrix-start-timing] +== Matrix start timing + +image:generated/screenshots/elements/toolbar/matrix-start-timing.png[Matrix start timing, role="related thumb right"] + +Decides when a clip actually starts playing after you have triggered its playback. + +This setting applies to all clips in the matrix but it can be overridden at column and clip level. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/metronome.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/metronome.adoc new file mode 100644 index 000000000..922758b6c --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/metronome.adoc @@ -0,0 +1,8 @@ +[#toolbar-metronome] +=== Metronome + +image:generated/screenshots/elements/toolbar/metronome.png[Metronome, role="related thumb right"] + +Toggles the metronome. + +Right-click to change metronome settings. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/open-ended-recording.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/open-ended-recording.adoc new file mode 100644 index 000000000..1fc8c83d5 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/open-ended-recording.adoc @@ -0,0 +1,6 @@ +[#toolbar-open-ended-recording] +== Open-ended recording + +image:generated/screenshots/elements/toolbar/open-ended-recording.png[Open-ended recording, role="related thumb right"] + +Clips recordings are not limited in length. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/pane-toggler.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/pane-toggler.adoc new file mode 100644 index 000000000..b492174a9 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/pane-toggler.adoc @@ -0,0 +1,6 @@ +[#toolbar-pane-toggler] +== Pane toggler + +image:generated/screenshots/elements/toolbar/pane-toggler.png[Pane toggler, role="related thumb right"] + +Shows/hides different areas of Playtime's user interface. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/play-rate.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/play-rate.adoc new file mode 100644 index 000000000..f2f397ea8 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/play-rate.adoc @@ -0,0 +1,6 @@ +[#toolbar-play-rate] +=== Play rate + +image:generated/screenshots/elements/toolbar/play-rate.png[Play rate, role="related thumb right"] + +Controls the project play rate. This is possible as long as no tempo marker exists in the project. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/play-stop-matrix-sequence.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/play-stop-matrix-sequence.adoc new file mode 100644 index 000000000..080767491 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/play-stop-matrix-sequence.adoc @@ -0,0 +1,6 @@ +[#toolbar-play-stop-matrix-sequence] +=== Play/stop matrix sequence + +image:generated/screenshots/elements/toolbar/play-stop-matrix-sequence.png[Play/stop matrix sequence, role="related thumb right"] + +Plays or stops the currently active matrix sequence diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/record-matrix-sequence.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/record-matrix-sequence.adoc new file mode 100644 index 000000000..627d57ab2 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/record-matrix-sequence.adoc @@ -0,0 +1,6 @@ +[#toolbar-record-matrix-sequence] +=== Record matrix sequence + +image:generated/screenshots/elements/toolbar/record-matrix-sequence.png[Record matrix sequence, role="related thumb right"] + +Starts recording a new matrix performance diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/show-hide-midi-triggers.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/show-hide-midi-triggers.adoc new file mode 100644 index 000000000..01964b077 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/show-hide-midi-triggers.adoc @@ -0,0 +1,10 @@ +[#toolbar-show-hide-midi-triggers] +== Show/hide MIDI triggers + +image:generated/screenshots/elements/toolbar/show-hide-midi-triggers.png[Show/hide MIDI triggers, role="related thumb right"] + +Shows or hides MIDI triggers assigned to cells. + +The purpose of this feature is to quickly create simple mappings of MIDI keys/pads/buttons to cells. If you want to configure full-featured grid controllers instead (e.g. Launchpad), check out the buttons at the bottom of the navigation bar on the left. + +The MIDI triggers configured here are specific to this particular Playtime instance, not global! diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/smart-record.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/smart-record.adoc new file mode 100644 index 000000000..b54693b39 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/smart-record.adoc @@ -0,0 +1,14 @@ +[#toolbar-smart-record] +=== Smart record + +image:generated/screenshots/elements/toolbar/smart-record.png[Smart record, role="related thumb right"] + +This is a convenience button for recording stuff without having to choose a particular matrix slot first. + +If nothing is recording yet, it will start recording into the next free slot of the first column whose track is armed. + +If there is an ongoing recording, it will be stopped. + +If playback is stopped, this button is displayed with a pulse animation. This indicates that pressing this button will trigger a pre-roll recording (if metronome enabled) or that the length of the first recorded clip will dictate the new tempo (if metronome disabled). + +Right-clicking the button allows you to change settings related to recording clips. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/start-stop-playback.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/start-stop-playback.adoc new file mode 100644 index 000000000..556258c4f --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/start-stop-playback.adoc @@ -0,0 +1,10 @@ +[#toolbar-start-stop-playback] +=== Start/stop playback + +image:generated/screenshots/elements/toolbar/start-stop-playback.png[Start/stop playback, role="related thumb right"] + +Pressing this button start or stops Playtime playback. + +Starting playback also triggers playback of all *ignited* clips in the matrix. If you want to permanently stop all ignited clips before playback, simply click the matrix stop button. + +Stopping playback automatically ignites all clips that have been playing. After stopping you can resume playback or use the tap button (visual metronome) to count in with a completely new tempo. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tap-tempo.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tap-tempo.adoc new file mode 100644 index 000000000..df898ab55 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tap-tempo.adoc @@ -0,0 +1,6 @@ +[#toolbar-tap-tempo] +=== Tap tempo + +image:generated/screenshots/elements/toolbar/tap-tempo.png[Tap tempo, role="related thumb right"] + +Click here repeatedly in order to tap the tempo. This is especially useful when playback is stopped, in which case it allows you to conduct a count-in. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tempo-section.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tempo-section.adoc new file mode 100644 index 000000000..8848f686e --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tempo-section.adoc @@ -0,0 +1,6 @@ +[#toolbar-tempo-section] +== Tempo section + +image:generated/screenshots/elements/toolbar/tempo-section.png[Tempo section, role="related thumb right"] + +Provides tempo-related controls. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tempo.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tempo.adoc new file mode 100644 index 000000000..47d39016c --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/tempo.adoc @@ -0,0 +1,6 @@ +[#toolbar-tempo] +=== Tempo + +image:generated/screenshots/elements/toolbar/tempo.png[Tempo, role="related thumb right"] + +Controls the project tempo. This is possible as long as no tempo marker exists in the project. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/time-signature.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/time-signature.adoc new file mode 100644 index 000000000..3057dfed8 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/time-signature.adoc @@ -0,0 +1,6 @@ +[#toolbar-time-signature] +=== Time signature + +image:generated/screenshots/elements/toolbar/time-signature.png[Time signature, role="related thumb right"] + +Displays the project's time signature. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/transport-section.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/transport-section.adoc new file mode 100644 index 000000000..330c142c3 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/transport-section.adoc @@ -0,0 +1,6 @@ +[#toolbar-transport-section] +== Transport section + +image:generated/screenshots/elements/toolbar/transport-section.png[Transport section, role="related thumb right"] + +Provides the Playtime transport controls. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/visual-metronome.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/visual-metronome.adoc new file mode 100644 index 000000000..8507888c1 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/visual-metronome.adoc @@ -0,0 +1,6 @@ +[#toolbar-visual-metronome] +== Visual metronome + +image:generated/screenshots/elements/toolbar/visual-metronome.png[Visual metronome, role="related thumb right"] + +Shows the current position within the bar in beats. Can also be used for tempo tapping. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/write-to-arrangement.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/write-to-arrangement.adoc new file mode 100644 index 000000000..7ee395dfa --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/toolbar/write-to-arrangement.adoc @@ -0,0 +1,6 @@ +[#toolbar-write-to-arrangement] +=== Write to arrangement + +image:generated/screenshots/elements/toolbar/write-to-arrangement.png[Write to arrangement, role="related thumb right"] + +Writes the currently active matrix sequence to REAPER's tracks diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/arm.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/arm.adoc new file mode 100644 index 000000000..8918110d8 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/arm.adoc @@ -0,0 +1,6 @@ +[#track-panel-arm] +=== Arm track + +image:generated/screenshots/elements/track-panel/arm.png[Arm track, role="related thumb right"] + +Arms this track for recording diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/fx-chain.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/fx-chain.adoc new file mode 100644 index 000000000..4854b5cdf --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/fx-chain.adoc @@ -0,0 +1,6 @@ +[#track-panel-fx-chain] +=== FX chain + +image:generated/screenshots/elements/track-panel/fx-chain.png[FX chain, role="related thumb right"] + +Shows the REAPER FX chain of this track diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/header.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/header.adoc new file mode 100644 index 000000000..36a2d6b2c --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/header.adoc @@ -0,0 +1,8 @@ +[#track-panel-header] +== Track panel header + +image:generated/screenshots/elements/track-panel/header.png[Track panel header, role="related thumb right"] + +Shows info and controls related to the playback track of this matrix column. + +Since multiple columns can have the same playback track, it's possible that you see one track panel multiple times! diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-auto.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-auto.adoc new file mode 100644 index 000000000..02f37f1de --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-auto.adoc @@ -0,0 +1,6 @@ +[#track-panel-input-monitoring-auto] +==== Input monitoring auto + +image:generated/screenshots/elements/track-panel/input-monitoring-auto.png[Input monitoring auto, role="related thumb right"] + +Switches input monitoring to automatic mode. That means it will be on if the track is armed for recording and off if not. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-off.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-off.adoc new file mode 100644 index 000000000..c64d6e09c --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-off.adoc @@ -0,0 +1,6 @@ +[#track-panel-input-monitoring-off] +==== Input monitoring off + +image:generated/screenshots/elements/track-panel/input-monitoring-off.png[Input monitoring off, role="related thumb right"] + +Switches input monitoring for this track off. That means you will not hear what your play. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-on.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-on.adoc new file mode 100644 index 000000000..8bf4a174d --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring-on.adoc @@ -0,0 +1,6 @@ +[#track-panel-input-monitoring-on] +==== Input monitoring on + +image:generated/screenshots/elements/track-panel/input-monitoring-on.png[Input monitoring on, role="related thumb right"] + +Switches input monitoring for this track on. That means you will hear what you play. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring.adoc new file mode 100644 index 000000000..b326d4897 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-monitoring.adoc @@ -0,0 +1,6 @@ +[#track-panel-input-monitoring] +=== Input monitoring + +image:generated/screenshots/elements/track-panel/input-monitoring.png[Input monitoring, role="related thumb right"] + +Controls if and when the track input signal will be audible. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-type-indicator.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-type-indicator.adoc new file mode 100644 index 000000000..fb9790104 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input-type-indicator.adoc @@ -0,0 +1,8 @@ +[#track-panel-input-type-indicator] +=== Track input type indicator + +image:generated/screenshots/elements/track-panel/input-type-indicator.png[Track input type indicator, role="related thumb right"] + +This icon indicates whether the track reacts to MIDI or audio input. + +This should **not** be confused with a track type! Tracks in REAPER/Playtime don't have any type. A track can always **play** both audio and MIDI clips, no matter what's displayed here. The icon only refers to the current recording input! diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input.adoc new file mode 100644 index 000000000..52399bfe3 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/input.adoc @@ -0,0 +1,6 @@ +[#track-panel-input] +=== Track input + +image:generated/screenshots/elements/track-panel/input.png[Track input, role="related thumb right"] + +Lets you pick the hardware input of this track used for recording and input monitoring. This can be a MIDI or audio input. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/instrument-fx.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/instrument-fx.adoc new file mode 100644 index 000000000..95eb53382 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/instrument-fx.adoc @@ -0,0 +1,6 @@ +[#track-panel-instrument-fx] +=== Instrument FX + +image:generated/screenshots/elements/track-panel/instrument-fx.png[Instrument FX, role="related thumb right"] + +Shows the first instrument FX on this track. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/label.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/label.adoc new file mode 100644 index 000000000..26e67ff54 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/label.adoc @@ -0,0 +1,6 @@ +[#track-panel-label] +=== Track label + +image:generated/screenshots/elements/track-panel/label.png[Track label, role="related thumb right"] + +Displays the name of the column playback track. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/map-to-midi-channel.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/map-to-midi-channel.adoc new file mode 100644 index 000000000..98701fdb3 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/map-to-midi-channel.adoc @@ -0,0 +1,6 @@ +[#track-panel-map-to-midi-channel] +=== Map to MIDI channel + +image:generated/screenshots/elements/track-panel/map-to-midi-channel.png[Map to MIDI channel, role="related thumb right"] + +Allows you to route all incoming MIDI events to a specific MIDI channel at record time. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/midi-channel-filter.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/midi-channel-filter.adoc new file mode 100644 index 000000000..c200e4c2e --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/midi-channel-filter.adoc @@ -0,0 +1,6 @@ +[#track-panel-midi-channel-filter] +=== MIDI channel filter + +image:generated/screenshots/elements/track-panel/midi-channel-filter.png[MIDI channel filter, role="related thumb right"] + +Allows to listen to a specific MIDI channel only. Messages from other MIDI channels will be ignored. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/mute.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/mute.adoc new file mode 100644 index 000000000..e7af7f83f --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/mute.adoc @@ -0,0 +1,6 @@ +[#track-panel-mute] +=== Mute track + +image:generated/screenshots/elements/track-panel/mute.png[Mute track, role="related thumb right"] + +Mutes this track diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pan.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pan.adoc new file mode 100644 index 000000000..b5c5cb155 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pan.adoc @@ -0,0 +1,6 @@ +[#track-panel-pan] +=== Pan + +image:generated/screenshots/elements/track-panel/pan.png[Pan, role="related thumb right"] + +Changes the track panning. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-critical.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-critical.adoc new file mode 100644 index 000000000..7f8a2859c --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-critical.adoc @@ -0,0 +1,8 @@ +[#track-panel-pdc-critical] +==== Critical latency: 200ms + +image:generated/screenshots/elements/track-panel/pdc-critical.png[Critical latency: 200ms, role="related thumb right"] + +This track is affected by a very high latency, which Playtime compensates during playback. Input monitoring will be absolutely terrible because of high delays. Playback will not be optimal. + +Please note that Playtime is a live tool and therefore optimized for low latencies. It will do its best to deal with high latencies, but the experience might be less smooth. Consider turning off the offending FX if you want to use Playtime for jamming! diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-significant.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-significant.adoc new file mode 100644 index 000000000..9508ac556 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-significant.adoc @@ -0,0 +1,6 @@ +[#track-panel-pdc-significant] +==== Significant latency: 20ms + +image:generated/screenshots/elements/track-panel/pdc-significant.png[Significant latency: 20ms, role="related thumb right"] + +This track is affected by a significant latency, which Playtime compensates during playback. Input monitoring will probably not be too much fun because of the introduced delay. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-tiny.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-tiny.adoc new file mode 100644 index 000000000..0f146b010 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/pdc-tiny.adoc @@ -0,0 +1,6 @@ +[#track-panel-pdc-tiny] +==== Tiny latency: 5ms + +image:generated/screenshots/elements/track-panel/pdc-tiny.png[Tiny latency: 5ms, role="related thumb right"] + +This track is affected by a tiny latency, which Playtime compensates during playback. Input monitoring should be fine. diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/routing.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/routing.adoc new file mode 100644 index 000000000..2edb1d767 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/routing.adoc @@ -0,0 +1,6 @@ +[#track-panel-routing] +=== Track routing + +image:generated/screenshots/elements/track-panel/routing.png[Track routing, role="related thumb right"] + +Shows the REAPER routing window of this track diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/solo.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/solo.adoc new file mode 100644 index 000000000..b4bb83957 --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/solo.adoc @@ -0,0 +1,6 @@ +[#track-panel-solo] +=== Solo track + +image:generated/screenshots/elements/track-panel/solo.png[Solo track, role="related thumb right"] + +Soloes this track diff --git a/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/volume.adoc b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/volume.adoc new file mode 100644 index 000000000..c0860e88e --- /dev/null +++ b/doc/playtime/modules/ROOT/partials/generated/elements/track-panel/volume.adoc @@ -0,0 +1,6 @@ +[#track-panel-volume] +=== Track volume + +image:generated/screenshots/elements/track-panel/volume.png[Track volume, role="related thumb right"] + +Shows the track peaks and allows you to control the track volume. diff --git a/doc/realearn/modules/ROOT/pages/reaper-actions.adoc b/doc/realearn/modules/ROOT/pages/reaper-actions.adoc index 7afee07e8..065a3b7ed 100644 --- a/doc/realearn/modules/ROOT/pages/reaper-actions.adoc +++ b/doc/realearn/modules/ROOT/pages/reaper-actions.adoc @@ -1,29 +1,24 @@ = REAPER actions -ReaLearn provides some REAPER actions which become available as soon as at least one instance of ReaLearn is loaded. -It can be useful to put a ReaLearn instance on REAPER's monitoring FX chain in order to have access to those actions at all times. +ReaLearn provides the following REAPER actions in addition to the xref:helgobox::reaper-actions.adoc[general actions]. -In order to find these actions, open REAPER's _Actions_ menu, choose _Show action list…_ and simply search for -`realearn`. -The most important actions: - -ReaLearn: Find first mapping by source:: This action will ask you to touch some control element. +Helgobox/ReaLearn: Find first mapping by source:: This action will ask you to touch some control element. As soon as you touch a control element which is mapped, it will open the mapping panel for the corresponding mapping. It will search within all ReaLearn instances/units loaded in your current project as well as the ones on the monitoring FX chain. -ReaLearn: Find first mapping by target:: This action is similar to _Find first mapping by source_. +Helgobox/ReaLearn: Find first mapping by target:: This action is similar to _Find first mapping by source_. It asks you to touch some (learnable) REAPER parameter. As soon as you touch one that is mapped, it will open its mapping panel. -ReaLearn: Learn single mapping (reassigning source):: Asks you to touch a control element and target and adds a new mapping in the first ReaLearn unit that it encounters. +Helgobox/ReaLearn: Learn single mapping (reassigning source):: Asks you to touch a control element and target and adds a new mapping in the first ReaLearn unit that it encounters. It prefers units in the current project over monitoring FX. It automatically chooses the unit with the correct MIDI/OSC input. If there's a unit which already has that source assigned, it will be reassigned to the new target that you touched. -ReaLearn: Learn single mapping (reassigning source) and open it:: Like _Learn single mapping_ but additionally opens the mapping panel after having learned the mapping. +Helgobox/ReaLearn: Learn single mapping (reassigning source) and open it:: Like _Learn single mapping_ but additionally opens the mapping panel after having learned the mapping. This is great for subsequent fine-tuning. -ReaLearn: Learn source for last touched target (reassigning target):: This behaves similar to REAPER's built-in MIDI learn in that it always relates to the target that has been touched last. +Helgobox/ReaLearn: Learn source for last touched target (reassigning target):: This behaves similar to REAPER's built-in MIDI learn in that it always relates to the target that has been touched last. -ReaLearn: Send feedback for all instances:: Makes each ReaLearn instance/unit in all project tabs send feedback for all mappings. +Helgobox/ReaLearn: Send feedback for all instances:: Makes each ReaLearn instance/unit in all project tabs send feedback for all mappings. That shouldn't be necessary most of the time because ReaLearn usually sends feedback automatically, but there are situations when it might come in handy.