GNU Rocket OpenGL editor

Beta Disclaimer

First a screenshot of how it looks:

Regular disclaimer: Backup your stuff before using the software :)

If you encounter any issues please try to report them at https://github.com/emoon/rocket/issues as this would make my life much easier and I will try to fix them given time. Hopefully the editor is useful even if still not 100% finalized bug wise. Also the documentation hasn't been completed yet.

Download the latest release from the Releases page.

See CHANGELOG.md for version history.

About

RocketEditor is coded by Daniel 'emoon' Collin with documentation and testing by Heine 'bstrr' Gundersen. Daniel Collin can be contacted at daniel aat collin dot com

Latest version of this program should be available at https://github.com/emoon/rocket

The SDL-based linux support is written by Konsta 'sooda' Hölttä at https://github.com/sooda/rocket, and later updated to use SDL2 by Lauri 'gustafla' Gustafsson at https://github.com/gustafla/rocket

Motivation

At Revision 2012, Heine 'bstrr' Gundersen and I started talking about how having an editor for GNU Rocket that worked on macOS would be great, as we both used Mac as our primary development platform. This was the start of another version of the editor. I (Daniel 'emoon' Collin) also wanted some features that weren't in the old editor (such as folding of tracks, having it cross platform, etc) Some small work was started on the editor during spring and summer of 2012 but not much happened. It was really during autumn 2012 that I started to work on it for real to get the features I wanted.

Features:

