diff --git a/README.md b/README.md index 8262f20..c33dbac 100644 --- a/README.md +++ b/README.md @@ -30,4 +30,4 @@ The music is played live with the same Logitech Guitar controller, but using the https://github.com/user-attachments/assets/12c69505-3887-4a6f-af7a-124bebd15741 # How to use -See [Quick Start](QUICK-START.md) \ No newline at end of file +See [Quick Start](USER-GUIDE.md) \ No newline at end of file diff --git a/QUICK-START.md b/USER-GUIDE.md similarity index 96% rename from QUICK-START.md rename to USER-GUIDE.md index 556b2e0..c3e273c 100644 --- a/QUICK-START.md +++ b/USER-GUIDE.md @@ -1,5 +1,4 @@ -# Quick Start -## Introduction +# Introduction Orina Ayo work best with in desktop mode with a Logitech Guitar Hero Controlller or a LiberLive C1. If you do not have a guitar controller nor a keyboard midi controller, you can still use a wireless numeric keypad or the numeric keypad of your desktop computer. See supported devices below for more details. Also note that Gamepad compatible guitar controllers like the PDP Riff Master or the Logitech Guitar hero have been tested from a desktop computer. On mobile phones, only Bluetooth midi controllers or guitars like LiberLive C1 amd Lava Genie have been tested with OrinAyo. @@ -8,7 +7,7 @@ When OrinAyo works in standalone mode and not controlling an external arranger d If you are using a Bluetooth guitar controller like LiberLive C1 or Lava Genie, you must first give the web browser (Chrome or Edge) permission to acces these devices. See section on Bluetooth below for more details. -## Install +# Install Orinayo can be setup and accessed as follows: - Type https://jus-be.github.io/orinayo/index.html into a Chrome or Edge browser to use it directly from a web page. @@ -16,6 +15,15 @@ Orinayo can be setup and accessed as follows: - Install it as a browser extension for Google Chrome and Microsoft Edge from https://chromewebstore.google.com/detail/orinayo/mhnemaeacdgnkmoibfeodelijegakklp - On Windows 10+ desktops, download orinayo.exe and run it directly from a desktop. It loads the above web page using webview2. See https://github.com/jchv/go-webview2. If you are using Windows 10+, the WebView2 runtime should already be installed. If you don't have it installed, you can download and install a copy from Microsoft's website - https://developer.microsoft.com/en-us/microsoft-edge/webview2/ +# Description +To use the application, you select a number of features you need, click on an action and watch the status display. For example, select web audio as your arranger type, select a web audio chord loop, click on play and watch the chords being displayed as you press the buttons of your guitar controller. + +To prevent un-desired results, make sure that unused and uneeded features are set to **NOT USED* + +The application views are roughly divided into three sections. +- Feature Selections +- Action buttons +- Status displays ## Desktop View @@ -23,7 +31,6 @@ Orinayo can be setup and accessed as follows: ## Mobile view -# Features Description ## 1 - The application logo/icon Clicking on this toggle between mobile view and desktop views as shown above. Mobile view gives you simple straightforward access to live playing of audio loop styles with a guitar controller or a numeric keypad. Desktop view gives you access to evrything else. diff --git a/docs/quick_start.html b/docs/help.html similarity index 87% rename from docs/quick_start.html rename to docs/help.html index b4e3ea7..c42c44e 100644 --- a/docs/quick_start.html +++ b/docs/help.html @@ -13,15 +13,12 @@
-

Quick Start

-

Install

+

Introduction

Orina Ayo work best with in desktop mode with a Logitech Guitar Hero Controlller or a LiberLive C1. If you do not have a guitar controller nor a keyboard midi controller, you can still use a wireless numeric keypad or the numeric keypad of your desktop computer. See supported devices below for more details.

Also note that Gamepad compatible guitar controllers like the PDP Riff Master or the Logitech Guitar hero have been tested from a desktop computer. On mobile phones, only Bluetooth midi controllers or guitars like LiberLive C1 amd Lava Genie have been tested with OrinAyo.

When OrinAyo works in standalone mode and not controlling an external arranger device via MIDI and generating all the music internally from WebAudio, you would need a high spec PC or mobile phone like an Intel iCore 7 or Apple M series laptop or a Samsung S25 spec type mobile phone.

If you are using a Bluetooth guitar controller like LiberLive C1 or Lava Genie, you must first give the web browser (Chrome or Edge) permission to acces these devices. See section on Bluetooth below for more details.

+

Install

Orinayo can be setup and accessed as follows:

+

Description

+

To use the application, you select a number of features you need, click on an action and watch the status display. For example, select web audio as your arranger type, select a web audio chord loop, click on play and watch the chords being displayed as you press the buttons of your guitar controller.

+

To prevent un-desired results, make sure that unused and uneeded features are set to *NOT USED

+

The application views are roughly divided into three sections.

+

Desktop View

Mobile view

-

Features Description

1 - The application logo/icon

Clicking on this toggle between mobile view and desktop views as shown above. Mobile view gives you simple straightforward access to live playing of audio loop styles with a guitar controller or a numeric keypad. Desktop view gives you access to evrything else.

2 - Guitar Strum

@@ -520,7 +529,23 @@

Program Change Messages (PC)

9 - MIDI Out

Select a device from this list only if you plan to control an external arranger or looper device by OrinAyo. See External Hardware above for more details.

-

You will need to pre-configure the device and enable it to receive MIDI chord note messages on channel 4.

+

You will need to pre-configure the device and enable it to receive MIDI chord note messages on channel 4.
+

+

10 - MIDI Synth

+ +

If you want to use an external MIDI device to play the keyboard pads voice instead of the internal WebAudio sampler voice , then select it from here. The keyboard pads voice is a synth type voice played with the current active chord. By default it is the GM voice 90 called warm pads. For more details. see feature #24 below.
+

+

11 - RealGuitar Out

+ +

If you want to use any of the soft guitar products from MusicLabs like RealGuitar, RealLPC, RealStrat, etc instead of the internal WebAudio guitar in OrinAyo, then you would need a virtual MIDI device like loopMIDI configured for sending the MIDI messages. Select a device from this pulldown list.

+
+

12 - RealGuitar Strum

+ +

If you want to play a MIDI based guitar strum loop pattern with the internal guitar or with an external guitar like RealGuitar or RealLPC, then use this to select on the patterns provided.

+

Select Internal Guitar to use the internal WebAudio guitar and use the next and previous style variation controls to cycle through the provided strum patterns.

+

Toggle start action button to start and stop the strum pattern loop. The strum will play to the currently set tempo. Please note that this feature cannot be used with a music style. Make sure no style is selected when using this to prevent unexpected results.

+
+

13 - Audio Device In

diff --git a/docs/index.html b/docs/index.html index 73dfc90..e35e4ce 100644 --- a/docs/index.html +++ b/docs/index.html @@ -97,6 +97,7 @@

Bass

Refresh + Help
Tempo:100 diff --git a/docs/js/main.js b/docs/js/main.js index 5037a7c..d7601c4 100644 --- a/docs/js/main.js +++ b/docs/js/main.js @@ -2116,6 +2116,10 @@ async function onloadHandler() { window.addEventListener("gamepadconnected", connectHandler); window.addEventListener("gamepaddisconnected", disconnectHandler); + document.querySelector('#help').addEventListener("click", () => { + window.open("./help.html", "user-guide"); + }); + document.querySelector('#giglad').addEventListener("click", () => { setTimeout(() => outputSendControlChange (85, 127, 4), 10000); // FADE IN setTimeout(() => outputSendControlChange (86, 127, 4), 20000); // FADE OUT