ReaWwise

REAPER extension
Log | Files | Refs | Submodules

Readme.md (4028B)

      1 # ReaWwise
      2 
      3 ReaWwise is a REAPER extension that sound designers can use to transfer audio files from REAPER into Wwise projects. The transfer process creates Wwise objects in manually defined hierarchies, so that Wwise users can start working with the imported sounds immediately. ReaWwise supports all REAPER wildcards and is available through the ReaPack package manager and the [releases page](https://github.com/audiokinetic/ReaWwise/releases) of this repository.
      4 
      5 ![example](user-interface.png)
      6 
      7 ## Table of contents
      8 
      9 - [**Getting Started**](#getting-started)
     10 - [Building from Source](#building-from-source)
     11 - [Contributing](#contributing)
     12 - [Legal](#legal)
     13 - [Acknowledgments](#acknowledgements)
     14 
     15 ## Getting Started
     16 
     17 ### Supported Platforms
     18 - Windows
     19 - Mac
     20 
     21 ### Manual installation
     22 
     23 1. Go to the the [releases page](https://github.com/audiokinetic/ReaWwise/releases), then download the extension file (reaper_reawwise.dll for Windows or reaper_reawwise.dylib for Mac).
     24 
     25 2. Copy the extension to the REAPER [UserPlugins directory](#userplugins-directory).
     26 
     27 3. If REAPER is running, restart the application. The extension is available in the Extensions menu.
     28 
     29 ### Installing ReaWwise through ReaPack
     30 #### Importing the Audiokinetic Reaper Tools repository
     31 1. In the REAPER menu, go to **Extensions** > **ReaPack** > **Import Repositories**.
     32 
     33 2. In the dialog, insert the url of Audiokinetic's Reaper Tools repository (https://github.com/Audiokinetic/Reaper-Tools/raw/main/index.xml) and click Ok.
     34 
     35 #### Installing ReaWwise
     36 1. In the REAPER menu, go to **Extensions** > **ReaPack** > **Browse Packages**.
     37 
     38 2. Right-click the ReaWwise package and select the version that you want to install.
     39 
     40 3. Click **Apply** in the lower right corner of the dialog to complete the installation.
     41 
     42 4. Restart REAPER to use the latest installed version of ReaWwise.
     43 
     44 ## Building from Source
     45 
     46 ### Requirements
     47 - Git
     48 - CMake (minimum version 3.22.0)
     49 - Platform-specific build tools (Visual Studio or XCode)
     50 - Wwise with SDK (minimum version 2021.1.1)
     51 - WWISESDK environment variable set to the path of the installed Wwise SDK
     52 
     53 ### Building
     54 ```cmd
     55 git clone https://github.com/audiokinetic/ReaWwise.git
     56 cd ReaWwise
     57 git submodule update --init
     58 cmake -B build
     59 cmake --build build --target ReaWwise --config Release
     60 ```
     61 After the binary is built, move it to the REAPER [UserPlugins directory](#userplugins-directory). If REAPER is open, restart the application. The extension is available in the **Extensions** menu.
     62 
     63 ## Basic Usage
     64 1. Open your REAPER and Wwise projects.
     65 2. Configure your REAPER render settings appropriately. The render settings determine which files will be transferred to Wwise.
     66 3. Open ReaWwise and configure settings such as the Originals Subfolder (optional), Import Destination, Wwise Structures, and so on.
     67 4. Preview the audio files and Wwise objects to be transferred in the Preview Panel.
     68 4. Click **Transfer To Wwise** to transfer the audio files and create the corresponding Wwise objects.
     69 
     70 ## UserPlugins Directory
     71 - Windows:  %appdata%\REAPER\UserPlugins
     72 - Mac: ~/Library/Application Support/REAPER/UserPlugins
     73 
     74 ## Other Resources
     75 Refer to the [ReaWwise User Guide](https://audiokinetic.com/library/reawwise) for more information regarding usage, installation and troubleshooting of the extension.
     76 
     77 For general questions about usage, refer to Audiokinetic's [Community Q&A](https://www.audiokinetic.com/qa/ask).
     78 
     79 ## Contributing
     80 The repository is not open to pull request but in the case of a bug report, bugfix or a suggestions, please feel free to [open an issue](https://github.com/audiokinetic/ReaWwise/issues).
     81 
     82 Feature requests can also be submitted to the [feature request section](https://www.audiokinetic.com/qa/questions/reawwise) of Audiokinetic's Community Q&A. Use ReaWwise as the Category when submitting a question.
     83 
     84 ## Legal
     85 Copyright © 2023 [Audiokinetic Inc.](https://audiokinetic.com) All rights reserved.
     86 
     87 ## Acknowledgements
     88 Inspired by the work of [Karl Davis](https://github.com/karltechno)