Skip to content

Commit

Permalink
First draft content (#6)
Browse files Browse the repository at this point in the history
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
JamalWhitaker and charneykaye committed May 16, 2024
1 parent 307f344 commit c169704
Show file tree
Hide file tree
Showing 84 changed files with 1,085 additions and 52 deletions.
File renamed without changes.
5 changes: 0 additions & 5 deletions content/appendix-a/_index.en.md

This file was deleted.

5 changes: 0 additions & 5 deletions content/appendix-b/_index.en.md

This file was deleted.

13 changes: 13 additions & 0 deletions content/authors/index.md
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**
18 changes: 17 additions & 1 deletion content/getting-started/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,20 @@
archetype = "chapter"
title = "Getting Started"
weight = 4
+++
+++

When you first open the XJ music workstation, you'll see this empty space, because no project is open.

![XJ music workstation first opens](xj-workstation-opening.png)

## Projects


## Content

In the Content section of the workstation, you will see the [Content Browser](/getting-started/content-browser/) which lists
all the the [Libraries](/making-xj-music/libraries/) in the current project. Inside of each Library
is a list of [Programs](/making-xj-music/programs/) and [Instruments](/making-xj-music/instruments/).

Open a program to edit it in the [Program Editor](/getting-started/program-editor/)
or open an instrument to edit it in the [Instrument Editor](/getting-started/instrument-editor/)
4 changes: 4 additions & 0 deletions content/getting-started/content-browser/index.en.md
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.
10 changes: 10 additions & 0 deletions content/getting-started/fabrication/index.en.md
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.
42 changes: 42 additions & 0 deletions content/getting-started/instrument-editor/index.en.md
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.
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.
60 changes: 60 additions & 0 deletions content/getting-started/program-editor/index.en.md
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)
Binary file added content/getting-started/project/about.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.
42 changes: 42 additions & 0 deletions content/getting-started/project/index.en.md
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.
146 changes: 145 additions & 1 deletion content/glossary/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,148 @@
archetype = "chapter"
title = "Glossary"
weight = 7
+++
+++

**Composition**
Artistic musical production showing study and care in arrangement. The act of composition is the process of forming a whole or integral, by placing together and uniting different parts.

**Artist (Musician)**
A skilled practitioner in the art of composition and/or performance of music.

**Engineer**
Person skilled in the principles and practice of music technology, including but not limited to audio engineering, and the operation of musical generation systems.

**Digital Audio Workstation (DAW)**
Electronic device or software application used for recording, editing and producing audio files.

**Audio Signal (audio data, audio sample, signal, audio, or sample)**
Information that represents audible sound, such as a digital recording of a musical performance, persisted in a file on a computer.

**Generation**
A process by which data is created, including but not limited to recording the output of a microphone or performing complex mathematical operations.

**Modulation**
A process by which data is modified in such a manner as to alter at least some property, including but not limited to the amplitude, frequency, phase, or intensity of an audible signal.

**Configuration (config)**
The arrangement or set-up of the hardware and software that make up a computer system.

**Audio channel (audio track, track, or channel)**
A single stream of audio data. Optionally, two or more channels may be played together in a synchronized group. For example, stereo output is comprised of a left channel and a right channel.

**Audio composition (audio mixing or mixing)**
The process of forming new audio by placing together and uniting at least two source audio samples or channels. In the process, each source audio sample may be modulated such as to best fit within the composition of the final audio output.

**Audio mixer (or mixer)**
An apparatus used to perform audio mixing.

**Audio event**
An event which occurs at a specific position in time within a piece of recorded audio.

**Metadata**
Information describing musical properties, including but not limited to events, selections, notes, chords, or the arrangement of audio samples.

**Series**
Two items succeeding in order.

**Next**
Being nearest in time, or adjoining in a series. In an empty series, the next item would be the initial item added to the series.

**Terminus**
Either the initial or final item in a series.

**Static**
Having a permanently constant nature.

**Dynamic**
Having a changing or evolving nature.

**Permutation**
The arrangement of any determinate number of things, in all possible orders, one after the other.

