ReaLauncher

[solger]

Hello to all fellow Reaper users and welcome to the ReaLauncher discussion thread!


What's ReaLauncher?

ReaLauncher is basically a custom Lua-based version of the default Reaper startup prompt window with additional features.
Powered by Lokasenna's GUI library for Lua (see link in the 'Install instructions' below). So also a big thanks to Lokasenna for his work!


Although I'm currently testing things mainly under Windows 10, macOS 10.10.5 (Yosemite) and Linux (64-bit), I'd like to point out that this a 'work in progress' project.
So if anyone encounters or finds any bugs, errors, etc. please let me know including some basic info like:

• Operating system version / Reaper version / A short description of the issue (when is it happening & what is happening)

Feature overview:

• Linux, macOS & Windows support
• Separate tabs for Recent Projects, Project Templates, Track Templates, Projects and .RPL Project Lists
• Support for custom Project & Track Template folders (used in addition to the default locations)
• List filter at the top of each tab (supports multiple search words separated with a 'space' character)
• [Show in Explorer/Finder] button for browsing to the folder location of a selected file
• Global section with [New Tab], [New Project] and [Open Project] buttons
• Selection and loading of multiple entries (multi-select of listbox entries is already part of Lokasenna's GUI library)
• File paths can be shown/hidden
• 'Keep window open' checkbox
• Option to switch between Reaper Theme Slots (requires SWS Extensions)
• Resizeable window

Install instructions:

1. Install Lokasenna's GUI library for Lua via ReaPack. More info in the 'Installation' section in post #1: https://forum.cockos.com/showthread.php?t=177772
2. Install ReaLauncher via ReaPack.
3. Have fun!

• ReaPack: https://reapack.com/
• SWS Extensions: http://www.sws-extension.org/

Optional settings to show ReaLauncher on startup:

• Setting the command ID/identifier string (shown in the Action List) of the Script: solger_ReaLauncher.lua Action as SWS Startup Action (via the Extensions > Startup actions menu) - requires SWS Extensions.
• Preferences > General: Open project(s) on startup: Selecting [New project] (instead of the [Prompt] option which shows the default Reaper startup prompt window)

Tips & Tricks:

It's possible to select multiple listbox entries via:

• Shift + Left Mouse Click: Selection of adjacent listbox entries
• Ctrl/Cmd + Left Mouse Click: Selection of non-adjacent listbox entries
• Loading a single listbox entry is also possible via Double-Click

Shortcuts for loading projects with FX Offline:

• Holding Ctrl + Shift (Windows & Linux)
• Holding Cmd + Shift (macOS)
• Or using the 'Open with FX offline' option in the [Open Project] window

Release notes:

2019-01-30 - v1.0.1 - temporary removal of subversion filter due to further bugfixing & testing
2019-01-28 - v1.0.0 - https://forum.cockos.com/showpost.ph...&postcount=148
----------------------------------------------------------------------------------------------
2018-08-18 - v0.1.6 - https://forum.cockos.com/showpost.ph...1&postcount=94
2018-08-09 - v0.1.5 - https://forum.cockos.com/showpost.ph...3&postcount=92
2018-07-23 - v0.1.4 - https://forum.cockos.com/showpost.ph...0&postcount=79
2018-07-15 - v0.1.3 - https://forum.cockos.com/showpost.ph...9&postcount=67
2018-07-11 - v0.1.2 - fixed issue with empty lists, filter is now automatically applied when typing
2018-07-08 - v0.1.1 - changed filter and sort function structure, last window position is now remembered
2018-07-07 - v0.1.0 - first version released for public beta testing

[solger]

Here's the current collection of things/ideas/feature requests which are planned for future updates or might be cool to add (if doable):

GUI

• Theme options (adjusting colors, fonts)

General

• Project Templates: adjust loading behavior so it's similar to using File > Project Templates (loading Template as unnamed project)
• (Sub-) Folder structure support for template files
• Support for keyboard shortcuts
• Option to enable/disable "Prompt to save on new project" - It's already possible to set this via 'Preferences > Project: Prompt to save on new project', but I'll check if it makes sense to add this option directly in ReaLauncher, as well

Filter/Sort

• Sort: Option to invert order of filtered list

Feel free to post any additional ideas or feature wishes
I'll update the list and see what's doable.

[_Stevie_]

Hey Solger!

This is brilliant!
But I didn't expect otherwise.

Despite the fact, that I ran "Set Lokasenna_GUI v2 library path", solger_ReaLauncher.lua doesn't find the core.lua script (OSX here).
For testing purposes, I moved the script now to the folder containing the core.lua (works). Any idea what the problem could be here?

Some thoughts:
- would it be possible to make the filter field NOT case sensitive?
- pressing enter in the filter dialog executes "apply"

[solger]

Originally Posted by _Stevie_

Despite the fact, that I ran "Set Lokasenna_GUI v2 library path", solger_ReaLauncher.lua doesn't find the core.lua script (OSX here).
For testing purposes, I moved the script now to the folder containing the core.lua (works). Any idea what the problem could be here?

Ah, I knew I forgot to check something
Should work now - version in download link updated.

Some thoughts:
- would it be possible to make the filter field NOT case sensitive?
- pressing enter in the filter dialog executes "apply"

Added to the wishlist.

[_Stevie_]

Awesome, works perfectly now!

Another feature request:
- option to close ReaLauncher on load of project

[Lokasenna]

Hawt. Couple of things:

- Have you considered making this available via ReaPack? It makes updating the script way easier, since end-users can just click a button to do it, and it sidesteps issues a few people have found with some browsers and trying to download .lua files.

- Probably worth mentioning the SWS Startup Actions in your OP, and how to set this up with it. Users would also want to open Preferences | General and change "Open projects on startup" to New Project, if they were previously using the Reaper launcher.

- UpdateListFilters is re-sorting the list on EVERY loop and using an insane amount of CPU - 12% here on my laptop. In general, it's wise to check whether you need to re-sort so you can skip the function unless it's necessary. I just add a global variable here, but you may prefer storing it somewhere else:

local function UpdateListFilters()

  local filter = GUI.Val("tabs")
  if filter == last_filter then return end

  -- Recent Projects tab
  if filter then
    if RecentProjectFilterActive then
      GUI.elms.lst_recentProjects.list = filteredRecentProjects
    else
      -- Listbox sort mode: Default (most recent project at the top) / Ascending / Descending
      local sortMode = GUI.Val("menu_sort")
      if sortMode == 1 then
        SortDef()
      elseif sortMode == 2 then
        SortAsc()     
      else
        SortDesc()
      end
    end
  end
  -- Project Templates tab
  if filter then
    if ProjectTemplateFilterActive then
      GUI.elms.lst_projectTemplates.list = filteredProjectTemplates
    else
      GUI.elms.lst_projectTemplates.list = projectTemplates
    end
  end
  -- Track Templatse tab
  if filter then
    if TrackTemplateFilterActive then
      GUI.elms.lst_trackTemplates.list = filteredTrackTemplates
    else
      GUI.elms.lst_trackTemplates.list = trackTemplates
    end
  end

  last_filter = filter
end

- What's the purpose of the OSX + setfont code? My GUI automatically does that anyway.

- It doesn't make a difference, but your force-the-same-window-size code could actually go in GUI.onresize. It gets run at the beginning of each loop if the window has been resized; GUI.resized is set at the exact same time and works just as well, of course. Individual elements can also have an onresize method that will be called as part of their update loop as needed.

GUI.onresize = function()
-- check and force the resize
end

[_Stevie_]

Talking GUI, is there a way to save the position of the window, when you open it again?

[Lokasenna]

Originally Posted by _Stevie_

Talking GUI, is there a way to save the position of the window, when you open it again?

solger - I think I forgot to document these, but in Core.lua:
GUI.save_window_state
GUI.load_window_state

The 'name' parameter should be your script name or something.

[_Stevie_]

Awesome! Solger, if you could incorporate that, that would rock!

[Lokasenna]

The Sort box at the bottom isn't doing anything here. Not sure why.

[solger]

@Lokasenna: Thanks for the hints. I might have some time to look at this tomorrow.

Originally Posted by Lokasenna

- Have you considered making this available via ReaPack? It makes updating the script way easier, since end-users can just click a button to do it, and it sidesteps issues a few people have found with some browsers and trying to download .lua files.

Might most likely be one of the next steps

I haven't had time to check the Reapack webpage and the Development Thread yet for info about this: https://forum.cockos.com/showthread.php?t=169127
Or is there any info elsewhere about the necessary steps to do this? EDIT: found it

Originally Posted by Lokasenna

What's the purpose of the OSX + setfont code? My GUI automatically does that anyway.

Interesting. I'll have to check this again (perhaps I didn't have the latest version of your GUI library installed on OSX??)
I added the setfont and GUI.Listbox:drawselection() code because I had an issue here on OSX where the y-position of the selection rectangle was off when selecting elements further down in the listbox.

