-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implements #3 Imported User Guide from Google Docs First pass on web based structure Added relevant screenshots First pass on content - What is XJ music? - How it Works - Installation - Getting Started - Making XJ music - Glossary - References - Authors --------- Co-authored-by: Charney Kaye <charneykaye@gmail.com>
- Loading branch information
1 parent
307f344
commit c169704
Showing
84 changed files
with
1,085 additions
and
52 deletions.
There are no files selected for viewing
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
+++ | ||
archetype = "chapter" | ||
title = "Authors" | ||
weight = 9 | ||
+++ | ||
|
||
**Charney Kaye** | ||
|
||
**Mark Stewart** | ||
|
||
**Jamal Whitaker** | ||
|
||
**Ian Hersey** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
+++ | ||
title = "Content Browser" | ||
weight = 20 | ||
+++ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
+++ | ||
title = "Fabrication" | ||
weight = 50 | ||
+++ | ||
|
||
In the Fabrication tab is where you can control the playback of your music. The Fabrication timeline is the command center of the XJ music workstation, offering precise control over your compositions. | ||
|
||
![Fabrication Timeline](fabrication-timeline.jpg) | ||
|
||
There are a number of [Fabrication Settings](/making-xj-music/fabrication/fabrication-settings) that can be modified to change the timeline behavior and audio output. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
+++ | ||
title = "Instrument Editor" | ||
weight = 40 | ||
+++ | ||
|
||
In XJ music, an instrument comprises a set of Instrument Audios. This section covers the importation of audio stems and the corresponding properties for uploaded audio. | ||
|
||
![Instrument Editor](instrument-editor.png) | ||
|
||
|
||
## Importing Audio | ||
|
||
Click the **Import Audio** button at the top right above the main Instrument window to open your file explorer and choose an audio file to upload. The fiile types currently supported are **.wav**, **.aiff**, and **.mp3**. Upon importing a new audio file, the user will be taken to the [**audio editor**](/getting-started/instrument-editor/#audio-editor). | ||
|
||
![Importing Audio](import-audio.png) | ||
|
||
|
||
## Audio Editor | ||
|
||
### Audio Properties | ||
|
||
The properties of the selected audio are listed in the side panel to the left of the waveform viewer and display the name, event, volume, tones, tempo, intensity level, and loop beats length. Underneath the main audio properties panel is a highlighted section containing the numeric value for the transient offset. | ||
|
||
### Open Audio Folder and Open Audio File | ||
|
||
The two icons in the bottom left of the Waveform Viewer will open the selected audio's folder and open the selected audio file, respectively. The audio's original filename is displayed to the right of the open selected audio icon. | ||
|
||
![Audio File Buttons](audio-file-buttons.png) | ||
|
||
### Setting a Transient Offset | ||
|
||
A Transient Offset is a floating integer that determines in measurements of seconds where the chosen audio will be starting from when its event is slated to trigger. The default transient offset is 0.0, indicating that the audio will start playing at the beginning of its file when triggered. A transient offset of 0.5 will include a pre-roll of 0.5 seconds and begin playing there. To set a transient offset, click the + symbol and place the new offset on the waveform in its window. You can also manuially enter the exact time in the Transient text field. | ||
|
||
### Waveform Viewer | ||
|
||
![Waveform Viewer](waveform-viewer.png) | ||
|
||
The waveform viewer component gives the user a graphical representation of the amplitude of selected audio over time, allowing the user to pinpoint peaks and valleys, monitor levels, and synchronize timing. | ||
|
||
Use the magnifying glass icons at the top left of the waveform viewer to zoom in and out. | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.69 KB
content/getting-started/program-editor/editing-macro-2-sequence-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
+++ | ||
title = "Program Editor" | ||
weight = 30 | ||
+++ | ||
|
||
The Program Editor allows you to edit music notation by placing Events within Patterns. | ||
|
||
There are different modes of editing available. The editor will automatically show the panels corresponding to the type of program you are currently editing: Macro Program, Main Program, Beat Program, or Detail Program. | ||
|
||
[Editing a Macro Program](#editing-a-macro-program) | ||
|
||
[Editing a Main Program](#editing-a-main-program) | ||
|
||
[Editing a Beat Program](#editing-a-beat-program) | ||
|
||
[Editing a Detail Program](#editing-a-detail-program) | ||
|
||
|
||
## Editing a Macro Program | ||
|
||
Each sequence of a macro program corresponds to a song a.k.a. main program that will be chosen. | ||
|
||
![Editing Macro Program](editing-macro-program.png) | ||
|
||
The content of a macro program sequence is irrelevant. We only use a sequence to store attributes such as tempo and intensity. For example, this is how tempo is driven. However, we are waiting on some software enhancements such as XJ Tempo Behavior v2 and a more user-friendly editor mode for macro programs. | ||
|
||
First, you’ll create some number of sequences containing attribute values for total, key, tempo, and intensity: | ||
|
||
![Sequence Bar](editing-macro-2-sequence-bar.png) | ||
|
||
Next, you’ll make sure to be in BIND mode (see the upper left corner) and then bind your sequences into some order. The bindings can have unique memes. | ||
|
||
![Bind Mode](editing-macro-3-bind-mode.png) | ||
|
||
|
||
## Editing a Main Program | ||
|
||
Main Programs contain musical notation describing chord progressions and voicings of those chords for various types of instruments. XJ will look for the chord progression/voicing combinations when the main program has been bound to a template and chosen during playback. | ||
|
||
![Editing a Main Program](editing-main-program.png) | ||
|
||
|
||
## Editing a Beat Program | ||
|
||
Beat programs utilize a grid system to graphically represent time, divided into equal segments and measured in bars. When editing a beat program, users place events on the grid by left-clicking within the timeline. To change the positioning, left-click and drag. | ||
|
||
With the snap option enabled, events will be dragged to the nearest grid line during placement and modifying duration. | ||
|
||
To extend or shorten the length of the event, bring your cursor to either side of the event, click and drag the edges. Double-clicking on an event brings up its event properties menu, which contains Tones, Velocity, Position, and Duration options. | ||
|
||
To delete an event, right-click the event and choose delete. | ||
|
||
![Editing a Beat Program](editing-beat-program.png) | ||
|
||
|
||
## Editing a Detail Program | ||
|
||
Detail programs utilize the same grid as Beat Programs, but to coordinate the position, duration, velocity, and notation of melodic events. | ||
|
||
![Editing a Detail Program](editing-detail-program.png) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
+++ | ||
title = "Project" | ||
weight = 10 | ||
+++ | ||
|
||
When you first open the XJ music workstation, no project is open. From the **Project** menu you can create a New Project, Open a Project, or clone one of the [Demo Projects](#demo-projects) to get started right away. | ||
|
||
|
||
## Demo Projects | ||
|
||
When first opening the XJ music workstation, the user will have the option of demoing four demo projects from our in-house artists: Bump, Slaps, Space, and The Hero’s Journey. These demos offer users a firsthand experience of the workstation’s capabilities as a platform and can inspire creativity in their own sessions. | ||
|
||
![Demo Projects](demo-projects.png?width=600px) | ||
|
||
To open a demo project, access the Project dropdown menu in the top left-hand side of the workstation, and choose Demos. Here you will find a list of four projects created by our team that will help you get acquainted with what the workstation can do. Select one and click OK to begin loading the project’s data, this could take a few minutes as you will be downloading the included audio files. | ||
|
||
[Click here](https://youtu.be/z5i8ZD8AyWE) for a video walkthrough! | ||
|
||
|
||
## View Menu | ||
|
||
| View Menu | Description | | ||
|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| Content (F3) | Switches to the Content tab. | | ||
| Templates (F4) | Switches to the Template tab. | | ||
| Fabrication (F5) | Switches to the Fabrication tab. | | ||
| Show Logs (F10) | Opens the Log window at the bottom of the Workstation, allowing the user to view the status and progress of ongoing processes. | | ||
| Logs Auto-scroll (Ctrl+F10) | Access tokens from the Lab are pasted here to establish a link between the XJ workstation and the Lab. | | ||
| Log Level | Allows the user to select which levels of information they will be shown in the logs. There are options to toggle Debug, Info, Warning, and Error logs on and off. | | ||
| Navigate | Allows you to navigate Back (Ctrl+ALT+←) and Forward (Ctrl+ALT+→) | | ||
|
||
|
||
## Help Menu | ||
|
||
| Help Menu Item | Description | | ||
|--------------------|------------------------------------------------------------------------------------------| | ||
| **About** | Displays the current version of the XJ music workstation. | | ||
| **Tutorial Video** | Open a walkthrough video to help you get started with a demo project. | | ||
| **User Guide** | Open the [User Guide](). | | ||
| **Discord** | Contains an invite link to the [XJ music Discord server](https://discord.gg/nbjHgD8xrn). | | ||
|
||
![About](about.png?width=400px) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
+++ | ||
archetype = "chapter" | ||
title = "installation" | ||
title = "Installation" | ||
weight = 3 | ||
+++ | ||
|
||
Downloads here | ||
Depending on your operating system, download the appropriate binary from https://xjmusic.com/download and follow the corresponding instructions: | ||
|
||
{{% children containerstyle="div" style="h3"%}} |
4 changes: 2 additions & 2 deletions
4
...tallation/linux-installation/_index.en.md → ...stallation/linux-installation/index.en.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
+++ | ||
categories = ["custom", "theming"] | ||
categories = ["installation"] | ||
title = "Linux Installation" | ||
weight = 5 | ||
+++ | ||
|
||
Debian/Ubuntu users simply install the .deb package to make the XJ music workstation available from the launcher. | ||
Debian/Ubuntu users simply install the .deb package to make the XJ music workstation available from the launcher. |
2 changes: 1 addition & 1 deletion
2
...ation/mac-installation-intel/_index.en.md → ...lation/mac-installation-intel/index.en.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.