Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MAKIO135 committed Jul 13, 2019
1 parent 8dca77d commit d248425
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# Λioi

A companion app for [ORCΛ](https://wiki.xxiivv.com/#orca) using its [UDP operator](https://github.com/hundredrabbits/Orca#udp) to send complex OSC message to multiple hosts.
A companion app for [ORCΛ](https://wiki.xxiivv.com/#orca) using its [UDP operator](https://github.com/hundredrabbits/Orca#udp) to send UDP messages or complex OSC message to multiple hosts.

![Λioi](aioi.gif)

### Goals

## Goals
Λioi is an [ElectronJS](https://electronjs.org) application that intends to let you access the extra complexity you may need for ORCΛ to drive your applications. Λioi provides support for OSC messages with multiple parameters, types and to multiple hosts. Λioi helps you configure OSC hosts dynamically with a simple GUI and test your OSC messages.

### Install & Run

## Install & Run
You can download [builds](https://github.com/MAKIO135/aioi/releases) for **OSX, Windows and Linux**, or if you wish to run it from sources, follow these steps:
```
git clone https://github.com/MAKIO135/aioi.git
Expand All @@ -19,8 +16,7 @@ npm run start
```
You can also build it for your system using `npm run build_osx`, `npm run build_linux` or `npm run build_win`.

### Usage from ORCΛ

## Usage from ORCΛ
- specify **path**:
`;foo` in ORCΛ sends `/foo` to the first host in Λioi
`;bar` in ORCΛ sends `/bar` to the first host in Λioi
Expand Down Expand Up @@ -53,17 +49,16 @@ You can also build it for your system using `npm run build_osx`, `npm run build_
- send to **multiple hosts** at once:
`;2a#foo` in ORCΛ sends `/foo` to the third and tenth hosts in Λioi

- **host /path shortcuts**: (supports **complex paths**)
`;#1;2f` in ORCΛ sends `0.2` to the second host in Λioi with its path defined in Λioi
`;#a;yo;135` in ORCΛ sends `yo 135` to the tenth host in Λioi with its path defined in Λioi
- **host /complex/path shortcuts**: (supports **complex paths**)
Define your paths in the message inputs of your hosts in Aioi
`;#13;2f` in ORCΛ sends `0.2` to the second and fourth hosts in Λioi with their path defined in Λioi
`;#a2;yo;135` in ORCΛ sends `yo 135` to the tenth and third hosts in Λioi with their path defined in Λioi

#### Λioi does not support:

- negative values
- arrays

### Examples

Open [aioi_test.orca](https://github.com/MAKIO135/aioi/blob/master/aioi_test.orca) with ORCΛ and start [listener.js](https://github.com/MAKIO135/aioi/blob/master/listener.js) with NodeJS:

```
Expand All @@ -78,7 +73,6 @@ Tutorials for different platforms:
- [ORCΛ x Λioi x Veda](examples/veda/veda.md)

### Extra

This application supports the [Ecosystem Theme](https://github.com/hundredrabbits/Themes).
PR are welcomed.

Expand Down
Binary file modified aioi.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d248425

Please sign in to comment.