[solger]

Originally Posted by _Stevie_

Another feature request:
- option to close ReaLauncher on load of project

You can uncheck the 'window pin' checkbox at the top right.

Or do you mean with 'on load of project' something else?


Saving the position of the window is added to list.

[Lokasenna]

Originally Posted by solger

Or is there any info elsewhere about the necessary steps to do this?

The easiest way is to make sure it has a valid ReaPack header commented at the top (look at any ReaPack script's code for an example) and then upload it to the appropriate folder on the ReaTeam repo (/Project Properties probably). I'm not sure if you need to be given permission first... that would be a question for cfillion.

Alternatively, I can do it for you.

Interesting. I'll have to check this again (perhaps I didn't have the latest version of your GUI library installed on OSX??)

It's been there for ages - GUI.font multiplies the font size by 0.7 if you're on OSX.

I had an issue here on OSX where the y-position of the selection rectangle was off when selecting elements further down in the listbox.

Weird. Does that issue happen in the Listbox example script?

[solger]

Originally Posted by Lokasenna

The easiest way is to make sure it has a valid ReaPack header commented at the top (look at any ReaPack script's code for an example) and then upload it to the appropriate folder on the ReaTeam repo (/Project Properties probably). I'm not sure if you need to be given permission first... that would be a question for cfillion.
Alternatively, I can do it for you.

Thanks. I'll have a look at it (probably tomorrow).

Otherwise I'll post here again or send you a PM

Weird. Does that issue happen in the Listbox example script?

Good point. I'll check this in the example again, as well.

[solger]

Originally Posted by Lokasenna

The Sort box at the bottom isn't doing anything here. Not sure why.

Strange.

As a side note: The sort box currently affects only the Recent Projects Tab. Because I'm not sure yet if it's better to have one global Sort Box affecting all Tabs at the same time. Or if each Tab should get its own Sort Box ...

Originally Posted by Lokasenna

- Probably worth mentioning the SWS Startup Actions in your OP, and how to set this up with it. Users would also want to open Preferences | General and change "Open projects on startup" to New Project, if they were previously using the Reaper launcher.

Done

[Lokasenna]

Oh, I think I found it. My fix for the CPU usage is causing it to skip that entire function, so the sorting never happens. I'd suggest reorganizing it into smaller functions - one for checking the tab change, and one for checking the sort change.

[_Stevie_]

Originally Posted by solger

You can uncheck the 'window pin' checkbox at the top right.

Ahh, that's what the green checkbox is for! Yep, that's exactly what I meant.
However, the green box is checked again, when I re-open the dialog.
Is this on purpose?

[solger]

Originally Posted by _Stevie_

However, the green box is checked again, when I re-open the dialog.Is this on purpose?

Yeah, saving of these settings is not implemented yet. But this is one of the points already planned to be included in the next update ...

[_Stevie_]

Okay awesome! Hopefully I don't come across as nitpicking.

[solger]

Originally Posted by _Stevie_

Okay awesome! Hopefully I don't come across as nitpicking.

No worries!

That's basically what the first version is for: so that other Reaper users can test the current state and add comments, suggestions, feature-requests, etc.

[_Stevie_]

Whew, okay

[solger]

A quick update:

ReaLauncher is now available via ReaPack.

I also already did an updated version with the following changes:

- changed filter and sort function structure - should be more CPU friendly now
- last window position is now stored

Since I'm using GitHub for the first time, I'm currently reading through some ReaPack related links in order to figure out what's the best procedure for updating the script in the ReaPack repository.
In the meantime you can download the updated version via the download link in the OP.

[Lokasenna]

Yay.

- Switching to Asc or Desc sorting is instant, but there's a half-second of lag switching back to Default. Not sure why, but my first guess would be that it's reading the file list again rather than storing Name + Most Recent Order in memory.

Edit: This is with the ReaPack version, so... not the updated one. Not sure if that fixes it.

- IMO the Default sort should be labelled Most Recent, and should have the most recent at the top - that would make it identical to the native launcher's list.

- For bonus points, the sorting function could be split into two separate menu boxes - Recent/Alphabetical and Ascending/Descending.

- Noticed an issue with the caret being drawn outside the Filter box. That's a GUI bug; pushing a fix now.

[solger]

Originally Posted by Lokasenna

- Switching to Asc or Desc sorting is instant, but there's a half-second of lag switching back to Default. Not sure why, but my first guess would be that it's reading the file list again rather than storing Name + Most Recent Order in memory.

Yeah, currently the file list is read again. But this will be changed in a future update (in conjunction with another point) ...

- IMO the Default sort should be labelled Most Recent, and should have the most recent at the top - that would make it identical to the native launcher's list.

Good point about the naming.

- For bonus points, the sorting function could be split into two separate menu boxes - Recent/Alphabetical and Ascending/Descending.

I'll have a look at this.

- Noticed an issue with the caret being drawn outside the Filter box. That's a GUI bug; pushing a fix now.

Nice!

[DaveKeehl]

hey guys I just installed the ReaLauncher! Very cool idea! I don't understand if it's my computer or what but browsing through the tabs and selecting the projects is quite laggy (especially in the recent projects tab).
Am I the only one having this issue?

[_Stevie_]

Same here, are you running a Windows machine?

[solger]

Originally Posted by DaveKeehl

hey guys I just installed the ReaLauncher! Very cool idea! I don't understand if it's my computer or what but browsing through the tabs and selecting the projects is quite laggy (especially in the recent projects tab).
Am I the only one having this issue?

I already did an update which should hopefully make this better, but the updated version isn't up on ReaPack yet.


In the meantime you can download the 'solger_ReaLauncher.lua' file manually from the download link found at the bottom in post #1.

And then copy the file over the current 'solger_ReaLauncher.lua' one:
1) Options > Show Reaper resource path ..
2) Navigate to the subfolder 'Scripts\ReaTeam Scripts\Project Properties'
3) Copy the downloaded 'solger_ReaLauncher.lua' file over the old one

