Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
9ebbe98
Update en-Central-Servers.md
ignotus666 Feb 10, 2021
f8eaaf0
Update en-Client-Troubleshooting.md
ignotus666 Feb 10, 2021
d3b621b
Update en-Compiling.md
ignotus666 Feb 10, 2021
12a1445
Update en-Contribution.md
ignotus666 Feb 10, 2021
bf07489
Update en-Getting-Started.md
ignotus666 Feb 10, 2021
e4ecb83
Update en-Hardware-Setup.md
ignotus666 Feb 10, 2021
5aea37a
Update en-Installation-for-Linux.md
ignotus666 Feb 10, 2021
2b00c04
Update en-Installation-for-Macintosh.md
ignotus666 Feb 10, 2021
0ec910b
Update en-Installation-for-Windows.md
ignotus666 Feb 10, 2021
65f682f
Update en-Network-Requirements.md
ignotus666 Feb 10, 2021
66f0fd3
Update en-Onboarding.md
ignotus666 Feb 10, 2021
e9ca38e
Update en-Privacy-Statement.md
ignotus666 Feb 10, 2021
d1d677b
Update en-Running-a-Private-Server.md
ignotus666 Feb 10, 2021
01b9bbe
Update en-Running-a-Server.md
ignotus666 Feb 10, 2021
b8f3ddd
Update en-Server-Linux.md
ignotus666 Feb 10, 2021
420200b
Update en-Server-Troubleshooting.md
ignotus666 Feb 10, 2021
0264d9e
Update en-Server-Win-Mac.md
ignotus666 Feb 10, 2021
269e90e
Update en-Software-Manual.md
ignotus666 Feb 10, 2021
56d560e
Update en-Tips-Tricks-More.md
ignotus666 Feb 10, 2021
6e6d4fa
Update en-Central-Servers.md
ignotus666 Feb 10, 2021
a1c0c44
Update en-Contribution.md
ignotus666 Feb 10, 2021
1c0dd93
Add spacing
ann0see Feb 11, 2021
9082a3b
Update en-Client-Troubleshooting.md
ann0see Feb 11, 2021
b1eb5e2
Merge branch 'changes' into changes_revision
ann0see Feb 14, 2021
d599bf3
Merge pull request #1 from jamulussoftware/changes
ignotus666 Feb 15, 2021
57b5e5e
Update en-Hardware-Setup.md
ignotus666 Feb 15, 2021
dcd8056
Update en-Installation-for-Windows.md
ignotus666 Feb 15, 2021
1ca2ef4
Update en-Onboarding.md
ignotus666 Feb 15, 2021
0e7ea7d
Update en-Onboarding.md
ignotus666 Feb 15, 2021
47261c0
Update en-Software-Manual.md
ignotus666 Feb 15, 2021
191d144
Corrected URL
ignotus666 Feb 15, 2021
1b2b43f
Corrected URL
ignotus666 Feb 15, 2021
c0a9ed0
Corrected URL
ignotus666 Feb 15, 2021
bc788c5
Updated to document new MIDI controller functions
ignotus666 Feb 15, 2021
281c3c8
Updated MIDI controller syntax
ignotus666 Feb 15, 2021
f6e0e0a
Update en-Command-Line-Options.md
ignotus666 Feb 15, 2021
79848dc
Correction and addition
ignotus666 Feb 15, 2021
a082030
Removed spaces
ignotus666 Feb 15, 2021
9b29c60
Removed spaces
ignotus666 Feb 15, 2021
b8fb4f1
Merge branch 'changes' into changes_revision
gilgongo Feb 15, 2021
1a5a7b3
Correction
ignotus666 Feb 15, 2021
0934150
Correction
ignotus666 Feb 15, 2021
3f0f505
Update
ignotus666 Feb 15, 2021
10d700d
Some rephrasing
ignotus666 Feb 15, 2021
f45ae71
Just realised the next release will be 3.7.0
ignotus666 Feb 16, 2021
eb92cc2
Update en-Tips-Tricks-More.md
ignotus666 Feb 17, 2021
f9edde7
Merge branch 'changes' into changes_revision
ann0see Feb 17, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion wiki/en/en-Central-Servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ permalink: "/wiki/Central-Servers"

Because there is a limit of 150 servers per central server, you need to select which central server you want to advertise your server on. Select a genre if you intend to limit players to that style (players can then see your server in their genre list).

When you start a public server, you will see a message saying whether your server has been successfully listed or not. If not, and you leave your server running, it will re-try its attempts to register until a free slot becomes available.
When you start a public server, you will see a message saying whether your server has been successfully listed or not. If not, and you leave your server running, it will keep trying to register until a free slot becomes available.


