Jump to content


Photo

How To Start Editing Duplex Files

duplex xrnx faq

  • Please log in to reply
10 replies to this topic

#1 satobox

satobox

    Guruh Motha Fakka is Levitating and Knows Everything About Renoise Member

  • Renoise Team
  • PipPipPipPipPipPipPipPipPipPipPipPipPip
  • 1533 posts
  • Gender:Male

Posted 13 January 2011 - 06:34

[Intro]

Maybe there are some people who are interested in making their own Duplex files, but since it seems to be difficult, they cannot start editing. So I try to explain how to start editing Duplex files here. Actually, it is not so difficult as you've worried by the looks. Lua scripting skill is not necessary almost.

First of all, this explanation was made in order to supplement the Duplex manual. Many important things are described in the manual. So I strongly recommend referring to it. (Japanese is here)

---------------------------------------------------------------------------

[About directory of Duplex]

Basically, you need to make these files and folders like below. And the files and folders should be renamed to the name of your controller properly.

directory.png

- YourControllerName (folder)

-- Configrations (folder) --- FunctionalName.lua (for configrations & application mappings)

-- Controlmaps (folder) --- YourControllerName.xml (for specifying the layout of knobs, buttons, and faders)

-- YourControllerName.bmp (the thumbnail picture of your controller)

-- YourControllerName.lua (for additional configrations, color code, etc)

Since it is difficult for a beginner to start making these from scratch, I prepared the files for a fictitious controller called "R-control" tongue.gif . If you want to make these files to be for your controller, please change the part described "R-control" in the files (and all file names too) to your controller name.

Attached File  R-control.zip   4.62KB   550 downloads
Download and unzip this file, and put the "R-control" folder to;
 

Windows: C:\Users\YourName\AppData\Roaming\Renoise\V?.?.?\Scripts\Tools\com.renoise.Duplex.xrnx\Duplex\Controllers

OSX: Macintosh HD\Users\YourName\Library\Preferences\Renoise\V?.?.?\Scripts\Tools\com.renoise.Duplex.xrnx\Duplex\Controllers

Linux: a hidden folder in the user's home folder: ~YourName/.renoise/V?.?.?/Scripts/Tools/com.renoise.Duplex.xrnx/Duplex/Controllers

excl.gif Also, you can open the Renoise Preferences folder by clicking Renoise's main menu [Help] >> [Show the Preferences Folder...]. Then follow the path Scripts/Tools/com.renoise.Duplex.xrnx/Duplex/Controllers
 


then click the Renoise's main menu [Tools] >> [Reload all Tools]. After that, you can find "R-control Mixer + Transport..." in the Duplex config list.

#########################################################################

To enable the Renoise's Scripting Treminal & Editor, please read this page.

script-editor.png

#########################################################################

-------------------------------------------------------------------------

[Explanation of each file]

1) R-control.xml

This xml file is for specifying the layout of knobs, buttons, and faders. Making layout is not so difficult if you have an experience of making simple web layout etc.
However, only by making this xml file, you cannot open the Duplex's Browser. In order to check the actual graphic interface, it is needed both "R-control.xml" and "R-control_MixerTransport.lua".

xml-xxx.png


2) R-control_MixerTransport.lua

This lua file is for some configrations & application mappings. Here, you can map each application to the group of knobs and buttons which specified within the xml file above.

Also, if you want to add another new application mappings to your controller, you should make the same kind of this file separately (i.e. "R-control_Effect.lua", for example).

[Note]: In some case of the controller with the buttons which change their color (for example Launchpad), it's necessary to add some special code to the "R-control.lua" file. In such a case, since it is difficult for a beginner, please ask for advice in the forum.

lua-xxx.png


3) Application files

The application files are functional files equipped in Duplex by default. You do not need to edit those files at all.
Currently there are 7 applications (Effect, Matrix, Mixer, Navigator, Recorder, StepSequencer, Transport). Each app have some useful functional mappings. So you should open and see each file to know the mapping names which you want to use.

mixer-app.png


-------------------------------------------------------------------------