**Note**
A musical sound, a tone, an utterance, or a tune. It may refer either to a single sound or its representation in notation.

**Pitch**
The frequency of vibrations, as in a musical note. The exact pitch of notes has varied over time, and now differs between continents and orchestras.

**Interval**
The distance in pitch between two notes. The violin, for example, is tuned in intervals of a fifth (G to D, D to A and A to E), the double bass in fourths (E to A, A to D and D to G).

**Harmonic intervals**
The distance between two notes which occur simultaneously, as when a violinist tunes the instrument, listening carefully to the sound of two adjacent strings played together.

**Melodic intervals**
The distance between two notes played in series, one after the other.

**Chord**
At least two notes played simultaneously at harmonic intervals.

**Scale**
At least two notes played in series at melodic intervals.

**Musical event**
An action having been, or intended to be performed by a musical instrument, beginning at a specific moment in time, continuing for some amount of time, having characteristics including but not limited to chord, pitch, or velocity.

**Harmonic event**
A single occurrence of an action having been, or intended to be performed by a harmonic instrument.

**Melodic event**
A single occurrence of an action having been, or intended to be performed by a melodic instrument.

**Harmonic progression**
The placement of chords with relation to each other such as to be musically correct and emotionally evocative.

**Key (root key or key signature)**
A musical composition indicating the scale to be used, and the key-note or home-note. Generally, a musical composition ends—evoking resolve—on the chord matching its key. The key of a musical composition determines a context within which its harmonic progression will be effective.

**Voice**
A single identity within a musical composition, such as might be performed by a single musical instrument. A voice is either percussive, harmonic, or melodic.

**Voice event**
A single occurrence of an action having been, or intended to be performed by a single voice of a musical composition. An event has musical characteristics, representing a particular note or chord.

**Song**
A musical composition containing a beginning, a middle, and an end.

**Section**
A distinct portion of a musical composition.

**Partial musical composition (part)**
A subset of a complete musical composition, such as to be interchangeable with other subsets of other compositions.

**Composite music**
A work of musical art created dynamically from distinct parts or elements, distinguished from traditional recorded music, which is mastered and finished statically as a deliverable record.

**Aleatoric music (music composed “aleatorically”)**
Music in which some element of the composition is left to chance, and/or some primary element of a composed work's realization is left to the determination of its performer(s).

**Program (musical program or main program)**
A partial musical composition comprising or consisting of a progression of chords and corresponding musical events output of said related thereto and/or represented by stored musical notations for the playback of instruments. A program is comprised of at least some section representing a progression of musical variation within the program.

**Composite musical program**
An integral whole musical composition comprised of distinct partial musical programs.

**Macro Program**
This is like a playlist. Musical notation describing the order in which to play Main Programs.

**Main Program**
This is like a song. Musical notation describing chord progressions and voicings of those chords for various types of instruments.

**Beat Program**
This describes a beat. XJ chooses one beat for an entire song (Main Program). This musical notation is used directly for a Drum Instrument to play. The beat is also used to make choices about other arrangements.

**Detail Program**
This is writing down the rhythm of a part for one instrument to play, in a way that may be interpreted by XJ in for any song according to its chord voicings. The most atomic and portable sort of partial musical composition, and is intended to be utilized wherever its musical characteristics are deemed fit.

**Instrument**
A collection comprising or consisting of audio samples and corresponding musical notation related thereto and/or represented by stored audio data for playback.

**Library**
A collection consisting or comprising of both programs and instruments, embodying a complete artistic work, being musical composition which is intended by the artist to be performed autonomously and indefinitely without repetition, by way of the present disclosed technology.

**Chain**
An information schema representing a musical composite.

**Segment**
An information schema representing a partial section of a chain. A chain comprises a series of at least one
6 changes: 4 additions & 2 deletions content/installation/_index.en.md
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"%}}
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.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
categories = ["custom", "theming"]
categories = ["installation"]
title = "Mac Installation (Intel)"
weight = 2
+++
Expand Down
Loading

0 comments on commit c169704

Please sign in to comment.