Repository: GoXLR-on-Linux/goxlr-on-linux
Branch: main
Commit: 3382dd32b95a
Files: 4
Total size: 4.0 KB

Directory structure:
gitextract_xjo3rr81/

├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.md
│   │   └── feature_request.md
│   └── workflows/
│       └── sh-check.yml
└── README.md

================================================
FILE CONTENTS
================================================

================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
 - OS: [e.g. Ubuntu]
 - Version [e.g. 22]

**Additional context**
Add any other context about the problem here.


================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.


================================================
FILE: .github/workflows/sh-check.yml
================================================
# This is a basic workflow to help you get started with Actions

name: Sh Check

# Controls when the action will run. 
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  pull_request:
    branches:
    - main
  

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:


jobs:
  
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
    - uses: actions/checkout@v1
    - name: sh-checker
      # You may pin to the exact commit or the version.
      #uses: luizm/action-sh-checker@164368daf52a9126460854f9c0de00abc079a350
      uses: luizm/action-sh-checker@v0.1.13
      env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        sh_checker_shellcheck_disable: true
        sh_checker_shfmt_disable: true
        sh_checker_checkbashisms_enable: true
        sh_checker_comment: true


================================================
FILE: README.md
================================================
# goxlr-on-linux
[![Support Server](https://img.shields.io/discord/828348446775574548.svg?label=Discord&logo=Discord&colorB=7289da&style=flat)](https://discord.gg/Wbp3UxkX2j)


## Status
As of 2024 [basic functionality](https://github.com/GoXLR-on-Linux/goxlr-on-linux/wiki/Basic-Functionality) of the GoXLR is available
in all major distributions. To prevent confusion, the scripts which were originally housed here have been retired. I'd like to offer a massive thank you
to those who have contributed to this project, you are the pioneers of the GoXLR on Linux, and we wouldn't be here without you!

This repository is being preserved for general FAQs and support, and our [Discord](https://discord.gg/Wbp3UxkX2j) server will remain available for discussion!

## The [GoXLR Utility](https://github.com/GoXLR-on-Linux/goxlr-utility/)
While the GoXLR works out the box, an application is still required to initialise and configure it. For that we have
the GoXLR Utility, a 1:1 replacement for the Official Windows GoXLR Application. It is feature complete, stable,
and has binaries provided for various distributions. 


## Known Issues
Below are a list of currently known issues, with links to wiki pages on how to solve them. 

* [Audio playback is noticeably delayed](https://github.com/GoXLR-on-Linux/goxlr-on-linux/wiki/Audio-Delays-when-using-PulseAudio)
* [Channels not listing on Ubuntu 24.04](https://github.com/GoXLR-on-Linux/goxlr-on-linux/wiki/GoXLR-Listing-as-'Multichannel'-in-Ubuntu-24.04-(Noble-Numbat))

## Disclaimer
This project is not in any way affiliated with TC-Helicon. There is no official support for the GoXLR, or the GoXLR 
Mini, on Linux. This project, including any of its contributors, cannot be held responsible for any issues you 
experience with your device or Linux installation before or after using documentation provided here.