[DarkStar]

Good work

Related: https://forum.cockos.com/showthread.php?t=73999

[DaveKeehl]

Originally Posted by _Stevie_

Same here, are you running a Windows machine?

yes, I guess then it's a windows thing huh?

[DaveKeehl]

Originally Posted by solger

I already did an update which should hopefully make this better, but the updated version isn't up on ReaPack yet.


In the meantime you can download the 'solger_ReaLauncher.lua' file manually from the download link found at the bottom in post #1.

And then copy the file over the current 'solger_ReaLauncher.lua' one:
1) Options > Show Reaper resource path ..
2) Navigate to the subfolder 'Scripts\ReaTeam Scripts\Project Properties'
3) Copy the downloaded 'solger_ReaLauncher.lua' file over the old one

thanks I'll do it now

[akademie]

Installed per instructions (Lokasena library + this ReaScript).
First run Lokasena's library path script with no error.

But then, when I try to run main ReaLauncher script, I get this error:
"solger_ReaLauncher.lua:72: attempt to index a nil value"

It is on Windows 7 Pro 32bit, Reaper 5.92 - portable, SWS v2.8.3)

Any suggestions, please?
Thanks

[Fergler]

Great idea, always wished Reaper had a start screen like this.

[Lokasenna]

Couple of general script observations:

