Skip to content

Commit

Permalink
Moved 'Status' into the ROADMAP
Browse files Browse the repository at this point in the history
  • Loading branch information
FrostyCoolSlug committed Jul 26, 2022
1 parent 3498d75 commit 7ed2cd4
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 27 deletions.
23 changes: 2 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,8 @@
A tool to configure and use a TC-Helicon GoXLR or GoXLR Mini without requiring windows.

# Project State
As of version 0.2.0 the following features are fully supported:

* Initialisation of Devices under Linux<sup>1</sup>
* Mic and Main Profile Management (Load / Save / New)<sup>2</sup>
* Microphone Selection and Gain
* Fader Assignments
* Fader Mute buttons (Mute channel, Mute to X, Press and Hold)
* The 'Cough' Button (Hold / Toggle, Mute to X, Press and Hold)
* Bleep Button Volume
* Noise Gate and Compressor
* Microphone Equalizer
* Equalizer Fine Tune<sup>3</sup>
* Audio Routing
* Fader and Button colour configurations<sup>3</sup>

<sup>1</sup> Depending on how your GoXLR works, this may require a reboot.
<sup>2</sup> Profiles are 'cross platform', so Windows profiles should work with the util, and vice versa
<sup>3</sup> Currently only configurable via the `goxlr-client`

In addition, the Voice Effects panel of the Full GoXLR can be used if loading a pre-configured profile from Windows
(currently not configurable outside of dial adjustments).
For the current list of features that are supported, as well as what's still left to be done, checkout the
[Roadmap](ROADMAP.md) in this repository.

# Installation
Currently, the goxlr-utility isn't available via any general distribution method. For now, it must be compiled from
Expand Down
40 changes: 34 additions & 6 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,37 @@
# Roadmap
*Last Updated for 0.2.0 Release*

#### Full GoXLR mini support:
GoXLR Mini support is now complete, and all functions have been implemented.
## Completed Features
* Initialisation of Devices under Linux<sup>1</sup>
* Mic and Main Profile Management (Load / Save / New)<sup>2</sup>
* Microphone Selection and Gain
* Fader Assignments
* Fader Mute buttons (Mute channel, Mute to X, Press and Hold)
* The 'Cough' Button (Hold / Toggle, Mute to X, Press and Hold)
* Bleep Button Volume
* Noise Gate and Compressor
* Microphone Equalizer
* Equalizer Fine Tune<sup>3</sup>
* Audio Routing
* Fader and Button colour configurations<sup>3</sup>

#### Full GoXLR support:
- sampler
- effects
- scribbles
<sup>1</sup> Depending on how your GoXLR works, this may require a reboot.
<sup>2</sup> Profiles are 'cross platform', so Windows profiles should work with the util, and vice versa
<sup>3</sup> Currently only configurable via the `goxlr-client`


## Partial Completion
* Voice Effects
* If loaded from a Windows profile, the Voice FX Buttons should work and configure appropriately. The effects banks,
dials, buttons should all also work. Currently, it's not possible to configure or change the fine details of the
effects under Linux.

## Not Completed
* Sampler
* Due to the nature of Linux audio, this is a little more complex to deal with. Some preliminary code has been created
and functions correctly, however it's massively incomplete and complicated to use.
* Scribbles
* Generally just a low priority, not overly complicated to achieve, but also not really that important,
will arrive soon!
* Lighting
* Lighting Configuration is still missing for the 'Global' lights, Effects Dials and Scribbles.

0 comments on commit 7ed2cd4

Please sign in to comment.