How to include the samples when building the plugin?

[daniloprates]

Is there a way to re-trigger this screen?

After deleting the samples and replacing the component file the plugin didn't ask to install the samples and it's muted

[d.healey]

@daniloprates

Yes, delete the link file in the app data folder and the screen will show up again the next time you launch the plugin. I cover this in the HISE Bootcamp too.

HISE Bootcamp: No Coding Required – Audio Dev School

A beginner-friendly course that teaches you how to build real, working audio plugins using HISE - without writing any code.

It’s designed for musicians, sound designers, and audio creators who want to bring their plugin ideas to life without learning a programming language.

The course is structured around two complete projects: first, you’ll build a custom sample library instrument, and then you’ll create a spatial audio effect plugin.

Along the way, you’ll learn how to use HISE’s visual interface to import and map samples, design user interfaces, connect modulation sources, and export your finished plugins.

Every lesson focuses on practical skills, and you’ll get access to guidance notes, cheat sheets, and supporting materials to help you stay on track.

By the end of the course, you’ll have built two working plugins - and you’ll have the confidence to keep creating, no coding required. You’ll also receive a certificate of completion to showcase your skills.

(audiodevschool.com)

[daniloprates]

@d-healey great!

Do you know if it's possible to add a button in HISE that re-triggers that screen, in case the user wants to relocate the samples?

[d.healey]

@daniloprates Yes you could script a button that deletes the file, the user would still need to restart the plugin though.

It's probably more user friendly to script a custom screen where the user can select a folder. All the functions needed for this are available in the scripting API.

[jeffd]

@d-healey

Where in the scripting API is the link file in the app data folder referenced?
If one wanted to create a button to reset the sample folder for the user if they decided to move the samples.

[d.healey]

@jeffd You can use the file and file system APIs to access the app data folder.

You can use Settings.setSampleFolder() to update the link file.

[jeffd]

@d-heale
ok let me try it.
thanks

[jeffd]

@jeffd ```
so I created a button to reset the sample folder for the user,
but it doesnt retrigger a reset for the compiled plugin. I dont get any scripting errors in HISE but I am missing something.
what could be wrong here?

code_text

inline function onResetBtn(control, value)
{
    if(value) // button is pressed
    {
        // This clears the sample folder setting
        Settings.setSampleFolder("");

        
        Console.print("Sample folder has been reset. The plugin will ask for a new folder next time.");
        
        
        Engine.showMessageBox("info", "Please restart the plugin or reload it to set a new sample folder.", "OK");
    }
}
ResetBtn.setControlCallback(onResetBtn);

[Lindon]

@jeffd er.. doesnt that just give you an empty Link file? what you actually want in this approach is to have the link file deleted.

You'd be way better off just asking (in the plugin) for the new folder...and replacing the current Link file value.

[d.healey]

@jeffd As Lindon says, to retrigger the overlay you need to delete the link file entirely, not just change the path within it.

[jeffd]

@d-healey can i delete the link file via a script?
not sure i understand.

[d.healey]

@jeffd Yes, the file and filesystem API has what you need. Just be careful when deleting files.

[jeffd]

@d-healey
isnt the link file going to be located in a different location for each operating system?

Is there documentation somewhere on how to get HISE to find the path in the operating system?

[d.healey]

@jeffd

These should help

https://docs.hise.dev/scripting/scripting-api/filesystem/index.html#getfolder
https://docs.hise.dev/scripting/scripting-api/filesystem/index.html#special-locations