Skip to content

Commit

Permalink
repl: Rename remote_sclang for sclang_osc (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
munshkr committed Mar 26, 2020
1 parent 2af5eb4 commit 339028a
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,27 +167,27 @@ Use `flok-repl` with the `-t foxdot` parameter.
#### SuperCollider

In the case of SuperCollider, there are two types of REPLs: `sclang` and
`remote_sclang`. The first one tries to run a `sclang` process and interact
with it, while the second one uses
[FlokQuark](https://github.com/munshkr/FlokQuark) to communicate with SC. Read
`sclang_osc`. The first one tries to run a `sclang` process and interact with
it, while the second one uses [FlokQuark](https://github.com/munshkr/FlokQuark)
to communicate with SC. Read
[more](https://github.com/munshkr/FlokQuark/blob/master/README.md) for
installing and using it.


##### `sclang` vs. `remote_sclang`
##### `sclang` vs. `sclang_osc`

* As of today `sclang` does not currently work on Windows, you will have to use
`remote_sclang`.
`sclang_osc`.

* `remote_sclang` needs SC IDE to be running, and you need FlokQuark installed
* `sclang_osc` needs SC IDE to be running, and you need FlokQuark installed
and running there.

* If you use `remote_sclang`, you won't see Post messages from Flok, because
* If you use `sclang_osc`, you won't see Post messages from Flok, because
FlokQuark does not currently capture Post messages and errors. It is
recommended to deattach the Post window and have it visible while using Flok.

* `sclang` can't use any GUI object (like Scopes, Proxy mixers, etc.). You will
need to use `remote_sclang` + SC IDE for this.
need to use `sclang_osc` + SC IDE for this.


#### Hydra
Expand Down
4 changes: 2 additions & 2 deletions packages/repl/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { BaseREPL, BaseREPLContext, CommandREPL, CommandREPLContext } from './repl';
import TidalREPL from './repl/tidal';
import SclangREPL, { RemoteSclangREPL } from './repl/sclang';
import SclangREPL, { SclangOscREPL } from './repl/sclang';
import FoxDotREPL from './repl/foxdot';

const replClasses = {
default: CommandREPL,
tidal: TidalREPL,
sclang: SclangREPL,
remote_sclang: RemoteSclangREPL,
sclang_osc: SclangOscREPL,
foxdot: FoxDotREPL,
};

Expand Down
4 changes: 2 additions & 2 deletions packages/repl/src/repl/sclang.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class SclangREPL extends CommandREPL {
}
}

class RemoteSclangREPL extends BaseREPL {
class SclangOscREPL extends BaseREPL {
udpPort: UDPPort;
port: number;
started: boolean;
Expand Down Expand Up @@ -92,5 +92,5 @@ class RemoteSclangREPL extends BaseREPL {
}
}

export { SclangREPL, RemoteSclangREPL };
export { SclangREPL, SclangOscREPL };
export default SclangREPL;

0 comments on commit 339028a

Please sign in to comment.