Skip to content

Commit

Permalink
Docs 2nd pass (#10)
Browse files Browse the repository at this point in the history
* Update Content Browser

* Updating Getting Started

* Getting Started update

* Updates and changing Project Menu to Menu Bar

* Update _index.en.md

* Update _index.en.md

* Update _index.en.md

* Getting Started updates

* Updated tags

* Updated docs homepage

* Update _index.md

* Updating docs home page

* docs 2nd pass

* Categories added

* Categories

* Categories

* Update _index.en.md

* Fixed redirects without trailing slash

* Update index.en.md

* Update _index.md

* Remove categories and github stars button

* Tag styling

---------

Co-authored-by: Charney Kaye <charneykaye@gmail.com>
  • Loading branch information
JamalWhitaker and charneykaye authored May 29, 2024
1 parent c169704 commit dfa657e
Show file tree
Hide file tree
Showing 43 changed files with 197 additions and 739 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# XJ music documentation

Documentation for [XJ music](https://github.com/xjmusic/xjmusic)
**Documentation for [XJ music](https://github.com/xjmusic/xjmusic)**

Published to [docs.xjmusic.com](https://docs.xjmusic.com/)

Built with [Hugo](https://gohugo.io)
**Published to [docs.xjmusic.com](https://docs.xjmusic.com/)**
8 changes: 4 additions & 4 deletions config/_default/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ googleAnalytics = "G-GW9VCFXV42"
pageRef = "tags/"
weight = 40

[[languages.en.menu.shortcuts]]
name = "<i class='fa-fw fas fa-layer-group'></i> Categories"
pageRef = "categories/"
weight = 50
# [[languages.en.menu.shortcuts]]
# name = "<i class='fa-fw fas fa-layer-group'></i> Categories"
# pageRef = "categories/"
# weight = 50


[[module.mounts]]
Expand Down
32 changes: 32 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@ archetype = "home"
description = "Documentation for composing with the XJ music workstation and implementing the XJ music playback engine."
title = "XJ music documentation"
+++

![XJ music logo](xj-music-logo.png?width=400px)

#### Dynamic music engine

XJ music enables composers to realize new possibilities in dynamic music for video games.

The platform comprises the [XJ music workstation](https://github.com/xjmusic/xjmusic/blob/main/workstation/README.md) for music composition and the [XJ music engine](https://github.com/xjmusic/xjmusic/blob/main/engine/README.md) for implementing music in your game.

#### Patented technology, open source codebase

The underlying technology is protected by [U.S. Patent 10,446,126](https://patents.google.com/patent/US10446126B1/).

You may use the XJ music engine completely free for projects with a budget under $250K. For larger projects, contact licensing@xjmusic.com for a license.

![XJ music workstation](xj-music-workstation.png?width=800px)

## Getting XJ music

#### Binary downloads
The latest version of the XJ music workstation can be downloaded from [xjmusic.com/download](https://xjmusic.com/download).

All official binaries for the XJ music engine and workstation can be found [in the releases section](https://github.com/xjmusic/xjmusic/releases).

## Community and contributing

XJ music is an ever-growing community of users and developers.

The best way to get in touch with the core engine developers is to join the [XJ music Discord](https://discord.xj.io/).

To get started contributing to the project, see the [contributing guide](https://github.com/xjmusic/xjmusic/blob/main/CONTRIBUTING.md). This document also includes guidelines for reporting bugs.

{{% replaceRE "https://docs.xjmusic.com/" "" %}}
{{< include "README.md" "true" >}}
{{% /replaceRE %}}
39 changes: 32 additions & 7 deletions content/getting-started/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,45 @@
archetype = "chapter"
title = "Getting Started"
weight = 4
tags = ["start", "getting started", "intro", "tutorial"]
+++

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
## Project Menu

The [**Project menu**](/getting-started/menu-bar/) provides a comprehensive set of options for managing project files efficiently. Creating new Projects, opening previously created Projects, saving your work, changing directory settings, and quitting the workstation is done here.

## Content
## Fabrication Menu

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/).
The [**Fabrication menu**](/making-xj-music/fabrication/fabrication-settings/) displays two commands for the fabrication of musical segments, Start (CTRL+Space) and Follow (CTRL+ALT+Space).

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/)

## View Menu

The [**View menu**](/getting-started/menu-bar/) contains navigational shortcuts between the Content, Templates, and Fabrication tabs, Log controls, and backward/forward buttons to visit their previously viewed locations.

## Content Tab

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/)

## Templates Tab

In the Templates section of the workstation, you will see a list of available [**Templates**](/making-xj-music/templates/) in the current project. Templates contain bound [**Libraries**](/making-xj-music/libraries/)- your [**Programs**](/making-xj-music/programs/), and [**Instruments**](/making-xj-music/instruments/).

## Fabrication Tab

In the Fabrication section of the workstation, you will see another empty space.

![Empty Timeline](empty-timeline.png)

If all Libraries have finished loading their data, you can prompt the workstation using the Start button in the top right-hand side, and you will see the playback Timeline displayed!

![Playback Timeline](playback-timeline.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions content/getting-started/content-browser/index.en.md

This file was deleted.

9 changes: 9 additions & 0 deletions content/getting-started/content-browser/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = "Content Browser"
weight = 20

+++

The **Content Browser** is the central hub for navigating and managing various types of content within the XJ music workstation. Accessible via the **Content tab** at the top right-hand corner, this main window offers an organized and intuitive view of the available resources, including [**Libraries**](/making-xj-music/libraries/), [**Programs**](/making-xj-music/programs/), [**Instruments**](/making-xj-music/instruments/), and [**Audios**](/getting-started/instrument-editor/).

![Content Browser](content-browser.png?width=600px)
Binary file added content/getting-started/empty-timeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
+++
title = "Fabrication"
title = "Fabrication Tab"
weight = 50
tags = ["fabrication", "play", "playback"]
+++

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.
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.
3 changes: 2 additions & 1 deletion content/getting-started/instrument-editor/index.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
+++
title = "Instrument Editor"
weight = 40
tags = ["upload", "import", "audio", "stems", "sounds"]
+++

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.
Expand Down Expand Up @@ -29,7 +30,7 @@ The two icons in the bottom left of the Waveform Viewer will open the selected a

### 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.
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

Expand Down
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
+++
title = "Project"
title = "Menu Bar"
weight = 10
tags = ["menu", "logs", "error logs", "navigate", "navigation", "help", "about", "version", "guide", "Discord", "support"]
+++

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.
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
Expand All @@ -14,20 +15,20 @@ When first opening the XJ music workstation, the user will have the option of de

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!
[**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+→) |
| 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
Expand All @@ -36,7 +37,7 @@ To open a demo project, access the Project dropdown menu in the top left-hand si
|--------------------|------------------------------------------------------------------------------------------|
| **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). |
| **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)
Binary file added content/getting-started/playback-timeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions content/getting-started/program-editor/index.en.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
+++
title = "Program Editor"
weight = 30
tags = ["Program", "program editor", "segment", "macro", "main", "beat", "detail"]
+++

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 Macro Program**](#editing-a-macro-program)

[Editing a Main Program](#editing-a-main-program)
[**Editing a Main Program**](#editing-a-main-program)

[Editing a Beat Program](#editing-a-beat-program)
[**Editing a Beat Program**](#editing-a-beat-program)

[Editing a Detail Program](#editing-a-detail-program)
[**Editing a Detail Program**](#editing-a-detail-program)


## Editing a Macro Program
Expand All @@ -28,7 +29,7 @@ First, you’ll create some number of sequences containing attribute values for

![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.
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)

Expand Down
8 changes: 4 additions & 4 deletions content/how-it-works/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ title = "How it Works"
weight = 2
+++

XJ utilizes a versatile template system that accepts various inputs, such as content, programs, and instruments from many libraries.
XJ utilizes a versatile template system that accepts various inputs, such as audio stems, programs, and instruments from many libraries.

XJ's 'play' functionality is more complex than it seems, as it is powered by a feature termed the 'Nexus.' The Nexus meticulously reads the content and constructs an ongoing sequence of segments. Each segment, unique in its timeline placement, consists of all the content employed to forge it.

Creating a segment requires several elements. Initially, you will need 'Macro Programs,' which are comparable to the sequence of songs a DJ would pick to play one after another. Following this, you will need 'Main Programs' - these are analogous to the individual pieces in a DJ's set, complete with chord progressions and specific voicings for each instrument in the song.
Creating a segment requires several elements. Initially, you will need [**'Macro Programs,'**](/making-xj-music/programs/types-of-programs/) which are comparable to the sequence of songs a DJ would pick to play one after another. Following this, you will need [**'Main Programs'**](/making-xj-music/programs/types-of-programs/) - these are analogous to the individual pieces in a DJ's set, complete with chord progressions and specific voicings for each instrument in the song.

As the XJ moves through the creation process, it seeks out 'Beat Programs.' These programs house a collection of drum events that construct the underlying rhythm of the piece. XJ further scours for 'Detail Programs' that execute the voicings derived from the Main Programs, such as a bassline or stab pattern.
As the XJ moves through the creation process, it seeks out [**'Beat Programs.'**](/making-xj-music/programs/types-of-programs/) These programs house a collection of drum events that construct the underlying rhythm of the piece. XJ further scours for [**'Detail Programs'**](/making-xj-music/programs/types-of-programs/) that execute the voicings derived from the Main Programs, such as a bassline or stab pattern.

To fully realize the sonic details in the programs, XJ will search for the appropriate instruments, each packed with audio content. For instance, a bass detail pattern from the Detail Program merges with bass voicings from the Main Program. This combination then aligns with a polyphonic bass-type instrument selected to curate and choose the final bass audio for the segment.
To fully realize the sonic details in the programs, XJ will search for the appropriate [**instruments**](/making-xj-music/instruments/), each packed with audio content. For instance, a bass detail pattern from the Detail Program merges with bass voicings from the Main Program. This combination then aligns with a polyphonic bass-type instrument selected to curate and choose the final bass audio for the segment.

Some types of instrument audio are utilized formulaically within XJ, such as transition audio, percussion audio, and ambient audio. This creates a cohesive, dynamic, and robust sonic experience. Hence, XJ combines all these elements to generate a beautifully organized and harmonious audio segment, providing a user-friendly, intricate, and comprehensive approach to music creation.
1 change: 0 additions & 1 deletion content/installation/linux-installation/index.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
+++
categories = ["installation"]
title = "Linux Installation"
weight = 5
+++
Expand Down
1 change: 0 additions & 1 deletion content/installation/mac-installation-intel/index.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
+++
categories = ["installation"]
title = "Mac Installation (Intel)"
weight = 2
+++
Expand Down
1 change: 0 additions & 1 deletion content/installation/mac-installation-silicon/index.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
+++
categories = ["installation"]
title = "Mac Installation (Silicon)"
weight = 3
+++
Expand Down
1 change: 0 additions & 1 deletion content/installation/windows-installation/index.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
+++
categories = ["installation"]
title = "Windows Installation"
weight = 4
+++
Expand Down
Loading

0 comments on commit dfa657e

Please sign in to comment.