## Headless servers
Expand Down
2 changes: 1 addition & 1 deletion wiki/en/en-Client-Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You can set your "New Client Level" to a low value (e.g. 10), or set the musicia

### Can't see the server you want to join?

First check that you have the right genre server selected in your Connect Setup window. But sometimes network issues mean your client won't list all the available servers. If you know the name of the server you want to join, you can [look up its IP address here](https://explorer.jamulus.io/). Enter the IP address in the "Server Name/Address" field in the Connect Setup window to connect to it.
First check that you have the right genre server selected in your Connection Setup window. Sometimes network issues mean your client won't list all the available servers. If you know the name of the server you want to join, you can [look up its IP address here](https://explorer.jamulus.io/). Enter the IP address in the "Server Name/Address" field in the Connect Setup window to connect to it.

### Not seeing a list of servers at all?

Expand Down
2 changes: 1 addition & 1 deletion wiki/en/en-Command-Line-Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ You can see all possible options your version supports by starting Jamulus with
| `-u` |`--numchannels` | Maximum number of users. Default is 10, maximum is 50 | (server only) |
| `-w` |`--welcomemessage` | Supports HTML and inline CSS formatting (in enclosing quotes), or set path to text file. | (server only) |
| `-z` |`--startminimized` | Start minimized | (server only) |
| |`--ctrlmidich` | MIDI controller channel to listen on and control number offset, format: `channel[;offset]` | (client only) see [Tips & Tricks](Tips-Tricks-More#Using-ctrlmidich-for-MIDI-controllers) |
| |`--ctrlmidich` | MIDI controller channel to listen on, control number offset and consecutive CC numbers (channels). Format: `channel[;f<off>*<channels>][;p<off>*<channels>][;s<off>*<channels>][;m<off>*<channels>]` | (client only) see [Tips & Tricks](Tips-Tricks-More#Using-ctrlmidich-for-MIDI-controllers) |
| |`--clientname` | Window title and JACK client name | (client only) |
| |`--serverpublicip` | Supply the server's public IP address | (server only) [See note](Choosing-a-Server-Type) |
4 changes: 2 additions & 2 deletions wiki/en/en-Compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You don't need to compile Jamulus for macOS since we provide official binaries,
### Requirements

1. Install XCode
1. Install Qt as follow
1. Install Qt as follows

```shell
brew install qt5
Expand Down Expand Up @@ -72,7 +72,7 @@ You don't need to compile Jamulus for Windows since we provide official binaries


### Download Jamulus source code
Get the Jamulus source code e.g. via git or [zip download](https://github.com/corrados/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/corrados/jamulus). Make sure that there are **no** spaces in the directory you move the `jamulus` directory to since it might break the Jamulus installer (if you know how to fix this issue, please comment on [issue #864](https://github.com/corrados/jamulus/issues/864) on the Jamulus repo to tell us how).
Get the Jamulus source code e.g. via git or [zip download](https://github.com/jamulussoftware/jamulus/archive/master.zip) from the [Jamulus repo](https://github.com/jamulussoftware/jamulus). Make sure that there are **no** spaces in the directory you move the `jamulus` directory to since it might break the Jamulus installer (if you know how to fix this issue, please comment on [issue #864](https://github.com/jamulussoftware/jamulus/issues/864) on the Jamulus repo to tell us how).

### Compiling and building installer

Expand Down
4 changes: 2 additions & 2 deletions wiki/en/en-Contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ See the [Jamulus GitHub repo](https://github.com/jamulussoftware/jamulus) for fu

## Jamulus Website

* If you find a mistake, typo or something out of date (in any language) on the website, you can [open an issue on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) or, if you don't have a GitHub account on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) on SourceForge.
* If you find a mistake, typo or something out of date (in any language) on the website, you can [open an issue on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) or, if you don't have a GitHub account, on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) on SourceForge.

* If you think some documentation or information is missing or can be improved, post about that on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) so that it can be discussed first.

Have a look at the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md) for the website and the [Website GitHub repo](https://github.com/jamulussoftware/jamuluswebsite) for further information.

### I don't know GitHub. What do I need to know?
### I'm not familiar with GitHub. What do I need to know?

**The following content is for the documentation on jamulus.io only, not for the Jamulus software!**

Expand Down
12 changes: 6 additions & 6 deletions wiki/en/en-Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ permalink: "/wiki/Getting-Started"

1. **A computer** running either **Windows 10**, **macOS** (**MacOS X** El Capitan v10.11 or higher), or **Linux**.
1. **A wired internet connection** (don't use Wi-Fi, it will cause sound problems). Most broadband connections will be fine[^1].
1. **Wired headphones - not speakers** to prevent echo or feedback and to minimize delay[^2].
1. **Wired headphones - not speakers** to prevent echo or feedback and to minimise delay[^2].
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we already had a discussion about BE/AE and I think minimize is also ok in BE?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minimise is preferred in BE.


## Maximise quality, minimise delay

### 1. Minimize internet traffic and close all programs on your PC
### 1. Minimise internet traffic and close all programs on your PC

Try to make sure nothing on your machine or your network (like a video stream) is competing against Jamulus when you are using it.

### 2. Use an audio interface/external microphone, not your internal sound card

We strongly recommend – although you could start without it – to use an audio interface (a box you plug a microphone/instrument into and connect to your PC e.g. via USB) to enjoy higher quality sound with low latency in Jamulus. You can also use a USB microphone. See [recommended hardware](#recommended-hardware).
We strongly recommend – although you could start without it – using an audio interface (a box you plug a microphone/instrument into and connect to your PC e.g. via USB) to enjoy higher quality sound with low latency in Jamulus. You can also use a USB microphone. See [recommended hardware](#recommended-hardware).

### 3. Connect to the servers with the lowest ping times

Servers shown on the list with 15ms or below will give you the best chance of having a good time (although there's other things that affect performance too). Anything higher and you're taking your chances.
Servers shown on the list with 15 ms or below will give you the best chance of having a good time (although there are other things that affect performance too). Anything higher and you're taking your chances.

Now that you have the basics down, let's go:

Expand Down Expand Up @@ -62,8 +62,8 @@ Further information about how to avoid listening to yourself (and help with othe
**Here's how millions of people are using Jamulus to play, sing and teach music with other people in real time, all over the world:**

![Overview](https://user-images.githubusercontent.com/4561747/79309764-bd387280-7ef2-11ea-9d81-1e81302525e6.png)
_Jamulus works on the client server principle. Everybody’s audio is sent to a server, mixed and processed there. Afterwards, the audio is sent to each client. If a server is made public and registered on a central server, its information will be broadcast to all clients._
_Jamulus works on the client-server principle. Everybody’s audio is sent to a server, mixed and processed there. Afterwards, the audio is sent back to each client. If a server is made public and registered on a central server, its information will be broadcast to all clients._

## Footnotes
[^1]: [Full details here](Network-Requirements){: target="_blank" rel="noopener noreferrer"}. If you have 10 Mbit/s down and 1 Mbit/s up, you're unlikely to run into bandwidth-related issues.
[^2]: Bluetooth headphones usually have too much latency. That's one reason why wired headphones are required. Particularity if singing or playing acoustic instruments to make sure you keep in time with others only use headphones (see the [note on this](Getting-Started#having-trouble-cant-keep-in-time) for further information).
[^2]: Bluetooth headphones usually have too much latency. That's one reason why wired headphones are required. Particularly if singing or playing acoustic instruments, to make sure you keep in time with others, only use headphones (see the [note on this](Getting-Started#having-trouble-cant-keep-in-time) for further information).
18 changes: 9 additions & 9 deletions wiki/en/en-Hardware-Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ permalink: "/wiki/Hardware-Setup"

## Example Setups

Setting up hardware usually burns down to 4 points, although each setup is different.
Setting up hardware usually boils down to 4 points, although each setup is different.

1. Plug the interface into a USB port on your computer
2. Close all programs and start Jamulus (don't forget to choose the right inputs in Jamulus's settings)
Expand All @@ -27,14 +27,14 @@ Setting up hardware usually burns down to 4 points, although each setup is diffe

## Windows: Audio interface connection - ASIO4ALL

This is an example Windows client installation with audio device [Behringer U-CONTROL UCA202](https://www.amazon.com/Behringer-U-Phono-UFO202-Audiophile-Interface/dp/B002GHBYZ0).
This is an example Windows client installation with the [Behringer U-CONTROL UCA202](https://www.amazon.com/Behringer-U-Phono-UFO202-Audiophile-Interface/dp/B002GHBYZ0) audio device.
The following instructions might be similar with other audio devices.
Comment thread
ann0see marked this conversation as resolved.

_**The exact method of connecting your instrument will of course vary depending on your hardware.**_

#### 1. Plug the interface into a USB port on your computer

In the future, always use the same USB port for the audio device.
In future, always use the same USB port for the audio device.

**Windows users**: If not already done: download and install the [free ASIO sound driver (ASIO4ALL)](https://www.asio4all.org){: target="_blank" rel="noopener noreferrer"}. Some people have also reported success using [this ASIO native driver](http://www.behringerdownload.de/_software/BEHRINGER_2902_X64_2.8.40.zip){: target="_blank" rel="noopener noreferrer"} __currently not available__, although it's not listed on Behringer's product pages as of April 2020.

Expand All @@ -47,7 +47,7 @@ Make sure you have switched off the monitor button on your Behringer U-CONTROL U

#### 3. Plug in your instrument and headphones

Connect your instrument to the input plugs of the Behringer U-CONTROL UCA202. Plug in your headphones into the Behringer U-CONTROL UCA202.
Connect your instrument to the input socket of the Behringer U-CONTROL UCA202. Plug your headphones into the Behringer U-CONTROL UCA202.

#### 4. Connect to a Jamulus server.

Expand All @@ -58,24 +58,24 @@ You're done! Have fun!
Refer to the Linux [client install guide](Installation-for-Linux#configure-jack-with-qjackctl).

## Linux: Low Latency Kernels for Jamulus
You might want to install [Ubuntu Studio](https://ubuntustudio.org/) it adds a second options in your boot menu for a low-latency kernel. The key of successful jamming is "low latency" between servers and connected Jamulus clients. If the underlying Linux system is started with a low-latency then it has a positive impact on latency for your Jamulus Sessions.
You might want to install [Ubuntu Studio](https://ubuntustudio.org/). It adds a second option in your boot menu for a low-latency kernel. The key to successful jamming is "low latency" between servers and connected Jamulus clients. If the underlying Linux system is started with a low-latency kernel then it has a positive impact on latency for your Jamulus sessions.


## Points to note about inputs

- If you want to connect 2 or more sources (eg voice + synth + guitar), it is important to note that Jamulus currently handles only input 2 channels (L/R). So the hardware being used must provide a mixed-down stereo output to Jamulus.
- If you want to connect 2 or more sources (e.g. voice + synth + guitar), it is important to note that Jamulus currently handles only 2 input channels (L/R). So the hardware being used must provide a mixed-down stereo output to Jamulus. Alternatively, run two instances of Jamulus, if your hardware supports it, or use virtual audio inputs to Jamulus for each hardware input.
- Audio interfaces generally output a mixed signal on their analogue output, but separate signals (1 per source) on their digital output (USB/FireWire/Thunderbolt).
- Mixers generally only output mixed-down signals on their analogue output.
- Mixers with USB/FireWire/Thunderbolt generally output mixed-down signal on their **analogue** output AND separate signals only (no mixed-down signal) on their **digital** output.
- A few Mixers with USB/FireWire/Thunderbolt will either send **only** a mixed down signal to the **digital** output (small/budget mixers), or else also ADD a stereo mix-down signal to the separate signals on the digital output.
- Mixers with USB/FireWire/Thunderbolt generally output a mixed-down signal on their **analogue** output AND separate signals only (no mixed-down signal) on their **digital** output.
- A few Mixers with USB/FireWire/Thunderbolt will either send **only** a mixed-down signal to the **digital** output (small/budget mixers), or else also ADD a stereo mixed-down signal to the separate signals on the digital output.

_(Thanks to [pcar75](https://github.com/pcar75) for this information)_

## Other examples

**This video documents a [live jam session](https://youtu.be/c8838jS2g3U).** I am using a Lexicon Omega USB audio card on a 2009 Mac Mini. My bandmates all use Windows 10 and have Behringer audio cards, e.g. the Behringer Xenyx 1204USB. My internet connection is 10 Mbit/s down / 1 Mbit/s upstream via DSL.

**Jamulus user [Andrew Evans](https://sourceforge.net/u/belvario/profile/)**: With bandmates all within one city (but spanning 2 ISPs) and achieving consistent 20ms ping time, running the server on a separate dedicated Windows machine and a client on a MacBook Pro. Remote players on MacBook Air. Everyone on wired Ethernet connections to their home router/gateways. We used WhatsApp video to see each other (with audio muted - it's funny to see how far behind the WhatsApp audio lags from Jamulus though!)
**Jamulus user [Andrew Evans](https://sourceforge.net/u/belvario/profile/)**: With bandmates all within one city (but spanning 2 ISPs) and achieving a consistent 20 ms ping time, running the server on a separate dedicated Windows machine and a client on a MacBook Pro. Remote players on MacBook Air. Everyone on wired Ethernet connections to their home router/gateways. We used WhatsApp video to see each other (with audio muted - it's funny to see how far behind the WhatsApp audio lags from Jamulus though!)

## Having problems?

Expand Down
15 changes: 8 additions & 7 deletions wiki/en/en-Installation-for-Linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Although we don't provide official packages for every Linux distribution, you mi

[![Packaging status](https://repology.org/badge/vertical-allrepos/jamulus.svg)](https://repology.org/project/jamulus/versions)


There is also list of unofficial [packages for different distributions here](https://github.com/jamulussoftware/jamulus/discussions/914).

### Flatpak
Expand Down Expand Up @@ -53,7 +54,7 @@ tar -xvf latest.tar.gz

### Install dependencies

First, update your package list (e.g. on Debian based distributions with `sudo apt-get update`).
First, update your package list (e.g. on Debian-based distributions with `sudo apt-get update`).

On **Ubuntu-based** distributions 18.04+, **Debian** 9+ or 10 and Raspberry Pi Raspbian Buster release or later:

Expand All @@ -75,7 +76,7 @@ sudo dnf install qt5-qtdeclarative-devel jack-audio-connection-kit-dbus libQt5Co
sudo apt-get install qjackctl
```

You may also wish to consider using a [low-latency kernel](https://help.ubuntu.com/community/UbuntuStudio/RealTimeKernel) (eg. for Ubuntu 18.04: `sudo apt-get install linux-lowlatency-hwe-18.04`).
You may also wish to consider using a [low-latency kernel](https://help.ubuntu.com/community/UbuntuStudio/RealTimeKernel) (e.g. for Ubuntu 18.04: `sudo apt-get install linux-lowlatency-hwe-18.04`).

### Compile this bad boy

Expand Down Expand Up @@ -103,14 +104,14 @@ You can now delete the sources directory you compiled from.
### Configure JACK with QjackCtl
Jamulus clients need [JACK](https://jackaudio.org/) to run, but you need to configure that first. The recommended method is to use `QjackCtl`.
1. Open the command shell e.g. with Ctrl-Alt-T and
1. Execute the command `qjackctl` you will see the **JACK Audio Connection Kit**
1. Execute the command `qjackctl`. You will see the **Qt JACK Control utility main page**
2. Configure your audio interface as follows (the exact settings for JACK will depend on what your audio interface/sound card is capable of):

- Set the audio **Interface** to the one you want (there may be several in the list)
- Set the **Sample Rate to 48000**
- Set the **Frames/Period to 128** and Periods/Buffer at 2 at first

Restart JACK to take any new settings
Restart JACK for the new settings to take effect

### Start Jamulus

Expand All @@ -130,12 +131,12 @@ Download the new sources as per [Get Jamulus](Installation-for-Linux#get-jamulus

## Notes for geeks

* The "make clean" is essential to remove the automatically generated Qt files which are present in the .tar.gz file and may not match the Qt version you are using.
* The "make clean" command is essential to remove the automatically generated Qt files which are present in the .tar.gz file and may not match the Qt version you are using.

* To use an external shared OPUS library instead of the built-in use qmake `"CONFIG+=opus_shared_lib" Jamulus.pro`.
* To use an external shared OPUS library instead of the built-in one use qmake `"CONFIG+=opus_shared_lib" Jamulus.pro`.

* To use this file configure the software with `qmake "CONFIG+=noupcasename" Jamulus.pro` to make sure the output target name of this software is **j**amulus instead of **J**amulus.

* Users of Raspberry Pi: You may want to compile the client on another machine and run the binary on the Raspberry Pi. In which case, the only libraries you need to run it are those for a [headless server](Server-Linux#running-a-headless-server) build, but _with_ the JACK sound packages. Especially have a look at the footnote for the headless build.
* Users of Raspberry Pi: You may want to compile the client on another machine and run the binary on the Raspberry Pi. In which case the only libraries you need to run it are those for a [headless server](Server-Linux#running-a-headless-server) build, but _with_ the JACK sound packages. In particular, have a look at the footnote for the headless build.

* As of version 3.5.3, Jamulus is no longer compatible with Qt4.
2 changes: 1 addition & 1 deletion wiki/en/en-Installation-for-Macintosh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The first time you try to double-click Jamulus to run it, you will probably see

To open Jamulus
1. Navigate to the Applications folder via Finder
1. Double-click on Jamulus and wait for the mentioned message
1. Double-click on Jamulus and wait for the above-mentioned message
1. Close this message by clicking on "Cancel"
1. Now control-click (or right-click) on Jamulus, and select "Open" from the top of the menu.

Expand Down
Loading