Reaper-Tools

Audiokinetic Reaper Tools Repository
Log | Files | Refs

OpenAssociatedReaperProject.lua (3250B)

      1 @description Open Associated REAPER Project
      2 @author Audiokinetic
      3 @version 1.0.0
      4 @metapackage
      5 @provides
      6   [nomain] Utilities.lua https://raw.githubusercontent.com/audiokinetic/Reaper-Tools/$commit/OpenAssociatedReaperProject/Utilities.lua
      7   [nomain] OpenAssociatedReaperProject_Script.lua https://raw.githubusercontent.com/audiokinetic/Reaper-Tools/$commit/OpenAssociatedReaperProject/OpenAssociatedReaperProject_Script.lua
      8   [main] OpenAssociatedReaperProject_Install Wwise Command.lua https://raw.githubusercontent.com/audiokinetic/Reaper-Tools/$commit/OpenAssociatedReaperProject/OpenAssociatedReaperProject_Install%20Wwise%20Command.lua
      9 @changelog
     10   Initial release.
     11 @about
     12   # Open Associated REAPER Project
     13   The Open Associated REAPER Project package allows you to open the associated REAPER project of a rendered wav file used in a Wwise project.
     14   The package consists of three scripts:
     15    - OpenAssociatedReaperProject_Install Wwise Command.lua installs the "Open Associated REAPER Project" Wwise command to open the associated REAPER project of a rendered wav file an configure the root lookup directory for the REAPER source projects.
     16    - OpenAssociatedReaperProject_Script.lua is used by the Wwise command to find the associated project and region from the wav file.
     17    - Utilities.lua expose utilities and helper functions for the previous two scripts.
     18 
     19   ## Setup
     20   To complete the installation, run the OpenAssociatedReaperProject_Install Wwise Command.lua action.
     21 
     22   It will install the Wwise custom command: "Open Associated REAPER Project" and configure your REAPER projects root directory.
     23   The same action can be use to update the REAPER projects root directory.
     24 
     25   ## Minimum Requirements
     26   REAPER v6.80
     27   ### Important Note
     28   Open Associated REAPER Project needs the Start offset and Title metadata embedded in the rendered file, make sure "Embed title/date/time if not provided" and "Embed start offset (media position in project)" in the REAPER Project Render Metadata are enabled before rendering the file.
     29 
     30 
     31   ## License
     32   Copyright (c) 2023 AUDIOKINETIC Inc.
     33 
     34   The script in this file is licensed to use under the license available at:
     35   https://raw.githubusercontent.com/audiokinetic/Reaper-Tools/main/License.txt (the "License").
     36   You may not use this file except in compliance with the License.
     37 
     38   Unless required by applicable law or agreed to in writing, software distributed
     39   under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
     40   CONDITIONS OF ANY KIND, either express or implied.  See the License for the
     41   specific language governing permissions and limitations under the License.
     42 
     43 @license
     44   Copyright (c) 2023 AUDIOKINETIC Inc.
     45 
     46   The script in this file is licensed to use under the license available at:
     47   https://raw.githubusercontent.com/audiokinetic/Reaper-Tools/main/License.txt (the "License").
     48   You may not use this file except in compliance with the License.
     49 
     50   Unless required by applicable law or agreed to in writing, software distributed
     51   under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
     52   CONDITIONS OF ANY KIND, either express or implied.  See the License for the
     53   specific language governing permissions and limitations under the License.