P5LIVE

v 1.5.1
cc teddavis.org – 2019 - 2024
p5.js collaborative live-coding vj environment!

SHORTCUTS

P5LIVE (default)


`CTRL` + `ENTER`	softCompile
`CTRL` + `SHIFT` + `ENTER`	hardCompile
`CTRL` + `E`	editor toggle
`CTRL` + `N`	new sketch
`CTRL` + `SHIFT` + `C`	clone sketch
`CTRL` + `A`	autocompile toggle
`CTRL` + `,`	settings toggle
`CTRL` + `R`	references toggle
`CTRL` + `B`	chalkboard toggle
`CTRL` + `T`	tidy code
`CTRL` + `SPACE`	autocomplete
`CTRL` + `+`	increase fontsize
`CTRL` + `-`	decrease fontsize
`CTRL` + `S`	save png [ + code ]
`CTRL` + `1, 2, 3...0`	jump to first 10 sketches
`CTRL` + `SHIFT` + `⇡⇣`	jump to previous/next sketch
`CTRL` + `SHIFT` + `DELETE`	delete current sketch

Customize shortcut keys within the Settings panel

Ace Editor


`ALT` + `UP/DOWN`	shift lines up/down
`META` + `ALT` + `UP/DOWN`	duplicate lines up/down
`META` + `D`	delete line

(META = CMD on MacOS, CTRL on Windows/Linux)

GETTING STARTED

LIVE-CODE IN 3... 2... 1...

Create New Sketch or CTRL + N and start coding!
Live-coding active by default, CTRL + ENTER to force recompile.
Sketches are auto-saved to localStorage on every keystroke.

INSTALL

Online » p5live.org
Offline » github.com/ffd8/p5live (or see below for instructions)

SAVING

Sketches are ONLY saved in your browser's localStorage(!).
Export all () sketches + settings regularly.
Clearing browser history/data will likely erase all sketches + settings.

localStorage is unique and isolated per http[s] / domain / port,
so export/import all sketches to migrate between online / offline / browsers.
Simply use Settings Panel» Backup » Now to export all settings + sketches.

Automatic Backups

See Settings Panel » Backup to automatically export a P5LIVE backup file at varying intervals. If using Offline Server, it will save these backups to your P5LIVE/_backups folder rather than downloads.

About, 👋 you're reading me now.
Settings, adjust editor settings + shortcuts.
Reference, CTRL + R, toggle embeded p5.js reference.
Chalkboard, CTRL + B, toggle chalkboard over for annotations.
Visuals-only Popup, for projecting canvas output without code + interace.
Export, click to reveal sub-menu:

Save .png, CTRL + S, exports image [+ code if active in settings].
Share code as URL (links to online version at p5live.org).
Save .html, export single page website (re-link paths to any offline assets).

SETTINGS PANEL

Reset Settings to defaults
Import Settings
Export Settings

Options