- Lua can do block comments rather than having to comment each line if you want:

--[[
   Blah
     blah
  blah

     blah blah blah
blah
]]--

- You should be able to use / as a file separator on both Windows and OSX without any trouble. Windows will quite happily let you mismatch them: C:/Users\\Me\\AppData/Roaming/Reaper/Scripts\\ReaTeam Scripts/stuff.lua

- Reaper has a function for getting values from an .ini if you want: retval, string = reaper.BR_Win32_GetPrivateProfileString( sectionName, keyName, defaultString, filePath ). Ignore the name; it should work on OSX just fine.

- You can wrap ShowConsoleMsg in a helper function to save a bit of typing, and having to remember the \n each time - in fact, GUI.Msg("my string") is ready to do it for you. You can also include the debug check in a helper rather than having to check each time:

local function Msg(str)
    reaper.ShowConsoleMsg( tostring(str) )
end

local function dMsg(str)
    if debug_enabled then reaper.ShowConsoleMsg( tostring(str) .. "\n" ) end
end

debug_enabled = true
Msg("this will always print")
dMsg("this will print")
debug_enabled = false
dMsg("this won't print")

[Edgemeal]

Interesting script, found minor? error..

With Recent List empty, click inside that list and then click the 'Load' or 'Load in Tab' buttons and it throws error, (string expected, got nil).

ReaLauncher 0.1.1
Lokasenna_GUI: v2.11.1
Reaper (portable): 5.80/x64
Platform: Win64

EDIT Same error for Project & Track templates tab, click inside empty list, then click load/insert button, throws error.

[solger]

The first update (0.1.1) is now also up on ReaPack. So if you haven't already, run Extensions > ReaPack > Synchronize to get the latest version.

Originally Posted by Lokasenna

Couple of general script observations:

Cool. Thanks for the hints.

[solger]

Originally Posted by Edgemeal

Interesting script, found minor? error..

With Recent List empty, click inside that list and then click the 'Load' or 'Load in Tab' buttons and it throws error, (string expected, got nil).

ReaLauncher 0.1.1
Lokasenna_GUI: v2.11.1
Reaper (portable): 5.80/x64
Platform: Win64

