Sign In:     

Forum: VirtualDJ Technical Support

Topic: Where can I find a VDJ script reference?
In the annex https://virtualdj.com/manuals/virtualdj/appendix/vdjscriptverbs.html there is only a list of verbs. That list lacks the verbs' parameters (e.g., see "fadeout"). It only provides some verb examples demonstrating verb usage.

Is there a VDJ script reference page available, explaining language flow syntax in a structured form and listing all verbs including their parameters and corresponding annotations?
 
Posted 3 days ago @ 12:04 pm
On almost all cases, parameters are given thru examples in order to understand how they work.
So, fadeout gives a clear example with all it's parameters, and both ways it can be used.

What do you miss ?
 
I'm actually missing a structured, full-fledged script reference, like, e.g., this one:

https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-childitem

It's explaining:
- What parameters are there?
- What's the parameters' allowed types?
- What's the indicator for a type unit?
- What parameters are mandatory? Which are optional?
- Are function calls synchronous or asynchronous? How can I switch?

It's things like that I'm looking for to be able to create scripts.
 
You don't need all that to create scripts.

Scripts for the most part are meant to be simple, because VDJ script is meant to be used by the average "Joe" to enhance the functionality of his software.
It's not meant to be used as a programming language, thus it's not that strict on it's syntax.

Therefore a list like the one you seek does not currently exist, nor I'm sure it makes sense to build one since it's out of the scope of VDJ script itself.
 
A proper reference manual with those details for vdjscript, AFAIK, doesn't exist. However that doesn't mean you can't write scripts, it just means you have to do a bit more to understand the syntax and expectations for verbs.

While the official starting point is here:
https://virtualdj.com/wiki/VDJScript

https://virtualdj.com/manuals/virtualdj/appendix/vdjscriptverbs.html

You'll quickly find it's very concise and a lot of details may not be spelled out.
To date, the best way I believe most people have found is:

  • Locodog's script page

    That post basically is the hand holding that everyone seeks (like a "Getting started" guide, although it's not a proper reference in the conventional sense), but it is highly suggested you read through that post, and Locodog regularly updates it

  • Looking at example scripts already written for pad pages, controllers and in skins
    Probably the quickest way to get something close to what you want in a lot of cases.

    Also check out the VDJScript Examples page
 
Thanks for pointing me to this valuable information! I'll dig through it then …

> it just means you have to do a bit more to understand the syntax and expectations for verbs.

Well, to the most part it means wasting time going the try & error approach.

As far as I can see, the editor doesn't support parameter tooltips, nor does it have a step debugger, a console that logs the actions, states or issues during script execution, nor a [Test] button in the editor. This makes scripting a rather tedious and frustrating task.
 
Just ask, that's how everybody good at script got good at script, there's no courses.
Sure knowing some programming will help, a bit, but you'll still have to ask questions, just more technical questions, technical people are usually easier to answer.

test from a custom_button usually it's better than the mapping window, unless you're dealing with a hw input that sends an implicit then I test from pad_param in a padpage.

If you're doing something really complicated, scatter set varName VALUE in your script to see where it got to in var_list
there's also this as an example

set thing 0.1 & get_var thing & param_cast & debug
 
Axel D. wrote :
As far as I can see, the editor doesn't support parameter tooltips, nor does it have a step debugger, a console that logs the actions, states or issues during script execution, nor a [Test] button in the editor. This makes scripting a rather tedious and frustrating task.

Because it's meant to be simple. It's meant to be used by simple people, not programmers.
You average DJ has no clue what a step debugger is, nor how to use it.
And for the most tasks an average user would want to script, a debugger is overkill IMHO.