Skip to content

Commit

Permalink
Show info about the editor commands in the liveshell.
Browse files Browse the repository at this point in the history
  • Loading branch information
stuaxo committed May 3, 2016
1 parent d0c4f67 commit 0268b60
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions doc/source/interfacing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ Once it's running it's easy to connect with telnet:

$ telnet 127.0.0.1 7777

As well as setting and listing variables in the variables window, you can
do things like go to a particular frame.
This gets you into the shell, where you can use commands to list and
set variables, rewind and go to frames.

Useful commands include:

goto load_base64 pause play restart rewind speed title vars
Commands
~~~~~~~~


Playback Commands
Expand All @@ -72,11 +72,16 @@ Useful commands include:
================== ======================================


Other

Enter help to see which commands are available.
================== ======================================
Command Description
================== ======================================
help Show list of all commands
================== ======================================


Socket server eamples are available in examples/socketserver
Socket server examples are available in examples/socketserver


Editors/IDEs and the live shell
Expand All @@ -91,7 +96,22 @@ To experiment with the livecoding shell, run an example with the -l option

$ sbot -wl examples/animation/hypnoval.bot

Enter help to see which commands are available.
This has all the commands that the socket server has, and extra commands
that can be useful for an editor or IDE.


Commands
~~~~~~~~

Live Shell Commands

================== ==============================================
Command Description
================== ==============================================
quit quit shoebot
load_base64 used by IDE/Editor to send new code to Shoebot
================== ==============================================



Embedding
Expand Down

0 comments on commit 0268b60

Please sign in to comment.