Nice find. Thanks.
Will have a look at this.

[Lokasenna]

The very first line of that crash report includes a line number where the error code - it would probably be very helpful in isolating the problem.

[Edgemeal]

Click inside empty Recent List, click Load button,..

Error: solger_ReaLauncher.lua:277: bad argument #1 to 'Main_openProject' (string expected, got nil)

Stack traceback:
	Core.lua:65: in function <...am Scripts\Development\Lokasenna_GUI v2\Library\Core.lua:59>
		[C]: in field 'Main_openProject'
	solger_ReaLauncher.lua:277: in field 'func'
	Class - Button.lua:138: in method 'onmouseup'
	Core.lua:834: in field 'Update'
	Core.lua:393: in field 'Main_Update_Elms'
	Core.lua:260: in function <...am Scripts\Development\Lokasenna_GUI v2\Library\Core.lua:256>
		[C]: in function 'xpcall'
	Core.lua:256: in function <...am Scripts\Development\Lokasenna_GUI v2\Library\Core.lua:255>

Lokasenna_GUI:	v2.11.1
Reaper:       	5.80/x64
Platform:     	Win64

EDIT Same type of error for Project & Track templates tab, click inside empty list, then click load/insert button, throws error.

EDIT2
DropDown control has similar problem, click inside the empty recent list, click dropdown control to open it but don't select an item, instead just click on the empty list again, throws error...

Error: solger_ReaLauncher.lua:277: bad argument #1 to 'Main_openProject' (string expected, got nil)

Stack traceback:
	Core.lua:65: in function <...am Scripts\Development\Lokasenna_GUI v2\Library\Core.lua:59>
		[C]: in field 'Main_openProject'
	solger_ReaLauncher.lua:277: in upvalue 'BTN_RecentProject_Load'
	solger_ReaLauncher.lua:617: in method 'ondoubleclick'
	Core.lua:796: in field 'Update'
	Core.lua:393: in field 'Main_Update_Elms'
	Core.lua:260: in function <...am Scripts\Development\Lokasenna_GUI v2\Library\Core.lua:256>
		[C]: in function 'xpcall'
	Core.lua:256: in function <...am Scripts\Development\Lokasenna_GUI v2\Library\Core.lua:255>

Lokasenna_GUI:	v2.11.1
Reaper:       	5.80/x64
Platform:     	Win64

[solger]

Originally Posted by akademie

But then, when I try to run main ReaLauncher script, I get this error:
"solger_ReaLauncher.lua:72: attempt to index a nil value"

It is on Windows 7 Pro 32bit, Reaper 5.92 - portable, SWS v2.8.3)

Any suggestions, please?
Thanks

According to the error message I'm guessing that line 63/64 (version 0.1/0.1.1) 'resourcePath = reaper.GetResourcePath()' couldn't somehow retrieve a resource path (which the script is trying to access later)
I'll have to check this.



In the meantime:

- When you open the script in the Action List via the [Edit...] button and then run it from the editor via the [Start] button: does 'resourcePath' show any value on the right?

- In addition, you can also try if the error is gone when setting the Reaper resource path (Options > Show Reaper resource path ...) manually by editing line 63/64 in the script:
Exchanging the bold part:

resourcePath = reaper.GetResourcePath()

... with the resource path (in quotes):

resourcePath = "<enter the Reaper resource path here>"

[Tim Rideout]

One thing I absolutley cannot understand in Reaper's organisation of Project Templates: Why are they not Folder-Structurable - like the Track templates.

IE:

MIX>>Live Band
>>Orchestral
>>5 Stem TV project
MASTER>>CD
>>Voice-Over
RECORD>>Live Band
>>Acoustic Duo

Etc...

At present, I have 40 templates, and they are all in a big list..
If you could fix this, you would forever rock. Even more than you already do...

T

Originally Posted by solger

Here's the current collection of things/ideas/feature requests - which are planned for future updates or might be cool to add (if doable):

• Additional 'Projects' Tab (with the option to add a custom project folder path)
• Option to add custom folder paths for Track & Project Templates (in addition to the default paths)
• Option to show the full file paths (and maybe also with the possibility to open the folder location directly in Explorer/Finder)
• Save window settings (as example: 'window-pin' setting, last text entries in the filter boxes, custom paths, etc.)
• Option to 'Open with FX offline'
• Option to remove list entries

Filter/Sort

• Filter: additional/other options (like 'not case sensitive')
• Filter: Accept (enter) key input for 'Apply'
• Sort: Separate boxes for Recent/Alphabetical and Ascending/Descending

Feel free to post any additional ideas or feature wishes
I'll add them to this list and see what's doable.