• Includes (or should at least :) all features from the old editor (except track re-arrangement)
• More optimized for laptop keyboards (no usage of page up/down and similar keys)
• Group support. It's now possible to group tracks together that makes sense (maybe a group for each part). The syntax for this is to name the tracks "mygroup:mytrack"
• Folding support for both groups and tracks. Something I found annoying in the old editor was that you had to scroll around quite a bit to get to the track you wanted. Now with folding you use the screen space better.
• Faster navigation: Can jump between key values, jump in step of 8 and also with bookmarks.
• Other features such as using more of the keyboard for biasing of values (see key layout below)
• Trackpad support (macOS only, mouse wheel elsewhere) to scroll around (can only be used with biasing)
• Cross platform. Read more about the code in the next section.
• Navigation during playback. It's now possible to jump forward/backward when playing the demo (demo "scratching")
• Fast way to insert a interpolated value by just pressing return on an empty row.
• Experimental support for multiple Rocket clients for uses like synchronizing music trackers with RocketEditor (see schismtracker/schismtracker#353)

Building the code

RocketEditor uses CMake as its build system on all platforms.

macOS

git clone --recursive https://github.com/emoon/rocket
cd rocket
mkdir build && cd build
cmake ..
cmake --build .
open RocketEditor.app

To generate an Xcode project:

cmake -G Xcode ..

Windows

Using Visual Studio (2019 or later recommended):

git clone --recursive https://github.com/emoon/rocket
cd rocket
mkdir build && cd build
cmake ..
cmake --build . --config Release

Or open the generated solution in Visual Studio:

cmake -G "Visual Studio 17 2022" ..
start RocketEditor.sln

Linux

Install dependencies (Ubuntu/Debian):

sudo apt-get install libsdl2-dev libgtk-3-dev cmake build-essential

Build:

git clone --recursive https://github.com/emoon/rocket
cd rocket
mkdir build && cd build
cmake ..
cmake --build .
./RocketEditor

Tips & tricks

• Fold away tracks or groups you are not currently working with using Alt+Left/Right and Ctrl+Alt+Left/Right

• Use Return to insert current interpolated value - also sets the interpolation type to what the previous key uses.

• A good way of bundling parameters for effects is by naming your tracks 'groupname:trackname', as this will group them together, thus making better tracknames than "logo-x-pos", "logo-y-pos", "title-x-pos", "title-y-pos". Groups can also be folded, so they don't take up screen real estate when you are working on a different part of the demo.

• Insert bookmarks using the B key to easily jump between parts in the demo.

• To rename a track (or add it to a group), close the editor and open the .rocket xml file, which should be nicely formatted. Locate the track and rename it - then rename it in your demo.

• Bias using Alt+trackpad/scrollwheel. Add the Shift-key to bias even faster.

• Use selection to bias multiple keys - even across multiple tracks!

Keys

macOS:

Editing:

Key	Action
0-9	Edit value
Esc	Cancel edit
QWERTY	Bias selection +0.01, +0.1, +1, +10, +100, +1000
ASDFGH	Bias selection -0.01, -0.1, -1, -10, -100, -1000
Shift+QWERTY	Scale selection 1.01, 1.1, 1.2, 5.0, 10.0, 100.0
Shift+ASDFGH	Scale selection 0.99, 0.9, 0.8, 0.5, 0.1, 0.01
Alt+Trackpad scroll	Bias selection +1/-1
Shift+Alt+Trackpad	Bias selection +10/-10
I	Toggle interpolation (step/linear/smooth/ramp)
Cmd+I	Invert selection
Return	Insert current interpolated value
Shift+Arrows	Select
Cmd+T	Select all keys in track
Cmd+X	Cut
Cmd+C	Copy
Cmd+V	Paste
C	Move selection up
X	Move selection down
Cmd+Z	Undo
Cmd+Shift+Z	Redo
Delete	Delete key
K	Offset track +1
Cmd+K	Offset track +8
L	Offset track -1
Cmd+L	Offset track -8
Shift+K	Offset group +8
Shift+L	Offset group -8
M	Mute/Unmute track

View:

Key	Action
Space	Start/Stop
Ctrl+Space	Start Loop Playback
Arrows	Move cursor around
Alt+Up/Down	Jump 8 rows
Page Up/Down	Jump 16 rows
Alt+Cmd+Up/Down	Jump to StartRow/NextBookmark - PrevBookmark/EndRow
Cmd+Left/Right	Scroll view Left/Right
Ctrl+Up/Down	Jump to Previous/Next key in current track
Alt+Left/Right	Fold/Unfold track
Ctrl+Alt+Left/Right	Fold/Unfold group
Trackpad scroll	Scroll
B	Toggle Bookmark
Cmd+B	Clear all Bookmarks
Z	Toggle Loopmark
Shift+Z	Clear all Loopmarks
Tab	Jump between Row, Start Row, End Row, Track editing

Files:

Key	Action
Cmd+O	Open file
Cmd+S	Quicksave
Cmd+Shift+S	Save as
Cmd+1/2/3/4	Quickload recent files
Cmd+E	Remote export
Cmd+L	Load Music

---

Windows and Linux:

Editing:

Key	Action
0-9	Edit value
Esc	Cancel edit
QWERTY	Bias selection +0.01, +0.1, +1, +10, +100, +1000
ASDFGH	Bias selection -0.01, -0.1, -1, -10, -100, -1000
Shift+QWERTY	Scale selection 1.01, 1.1, 1.2, 5.0, 10.0, 100.0
Shift+ASDFGH	Scale selection 0.99, 0.9, 0.8, 0.5, 0.1, 0.01
I	Toggle interpolation (step/linear/smooth/ramp)
Ctrl+I	Invert selection
Return	Insert current interpolated value
Shift+Arrows	Select
Ctrl+T	Select all keys in track
Ctrl+X	Cut
Ctrl+C	Copy
Ctrl+V	Paste
C	Move selection up
X	Move selection down
Ctrl+Z	Undo
Ctrl+Shift+Z	Redo
Delete	Delete key
K	Offset track +1
Ctrl+K	Offset track +8
L	Offset track -1
Ctrl+L	Offset track -8
Shift+K	Offset group +8
Shift+L	Offset group -8
M	Mute/Unmute track

View:

Key	Action
Space	Start/Stop
Ctrl+Space	Start Loop Playback
Arrows	Move cursor around
Alt+Up/Down	Jump 8 rows
Page Up/Down	Jump 16 rows
Ctrl+Alt+Up/Down	Jump to StartRow/NextBookmark - PrevBookmark/EndRow
Ctrl+Left/Right	Scroll view Left/Right
Ctrl+Up/Down	Jump to Previous/Next key in current track
Alt+Left/Right	Fold/Unfold track
Ctrl+Alt+Left/Right	Fold/Unfold group
Trackpad scroll	Scroll
B	Toggle Bookmark
Ctrl+B	Clear all Bookmarks
Z	Toggle Loopmark
Shift+Z	Clear all Loopmarks
Tab	Jump between Row, Start Row, End Row, Track editing

Files:

Key	Action
Ctrl+O	Open file
Ctrl+S	Quicksave
Ctrl+Shift+S	Save as
Ctrl+1/2/3/4	Quickload recent files
Ctrl+E	Remote export
Ctrl+L	Load Music