From 77958ab753b80b5831fdff43ce415e1235d816f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Sch=C3=A4fer?= <pschaefer@ITA.AKUSTIK.RWTH-AACHEN.DE> Date: Fri, 3 Mar 2023 15:33:44 +0100 Subject: [PATCH] README: Change occurances of 'VAServer Launcher' to 'VAServerLauncher' --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 54bfe4e..4992507 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# VAServer Launcher +# VAServerLauncher This holds prebuild VAServers for Windows which can be launched from Unreal using a python script. Additionally, this allows to specify all rendering settings for VA within the Unreal project, while costumizing the hardware and reproduction settings on the target machine running the VAServer. @@ -9,29 +9,29 @@ This holds prebuild VAServers for Windows which can be launched from Unreal usin ## Quick guide for local usage *VAServer and Unreal project are running on same computer* -VAServer Launcher: +VAServerLauncher: - Checkout this repository to your computer, use the default folder name `VAServer` Unreal project: - Your project (e.g. this [demo-project](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/demos/unreal-va-demo)) should be placed next to the `VAServer` folder -- Make sure the `Use VAServer Launcher` option of your `VAReceiverActor` is enabled -- Run the project: The VAServer Launcher should be automatically started launching a VAServer instance. Unreal connets to this instance and an audio stream should be audible (default output should be headphones on channels 1 & 2). +- Make sure the `Use VAServerLauncher` option of your `VAReceiverActor` is enabled +- Run the project: The VAServerLauncher should be automatically started launching a VAServer instance. Unreal connets to this instance and an audio stream should be audible (default output should be headphones on channels 1 & 2). ## Quick guide for remote usage *VAServer and Unreal project on different computers* Computer running VAServer: - Checkout this repository -- Manually start the VAServer Launcher by running ``./LaunchScripts/VirtualAcousticsStarterServer.py`` via python +- Manually start the VAServerLauncher by running ``./LaunchScripts/VirtualAcousticsStarterServer.py`` via python Computer running Unreal: -- Make sure the `Use VAServer Launcher` option of your `VAReceiverActor` is enabled -- Run the project: The VAServer Launcher should start a VAServer instance. Unreal connets to this instance and an audio stream should be audible (default output should be headphones on channels 1 & 2). +- Make sure the `Use VAServerLauncher` option of your `VAReceiverActor` is enabled +- Run the project: The VAServerLauncher should start a VAServer instance. Unreal connets to this instance and an audio stream should be audible (default output should be headphones on channels 1 & 2). ## Launcher configuration -The VAServer Launcher can be configured by adjusting the settings in `./LaunchScripts/VirtualAcousticStarterConfig.json`. +The VAServerLauncher can be configured by adjusting the settings in `./LaunchScripts/VirtualAcousticStarterConfig.json`. | Setting | Description | Default | |---------|-------------|---------| @@ -49,7 +49,7 @@ If you want to use other VAServer versions than provided, you can extend the `dV ## VAServer configuration -A set of .ini files is provided in the `./conf` directory. The VAServer launcher will automatically combine them before starting the VAServer. For this to work, you should **not** change those files with the following exceptions. +A set of .ini files is provided in the `./conf` directory. The VAServerLauncher will automatically combine them before starting the VAServer. For this to work, you should **not** change those files with the following exceptions. ### Audio hardware The audio hardware settings are specific to each computer and typically have to be modified in the `VASetup.Launcher.ini`. Those include [audio driver](https://www.virtualacoustics.org/VA/documentation/configuration/#audio-driver-configuration) and [output device](https://www.virtualacoustics.org/VA/documentation/configuration/#audio-hardware-configuration) settings including the respective channels (e.g. headphones on channels 1 & 2). @@ -65,7 +65,7 @@ Per default the following reproduction modules are defined - AmbisonicsLS - AmbisonicsBinauralMixdown -You can add additional modules, if you want. However, you should *not* rename the existing ones. Furthermore, all modules must be disbaled [Enabled = false]. The VAServer Launcher will automatically enable the reproduction modules specified in the `VirtualAcousticStarterConfig.json` (see [Launcher configuration](#launcher-configuration)) when starting the VAServer. +You can add additional modules, if you want. However, you should *not* rename the existing ones. Furthermore, all modules must be disbaled [Enabled = false]. The VAServerLauncher will automatically enable the reproduction modules specified in the `VirtualAcousticStarterConfig.json` (see [Launcher configuration](#launcher-configuration)) when starting the VAServer. In any case, especially for the loudspeaker-based modules, you will have to update the `Outputs` setting according to what you defined in the `VASetup.Launcher.ini`. @@ -74,12 +74,12 @@ The [rendering settings](https://www.virtualacoustics.org/VA/documentation/rende ## Unreal project configuration -When working with the [Unreal VA plugin](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/unreal-va-plugin), all settings regarding the VAServer Launcher can be found in the `VAReceiverActor` under the `VAServer Launcher` category. +When working with the [Unreal VA plugin](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/unreal-va-plugin), all settings regarding the VAServerLauncher can be found in the `VAReceiverActor` under the `VAServer Launcher` category. | Setting | Description | Default | |---------|-------------|---------| -| Use VAServer Launcher | Switch to de-/activate usage | True -| VAServer Launcher Port | Port used for communication with launcher | 41578 | +| Use VAServerLauncher | Switch to de-/activate usage | True +| VAServerLauncher Port | Port used for communication with launcher | 41578 | | VAServer Version ID | ID used to specify which VAServer version should be started. This must match a value in the dictionary `dVAServerDirectories` in the [Launcher config](#launcher-configuration). | "2022.a" | -| VARenderer.ini file | Filename of the ini file including the audio rendering settings for this project. If specified, the file will be sent to the VAServer Launcher on startup. | "" | -| Reproduction input signal type | Depending on this setting a different set of reproduction modules (see [Launcher config](#launcher-configuration)) is used by the VAServer Launcher, the group [Default / Binaural / Ambisonics / Custom] | Binaural | \ No newline at end of file +| VARenderer.ini file | Filename of the ini file including the audio rendering settings for this project. If specified, the file will be sent to the VAServerLauncher on startup. | "" | +| Reproduction input signal type | Depending on this setting a different set of reproduction modules (see [Launcher config](#launcher-configuration)) is used by the VAServerLauncher, the group [Default / Binaural / Ambisonics / Custom] | Binaural | \ No newline at end of file -- GitLab