Live Coding, [500ms], auto-compile error-free code on keyup, with set delay.
Console, display console messages, [auto/show] to hide or keep visible.
Eco Render, noLoop() if window loses focus (save computer resources).
Menu Tab, toggle menu tab. (hide if visible while VJ'ing).
Snapshot Code, export current code with each image snapshot.
Line Numbers, display code line numbers (and gutter features).
Recompile Pulse, flash compiled section of code.
Auto Autocomplete, useful for learning, or use CTRL + SPACE on demand.

SoniCode

Want to sonify your coding process?! Activate this toggle to generate sounds based on every keystroke (mapping keyCode to sample note). There are built in oscillators, however one can also select midi to send midi notes (channel 1) out to a DAW of choice for more complex samples.

Shortcuts

Customize keyboard shortcuts by clicking on name + press a new key combination.

Reset P5LIVE

Completely reset P5LIVE = deletes all sketches + settings!
Don't forget to export sketches first.

COCODING PANEL

See dedicated COCODING section below for details.

RECODING PANEL

See dedicated RECODING section below for details.

SKETCHES PANEL

New sketch.
Clone sketch, duplicates active sketch.
New folder, nest sketches/folders within others.
Import, select JSON files from export (single/folder/all).
Export, exports entire sketches list for import/backup.

Filter

Lost the overview of your sketches?
Type in keywords to match names of sketches and folders, filtering only those results. Use separate words for an and search, ie. 3d webgl text. To organize, add a new folder containing that word, and drag + drop items into it.

Optionally, toggle <> to search through source code of all sketches.

Sketch

Load Sketch, click on name.
Click on loaded sketch (green) to rename.
Hover to view contextual options
- Inspect, view/edit code as popup.
- Rename, give sketch new name.
- Export, export single sketch as JSON file.
- Remove, delete sketch after confirmation.
Sort, click + hold + drag to desired order.
Place in folder, slowly drag + drop into/over folder.

Folder

Expand/collapse Folder, click on name.
Hover to view contextual options
- Rename, give folder new name.
- Sub-folder, create a new folder within existing one.
- Export, export folder + contents as JSON file.
- Remove, delete folder + contents after confirmation.
Sort, click + hold + drag to desired order.

FEATURES

COMPILING

There are two modes of compiling in P5LIVE:

softCompile, CTRL + ENTER, (default) replaces changed functions (smooth refresh).
hardCompile, CTRL + SHIFT + ENTER, forces entire sketch to recompile.

Changes to global variables and setup()/preload() automatically perform a hardCompile since the entire sketch needs it. If your change only occurs within the draw() and custom functions (that aren't used in setup()), you should see a smooth transition. This is especially useful if using preloaded assets or drawing without a background during a performance, as it allows things to keep flowing. Classes are also softCompiled, but remember that each instance will still hold the old variables/methods, so replace each instance to see changes.

A recompile when nothing has changed (and live-coding active), triggers a hardCompile, which is useful for clearing the background or class instances.

If in doubt or not seeing changes, run a hardCompile, CTRL + SHIFT + ENTER.

frameCount, mouseX, mouseY are continous per recompile for smooth refreshes.

AUTOCOMPLETE

Custom autocomplete with p5.js functions and constants has been implemented!

To activate, enter the first few characters of a function and press CTRL + SPACE, then select function alone or with parameters. If selecting with parameters, use TAB to cycle through each one. Optionally activate Auto Autocomplete in the Settings to have suggestions on every keystroke.

The auto-compiler of live-coding pauses whenever the auto-complete panel is active.

If you forget the name of a function, simply view the p5.js references CTRL + R.

REFERENCES

After an overhaul, the built-in References, CTRL + R, now include nearly all information found on the official p5.js reference website, embedded for easy lookup while potentially VJ'ing... meta-visuals! Use the to surprise yourself and view a random reference.

Use Search... with keyup instant filtering to find functions you're after.
Separate words for an and search, ie. material light.
References keep full opacity once viewed, helping note which ones you've read.

Hover over functions for parameters tooltip, click to read the full detailed reference.

Beyond params and descriptions, the example's code is now embedded with js highlighting.

CHALKBOARD

Teaching a class with P5LIVE and need to explain a mathematical concept or highlight code?
Toggle a Chalkboard from the P5LIVE Panel or shortcut CTRL + B.

Use DRAWINGS pulldown to activate 1 of 10 isolated layers to draw on. All drawings remain until either pressing the 🗑️ clear button, DELETE key or refreshing the page. Toggle between ✏️ DRAW / 🔤 TEXT / 🧽 ERASE to do exactly that. In Text mode, DELETE removes one character at a time, allowing you to rubber-stamp text. Adjust COLOR, WEIGHT, OPACITY of the CHALK, separately adjust the COLOR and OPACITY of the board (background). This enables you to completely cover up the editor/visuals below for explaining concepts. Dim the BOARD if annotating or highlighting code (dim opacity of CHALK).

You can even access the drawings within your p5 sketch!

p5live.chalkboard() // grabs active drawing
p5live.chalkboard(#) // grab specific drawing (0 – 9)
p5live.chalkboard(frameCount * .25) // cycle all ten (% in backend!)

This drawing can then be displayed and played with as a manual drawing layer within your sketch:

image(p5live.chalkboard(), 0, 0);

For examples, see DEMOS » _CANVAS » _canvas_chalkboard + ..._animation

SNIPPETS

Snippets allow automatically adding chunks of code to your sketch within specific areas: global space, setup, draw – so you can quickly incorporate the necessary code for repeated workflows. Previously it was manually added to a .JSON file, but now there's a snippet editor built it!

Shortcuts

ALT + SHIFT + S, toggle Snippets Editor, create, modify.
CTRL + SHIFT + S, toggle Snippets Selector, apply.
Use arrow keys, tab, enter to apply snippets by keyboard only.

Default shortcut keys can be customized within Settings

Snippet Editor

Select snippet to edit or 'new' to create a new one
Apply selected snippet.
Clone snippet, ie, 'Save As...'.
Import an exported snippet.
Save changes to a custom shortcut.
Rename a custom shortcut.
Export a custom shortcut.
Delete a custom shortcut.

New Snippet

Toggle Snippets Editor.
Select 'new' to create a new snippet.
Add code within the global top, setup bottom, draw top, draw bottom, global bottom
Clone Snippet and give a custom name to save snippet.

Snippet Selector

Select snippet to apply.
Apply selected snippet.
Edit selected snippet.

When performing, this can be down entirely with the keyboard, CTRL + SHIFT + S to toggle the Snippet Selector, down/up arrowkey to select a preferred snippet, tab to move focus to the 'Apply Snippet' button, Enter to activate that button.

Ace Snippets

Ace Editor also has the ability to have autocomplete snippets of code blocks. To activate, type one out (can also use auto-complete to help you), then press tab. The following have been implemented (eventually this may also be easily customizable):

libs, inserts code for loading external libraries.
p5, adds p5 template incase removed
hydraonly, replace all code with this to only use hydra-synth
sandbox, adds //sandbox start/stop for eval hydra code
hy5, load HY5 library and sandbox for hydra code
hy5-p5-hydra, template for sending p5 into hydra
hy5-hydra-p5, template for sending hydra into p5
hy5-hydra-p5-x4, template for sending 4x hydra tex to p5
hy5-hydra-p5-x4-demo, demo for sending 4x hydra tex to p5

LIBRARIES

P5LIVE loads p5.js + p5.sound libraries by default. For additional libraries, load them remotely via CDN host or locally if running offline (ie. create /data/libs/). Can also be used within SyncData!

Add this snippet to the top of your sketch, placing one path per array item:

let libs = [
	""
	,""
];

p5 or p5.sound

To exclude libraries p5.js (ie. testing other versions) or p5.sound (ie. for Tone.js), add //no p5 or // no p5sound anywhere in your code.
See _audio_gen_tonejs demo for an example.

SANDBOX

Sometimes you want to adjust global JS code that won't cause p5.js to recompile, ie. hydra-synth. To do so, write such code within 2x // sandbox comments. Any changes within that space are processed using eval(), however won't trigger a P5LIVE hardCompile.

HYDRA

The main use case for this, is hydra-synth, which is included within the P5LIVE libs.
After importing the library, any changes made within the following tags:

// sandbox - start
osc().out() // ... your hydra code here
// sandbox - stop

– will only update the hydra-synth engine and won't effect p5.js recompiles!
See DEMOS » HY5 + DEMOS » _HYDRA for additional examples.

ASSETS

Loading custom assets (image/font/obj/audio/...):

Remotely from a CORS friendly server (imgbb/glitch.com images/videos, GitHub raw for ~anything)
loadImage('https://i.imgur.com/ijQzwsx.jpeg');
Locally, if running offline-mode create a /data folder
loadImage('data/images/fish.png'); (don't add anything to /includes!)

VIEW ONLY MODE

By special request (P5LIVE for remote meditation sessions?!), there's a view only mode, meaning everything is hidden (code + menu) and you'll only see the sketch running. Intended for COCODING sessions, where the admin can live-code while attendees enjoy and optionally interact with the visuals using their own mic or mouse. Anytime code is recompiled, the same happens here too. Add edit=0 to your URL:

COCODING, /?cc=*****&edit=0
Solo, /?edit=0

Similarly you can also use ?readonly=1, for a readonly editor.
Incase of exhibit, use ?exhibit=1, to disable links.

You can also load a sketch by URL (for media installation), just add sketch=name_of_sketch !
Example: _meta_P5LIVE

VISUALS-ONLY POPUP

Incase you want to project or stream the visuals-only (no code + interface) from P5LIVE, press within the P5LIVE Panel to launch a popup with a video feed of your P5LIVE canvas. Also great for PIP if running multiple instances of offline-mode.

EXPORT / IMPORT

Beyond exporting all sketches regularly (backup!) – you can export single sketches and/or entire folders (click the export icon next to their name). To re-import, click the import button in the Sketches panel or simply drag + drop the P5L_*****.js/P5L_*****.json into the browser. Single sketches are now imported and exported as plain .js for embedding anywhere.

See Settings Panel » Backup to automatically export a P5LIVE backup file at varying intervals.

PERFORMANCE

Lagging or retina display creates too large of a canvas?
Use pixelDensity(1); in setup() to prevent retina scaling.

MIDI/OSC

MIDI works online/offline and is implemented with webmidi.js
For example, demos/_input/_input_midi
OSC works offline.
For example, demos/_input/_input_osc and run Processing sketch, p5live_osc_setup
or use the OSC snippet (CTRL + SHIFT + O) and set host/in/out ports.

BUG/CRASH?!

Infinite loop? Broken code? P5LIVE now includes an infinite loop breaker, thus rendering previous tricks more or less obsolete... nevertheless, these may still be useful:

Add #bug to URL and press ENTER.
Stops compiler, loads a new sketch and opens inspector to fix issue and save.
Add #new to URL and press ENTER.
Loads a new sketch.
If the browser has completely hung, (rare [old] issue between MBP/Chrome/libraries)
sudo killall coreaudiod (first take off headphones + turndown stereo!)

Incase you need a loop to run more than 10000 times || 1 second,
add // noprotect anywhere in your code.
(except during COCODING sessions to protect peers)

EXTRA FUNCTIONS

Additional custom functions are available in P5LIVE sketches:

ease(inValue, outVariable, easeValue) smooth values.
println(foo) Compatibility with Processing.
windowResize() is set by default to keep your sketch fullscreen. To disable, add windowResized = null; in the setup() or overwrite with custom function.

COCODING

Use COCODING to code together friends locally and remotely! The code is synced while the visuals are rendered locally. If the remote server isn't working, please make an issue on Github!

COCODING PANEL DETAIL

Press to start a COCODING session and share new URL with friends.

COCODING ^{# of users - ⇡⇣ syncing up/down-stream.}
Exit, click the green 'power' button.
Clone sketch, saves current co-code to local sketches within session folder.
SyncData, custom code to sync local data (mouse, midi,...) with peers.
Lockdown (admin), limit editing, toggle write privledges per user.
Broadcast (admin + lockdown), sync mouseX/Y/frameCount/recompile with users.

Click on your name (very top) to select a new nickname and color.
If admin left, you'll have option within this panel to claim it.

Lockdown (user)

Request write-access, click edit button and wait for admin to allow.

Lockdown (admin)

Grant write-access, toggle requested write-access from glowing users.

Toggle write-access, admin can always toggle write access per user.

Chat

Within chat, links are parsed, ie. share sketch from p5.js editor.
Incoming chats displayed as notification (if active) when menu is hidden.

SyncData

launches SyncData window.

Use the SyncData window to send local data (as objects), by entering custom code that's executed locally in parallel to the shared COCODING session. Latest changes to the SyncData editor are stored in your local settings. Selecting a new preset replaces its contents, so use Save Preset to store anything long-term.

Presets

template guide for making your own.
mouseXY, facetracker + midi, shares those signals with others.
Be sure to enter unique userID's.
Save Preset for storing current SyncData editor (pre-existing name replaces it).
Remove Preset is available after selecting a custom preset.

Buttons

► RUN activates SyncData, injecting code at end of COCODE on each recompile.
► RE-RUN updates any changes made within SyncData editor.
↓ COCODE (admin) adds code following /* 2 - COCODE */ into COCODING session.
◼ STOP deactivates SyncData (stops adding local code to recompile).

When active, your own turns green, along with any user who is sending data.
Lockdown mode, suspends SyncData for all users, unless given write-access.

All data sent, uses parseData() in COCODING session to access it. Events can be fired immediately, or pass values to global vars for use within draw(). Furthermore you can use getData() within COCODING session, for unique local processing within your own SyncData window and code. See midi preset for use-case, where midiThru receives incoming signals and passes them onward to your own gear.

Be kind to your peers, keep data size and intervals within reasonable values.
Have fun COCODING with keyboards, EEG-headsets, eye-trackers, ....?!

RECODING

RECODING PANEL DETAIL

Press to start a RECODING session and record your live coding process.

RECODING PANEL

RECODING ^{#/# step of steps in recording.}
/ Pause/Continue recording.
/ Play/Pause playback.
Playback settings toggle.
Export recording.
Reset RECODING.
Slider to scrub between recorded steps.

PLAYBACK SETTINGS

Loop, repeat playback.
Max Gap, max time between keystrokes in seconds.
CatMode, any key presses next keystroke
Speed, overall playback speed

RECODING EXPLAINED

RECODING allows you to record, playback, scrub and share your live coding process! Simply press record and all changes to the editor are saved with timestamps as a temporary history. Pausing the recording, enables playback, which switches to the recoding sandbox within demos to prevent data loss on the active sketch. To save changes midway from a RECODING step, use the Clone Sketch button. Export your RECODING to share or playing back later. So long as the browser window is open, your history remains available until you press the Reset button, allowing you to start a new RECODING.

RECODING API

Dynamically load RECODING files via URL params for automated playback!
Booleans accept true/false or 1/0

?recoding=recoding_filepath.json
&loop=true
&gaps=true
&gapsmax=5
&speed=1
&menu=false
&editor=true
&catmode=false

ie. https://p5live.org/?recoding=includes/demos-data/recoding/demo.json&gaps=true&gapsmax=0.1

OFFLINE MODE

Install offline-mode to live-code without internet, load local assets, and communicate with software using OSC. Once installing offline-mode, you'll likely never need online-mode unless COCODING with remote peers (you can use offline COCODING with peers on local network!). If updating, just replace all contents within your existing folder (only store assets in your own /data folder or similar).

Download P5LIVE or Clone in Github Desktop
Install node.js + npm package (binary installers)
MacOS – open Terminal // Windows – open command prompt
type cd + SPACEBAR + drag/drop P5LIVE folder into window, press ENTER
type npm install, press ENTER
type npm start, press ENTER (for custom port: npm start ####)
P5LIVE is live! visit » http://localhost:5001
type CTRL + C, to stop server.

Port 5001 is now default since MacOS activated 5000 for AirPlay in 2021. If you've used P5LIVE offline in the past, start in a custom port, ie npm start 5000, do a complete backup from the Settings panel, then startup again with npm start and reimport that file for sketches and settings.

Alternatively, you can run multiple instances of P5LIVE offline (strange experiments galore!?) by adding any other port number to npm start command above, ie: npm start 5010. Remember P5LIVE sketches are stored in localStorage which is unique and isolated per domain:port.

HTTPS

If using offline server, you may want to COCODE with peers on the same local network or even remotely around the world. With p5.sound always enabled, a localhost or https connection is now required regardless of mic being active. While you access via localhost, all connected peers are simply http by default, therefore we can use an http-proxy to tunnel https traffic to our localhost!

Local (same network, works offline):

Start P5LIVE with npm start https, or custom port npm start #### https
HTTPS port is automatically 1 digit higher than P5LIVE (5000 » 5001).
Share https address displayed in Terminal, ie: https://xxxxx.local:5001
Connected peers must accept 'unsecure' (self-gen) certificate with Advanced button upon loading URL. Certificates are generative + cached, renewing after 60 days.
Enjoy offline local peers COCODING!

Remote (anyone across internet w/ ngrok!):

Especially useful for COCODING with your own assets within /data

Start P5LIVE offline server (see above)
Download ngrok
Open another tab in Terminal, cd to the folder containing ngrok
Type ./ngrok http 5000 and press ENTER (tunnels to localhost:5000)
Check output forwarding URL to share with remote peers (add COCODING channel):
https://**********.ngrok.io/?cc=*****
Enjoy offline remote peers COCODING!

TOOLS USED

P5LIVE is possible thanks to these amazing open-source projects.
Listed in order of adoption:

p5.js, magic
ace editor, code editor on top
peeredit / rga.js, syncing text for cocoding
socket.io, websockets for cocoding
sortablejs, drag + drop sorting of sketches/folders
beautify, tidy code in editor
pickr, color picker
tippy, tooltips
download.js, exporting html file
vex, custom dialog boxes
marked.js, parsing this readme into about
Roboto Mono, font
Feather Icons, gui icons
loading.io, css spinning intro loader
~~glitch.com, nodejs websocket hosting~~
node-osc, osc connection
WebMidi.js, midi connection
dropzone.js, drag + drop importing
mousetrap.js, custom shortcut key bindings
loadjs, in series loading of libs + sketch
highlight.js, higlighting of p5.js examples
http-proxy, https tunneling
pem, self-generated generative ssl certificates
FHNW, nodejs websockets cocoding-server
loop-breaker, inifinite-loop protection

INSPIRATION

cyril
Hydra

SOURCE

https://github.com/ffd8/p5live

Name		Name	Last commit message	Last commit date
Latest commit History 362 Commits
cocoding-server		cocoding-server
includes		includes
.gitattributes		.gitattributes
.gitignore		.gitignore
.htaccess		.htaccess
LICENSE		LICENSE
README.md		README.md
index.html		index.html
package.json		package.json
server.js		server.js
style.css		style.css

License

ffd8/P5LIVE

Folders and files

Latest commit

History

Repository files navigation

P5LIVE

SHORTCUTS

P5LIVE (default)

Ace Editor

GETTING STARTED

LIVE-CODE IN 3... 2... 1...

INSTALL

SAVING

Automatic Backups

MENU

P5LIVE PANEL

SETTINGS PANEL

Options

SoniCode

Shortcuts

Reset P5LIVE

COCODING PANEL

RECODING PANEL

SKETCHES PANEL

Filter

Sketch

Folder

FEATURES

COMPILING

AUTOCOMPLETE

REFERENCES

CHALKBOARD

SNIPPETS

Shortcuts

Snippet Editor

New Snippet

Snippet Selector

Ace Snippets

LIBRARIES

p5 or p5.sound

SANDBOX

HYDRA

ASSETS

VIEW ONLY MODE

VISUALS-ONLY POPUP

EXPORT / IMPORT

PERFORMANCE

MIDI/OSC

BUG/CRASH?!

EXTRA FUNCTIONS

COCODING

COCODING PANEL DETAIL

Lockdown (user)

Lockdown (admin)

Chat

SyncData

RECODING

RECODING PANEL DETAIL

RECODING EXPLAINED

RECODING API

OFFLINE MODE

HTTPS

Local (same network, works offline):

Remote (anyone across internet w/ ngrok!):

TOOLS USED

INSPIRATION

SOURCE

About

Resources

License

Stars

Watchers

Forks

Languages