mercury-engine 1.0.2 → 1.0.3

package/README.md

@@ -23,7 +23,7 @@ Mercury currently has 2 versions:
 
 [**💬 Join the Mercury Community on Discord**](https://discord.gg/vt59NYU)
 
-![The Mercury playground in the browser](media/screenshot.png)
+<!-- ![The Mercury playground in the browser](media/screenshot.png) -->
 
 # 🚀 Install
 
@@ -41,13 +41,23 @@ const Engine = new Mercury();
 
 ## Include in html
 
-Include latest or specific version of bundled es5 version through url in index.html 
+Include latest or a specific version of distribution (minified, es5) through url in script index.html 
+
+Recommended for most cases:
+
+```html
+<script src="https://unpkg.com/mercury-engine/dist/mercury.min.es5.js"></script>
+```
+
+Other options:
 
 ```html
-<script src="https://unpkg.com/mercury-engine@1.0.0/build/mercury.min.js"></script>
+<script src="https://unpkg.com/mercury-engine/dist/mercury.js"></script>
+<script src="https://unpkg.com/mercury-engine@1.0.0/dist/mercury.min.js"></script>
+<script src="https://unpkg.com/mercury-engine@1.0.0/dist/mercury.min.es5.js"></script>
 ```
 
-Use in a html `<script>` like so:
+Load the engine in the `<script>` code like so:
 
 ```js
 const { Mercury } = MercuryEngine;
@@ -55,60 +65,173 @@ const { Mercury } = MercuryEngine;
 const Engine = new Mercury();
 ```
 
+## Examples
+
+See the `examples` folder for a few `.html` files that demonstrate the usage. Run them locally by cloning this repository with `git clone https://github.com/tmhglnd/mercury-engine`. Then `cd mercury-engine` and run a simple http-server, for example with the `http-server` node package (install globally with `npm i -g http-server`). Navigate to `localhost:8080/examples` and try them out.
+
 # Usage
 
+### Include and initialize
+
+Include the package
+
 ```js
-// include the package
 const { Mercury } = require('mercury-engine');
+```
+
+Initialize the engine and include a callback function through { onload: }, this will be executed when samples are loaded.
 
-// initialize the engine and included a callback function
-const Engine = Mercury(() => {
-	console.log('This callback is called when samples are loaded!');
+```js
+const Engine = Mercury({
+	onload: () => {
+		console.log('This callback is called when samples are loaded!');
+	}
 });
+```
+
+### Resume, evaluate and silence
+
+Resume the transport and start the webaudio. This has to be done from a user interaction (click or keypress) to allow sound to play from the browser window.
+
+```js
+Engine.resume();
+```
 
-// resume the transport and start the webaudio
-// this has to be done from a user interaction (click/key) to allow sound
-// to play from the browser window
-Engine.resume()
+Evaluate a mercury code file by providing a string of code. This also resumes the transport if .resume() was not called yet.
 
-// Evaluate a mercury code file by providing a string of code
-// This also resumes the transport if .resume() was not called yet
+```js
 Engine.code(`
 	set tempo 100
 	new sample kick_909 time(1/4)
 	new sample hat_909 time(1/4 1/8) gain(0.6)
 	new synth saw note(0 0) time(1/16) shape(1 80)
 `);
+```
+
+Stop the transport and silence the audio
 
-// stop the transport and silence the audio
+```js
 Engine.silence();
+```
+
+Return the last succesfully evaluated code. If code is evaluated that resulted in an error it is not stored.
+
+```js
+Engine.getCode();
+```
+
+### Samples
+
+Add your own samples from for example a url like raw github or freesound. The url can also contain a .json file that references multiple samples and the sample name.
+
+```js
+Engine.addBuffers();
+```
 
-// start the recording of the sound
+Get the content of all the loaded Buffers, this is returned as a ToneAudioBuffers class
+
+```js
+Engine.getBuffers();
+```
+
+### Recording
+
+Start the recording of the sound
+
+```js
 Engine.record(true);
+```
 
-// returns 'started' if the recording is on
-Engine.isRecording()
+Returns 'started' if the recording is on
 
-// stop the recording and download the file myRecording.webm
+```js
+Engine.isRecording();
+```
+
+Stop the recording and download the file `myRecording.webm`
+
+```js
 Engine.record(false, 'myRecording');
+```
+
+### MIDI
+
+WebMIDI is included and started if the browser is compatible with it. If not, an error will be printed to the console. You can provide a callback function `onmidi` to execute some code when the WebMIDI enabling was succesful.
+
+```js
+const Engine = Mercury({
+	onmidi: () => {
+		console.log('The WebMIDI status is:', Engine.midi.status);
+		console.log('With inputs:', Engine.midi.inputs);
+		console.log('And outputs:', Engine.midi.outputs);
+	}
+});
+```
+
+### Settings
 
-// set the BPM without adding `set tempo` to the Mercury code
+Set the BPM without using `set tempo` in the Mercury code
+
+```js
 Engine.setBPM(140);
+```
+
+Set a randomized BPM
+
+```js
+Engine.randomBPM();
+```
+
+Set the volume without using `set volume` in the Mercury code. Volume in floating amplitude 0 to 1.
 
-// set the volume without adding `set volume` to the Mercury code
+```js
 Engine.setVolume(0.5);
+```
 
-// add your own samples from for example a url like raw github or freesound
-// the url can also contain a .json file that references multiple samples and 
-// the sample name
-Engine.addSamples();
+Set the crossFade between 2 code evaluations without using `set crossFade` in the Mercury code. Time in milliseconds.
+
+```js
+Engine.setCrossFade(500);
+```
+
+Set the HighPass Filter cutoff frequency without using `set highPass` in the Mercury code.
+
+```js
+Engine.setHighPass(400);
+```
+
+Set the LowPass Filter cutoff frequency without using `set lowPass` in the Mercury code.
+
+```js
+Engine.setLowPass(5000);
+```
+
+Get the value for any of the settings
+
+```js
+console.log(Engine.bpm);
+console.log(Engine.volume);
+console.log(Engine.crossFade);
+console.log(Engine.highPass);
+console.log(Engine.lowPass);
+```
+
+### Log function listener
+
+Logs that are important for the Mercury coder are also emitted as a custom event in the browser. You can create an event listener for `mercuryLog`. The `e.detail` contains the printed message. This can be used to for example print things to custom html elements instead of the javascript console.
+
+```js
+window.addEventListener('mercuryLog', (e) => {
+	let p = JSON.stringify(e.detail).replace(/\,/g, ' ').replace(/\"/g, '');
+	document.getElementById('logger').innerHTML += `${p}<br>`;
+	console.log('customprint:', e.detail);
+});
 ```
 
 ## 📋 To Do
 
 - [ ] Include OSC communcation options via socket.io
 - [ ] Use engine in the Mercury-playground instead of the other code-base
-- [ ] Create examples for the engine
 - [ ] Allow control of parameters via DOM elements
 
 ## 🔋 Powered By