[Let's try]

Probably, in order to complete the layout which you desire, it will be required some trial and error like;

- Edit xml & lua files for your controller
- Save these files
- Reload all Tools
- Open Duplex Browser and check whether the layout/mapping works well or not
- Edit again
...

When you are stuck, try to refer to the Duplex manual, seek and learn from the other Duplex files, or ask in the forum. Though you need perseverance a bit, when Duplex works as you thought, you will be impressed. Let's try.



excl.gifSafekeeping is recommended!!###############################

If you want to update Duplex itself, remember that all device configurations and settings are backed to default.
This means, your custom configuration maps are lost completely too.
Unfortunately, this is a Renoise script tool's feature, so please don't forget to copy your custom configuration files to another place always.

excl.gif ########################################################



P.S. I welcome the correction without notice if there is strange words or explanations. smile.gif

 


  • taktik, Eran Dax Lonker, danoise and 8 others like this

まいどお~きに Renoise-Gate (Japanese Tutorial)


#2 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7083 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 13 January 2011 - 18:02

I'm not sure why, but the scrollbar disappears in my web-browser when reading this post. (Safari on OSX)

Edit: Nevermind, after replying it's back to normal. Thanks Satobox!

Edited by Conner_Bw, 13 January 2011 - 18:03.

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : One million clicks! »


#3 eeter

eeter

    Guruh Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPip
  • 807 posts
  • Gender:Male
  • Location:Estonia, Jõgeva
  • Interests:Renoise, music, party, psychedelics, beer(<3!!!), travelling.

Posted 13 January 2011 - 23:29

Great post Sato!! Much appreciated!

#4 Cornbeast

Cornbeast

    Super Advanced Member

  • Normal Members
  • PipPipPipPip
  • 179 posts

Posted 02 March 2011 - 08:01

Great post! Just what I needed to get started...

#5 Neurogami

Neurogami

    Big Super Masta Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPip
  • 603 posts
  • Gender:Male
  • Location:Scottsdale AZ
  • Interests:Art, music, technology

Posted 09 March 2012 - 20:58

The link to the Duplex manual ("First of all, this explanation was made in order to supplement the Duplex manual. ") just links back to this page.

#6 danoise

danoise

    Probably More God or Borg Than Human Member

  • Renoise Team
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 6419 posts
  • Gender:Male
  • Location:Berlin
  • Interests:wildlife + urban trekking

Posted 09 March 2012 - 21:11

The link... just links back to this page.

Hmm, works here. Your browser either does not accept downloads or you have no PDF reader installed?
You can right-click the link and save the file, right? Then get something like the Foxit PDF reader (Windows) if you don't like bloated Adobe software ;)

Tracking with Stuff. API wishlist | Soundcloud


#7 fuzzcreatorhasenpfeffer

fuzzcreatorhasenpfeffer

    Member

  • Normal Members
  • PipPip
  • 41 posts
  • Gender:Male
  • Location:NYC

Posted 19 June 2014 - 06:24

Hmm, works here. Your browser either does not accept downloads or you have no PDF reader installed?
You can right-click the link and save the file, right? Then get something like the Foxit PDF reader (Windows) if you don't like bloated Adobe software ;)/>

Its a few years later but...just wanted to add my thanks and appreciation to all for this thread. Once I have the time to get into lua-scripting I know this will be helpful in getting organized and on the good foot!

cpu Intel Mac Mini Server (2013) os Mac 10.12.3  storage Vertex4 128Gb SSD, Synology 8Tb NAS  audio Tascam 16x08 USB  interface iConnectivity ICM4+  MIDI controllers Korg nanoKontrol2(x3), FCB1010 sound modules iPad(x2), DSI Tempest, Roger Linn Adrenalinn III


#8 danoise

danoise

    Probably More God or Borg Than Human Member

  • Renoise Team
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 6419 posts
  • Gender:Male
  • Location:Berlin
  • Interests:wildlife + urban trekking

Posted 19 June 2014 - 11:28

Its a few years later

Luckily the information is still largely relevant.

From my side, focus has however shifted toward documenting the project using comments within the code itself, and then creating HTML files from that (look inside the /Docs folder that come with Duplex).
Doing it like this makes the information more likely to be fully up to date, and closely tied to the actual source code instead of being spread all over the place.

But nevertheless, satobox did a very good job here. This article will probably survive, whereas the PDF manual will slowly go more and more out of date.

Tracking with Stuff. API wishlist | Soundcloud


#9 Eran Dax Lonker

Eran Dax Lonker

    Guruh Motha Fakka is Levitating and Knows Everything About Renoise Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPip
  • 1248 posts
  • Gender:Male
  • Location:Germany

Posted 21 May 2016 - 12:38

can somebody confirm, that the application options overwrite in the controller configuration not working at all! :wacko:
 

I tried everything ... also deleting the Duplex preferences.xml and restarting Renoise and Duplex completely.

  applications = {
    StepSequencer = {
      -- ORIENTATION.VERTICAL layout (default)
      mappings = {
        grid = {
          group_name = "Grid",
          orientation = ORIENTATION.HORIZONTAL,
        },
      },
      options = {
        ### NOT WORKING ###
        line_increment = 8,
        follow_track = 1,
        page_size = 5,
      }

Edited by Eran Dax Lonker, 21 May 2016 - 12:45.


#10 danoise

danoise

    Probably More God or Borg Than Human Member

  • Renoise Team
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 6419 posts
  • Gender:Male
  • Location:Berlin
  • Interests:wildlife + urban trekking

Posted 21 May 2016 - 12:42

can somebody confirm, that the application options overwrite in the controller configuration not working at all! :wacko:

A device configuration is nothing but a starting point (acting as default settings).
Once you have launched Duplex it stores your settings - so you will need to delete the preferences.xml to revert back to the defaults.

To delete the settings you will need to disable the tool (Tool Browser), delete the file and restart the tool.

Tracking with Stuff. API wishlist | Soundcloud


#11 Eran Dax Lonker

Eran Dax Lonker

    Guruh Motha Fakka is Levitating and Knows Everything About Renoise Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPip
  • 1248 posts
  • Gender:Male
  • Location:Germany

Posted 21 May 2016 - 12:49

Ok. Disabling the tool was the missing step! Thanks! :)







Also tagged with one or more of these keywords: duplex, xrnx, faq