Documentation
Learn Buhayin.
How to use the editor, page by page, and how to script it.
User guide
How to do each thing in the editor, from the first launch to the exported movie.
- Install and first launchGet Buhayin onto a Mac with Apple silicon, open it and accept the licence.
- The projects windowFind, open, make, rename, copy and trash projects.
- Your first sceneDraw, add a layer and a second drawing, hold it, play it, save it and export a movie.
- The workspaceViews, docks, workspaces and keyboard shortcuts, and how to change them.
- DrawingBrush, Pencil, Eraser and Paint, colours and palettes, vector and bitmap layers, onion skin.
- The Timeline and the XsheetCells, holds, keys and exposure, on the Timeline or typed into the Xsheet.
- Rigging a cut out characterPegs, pivots, hierarchy, drawing substitution and deformers.
- Animating a rigKeys, ease, the Function view and inverse kinematics.
- The Node view and effectsRead a scene as nodes and cables, add effects and see what feeds the picture.
- The camera and depthMove the camera, put layers at different depths and use the Perspective view.
- Sound and lip syncBring in sound, place clips, see the waveform and match mouths to speech.
- StoryboardingPlan a film as panels and shots, then play them as a timeline.
- ImportingBring in Harmony scenes, vector files, pictures, sound and movies.
- ExportingWrite movies, picture sequences, GIFs, sprite sheets and PDFs.
- Keyboard shortcutsThe default keys for tools, playback, the Timeline and the editor.
- TroubleshootingWhere your projects, recovery copies and the log are, and what to check first.
- The assistantAn optional assistant, off unless you connect one, and what Ask first holds back.
Scripting reference
Write small JavaScript programs that read and change a scene, and run Buhayin from the command line.
- ScriptingWhat scripts are, where to run them and what they can reach.
- Your first scriptWrite, run, check and save a script that reads the scene and changes it.
- Reading and editing the scenebuhayin.scene, node, attribute, context, drawing, bounds and edit, with undo groups.
- Geometry, matrices and coordinatesQueries on drawings, geometry calls, matrices, OGL conversion and the value classes.
- The editor: selection, tools, preferences and actionsWhat only the window holds, and the views and actions a script can add.
- Questions and dialogsAsk the animator a question or show a dialog of your own.
- Files, folders and programsbuhayin.file, buhayin.dir, buhayin.process and the limits on them.
- The scene file, renders and moviesSave the scene, render frames, write movies and cut a movie into pictures.
- Waypoints, deformation and pastingNode view waypoints, deformation matrices and copyPaste.
- Sample scriptsThe ten scripts that come with Buhayin and what each does.
- The command line toolbuhayin-cli: check, render, export, run a script and import from a terminal.