README file for JSonar (JAWS Scripts for Cakewalk Sonar), version 5.4

Copyright (©) JSonar Development Team.
JSonar is subject to the terms and conditions of the GNU General Public License. The full text of the license can be found in the file license.txt distributed with these scripts.

Contact us through the JSonar web site.


*** Please READ ME before you ask questions! ***

If this is your first time using JSonar, please skim through this README file to familiarize yourself with features supported and, most importantly, for helpful tips and tricks to help you along the way.

To you: thanks for joining the JSonar community of users!

If you are upgrading from an earlier version of JSonar, please read the Revision History. It describes the changes made in each version of JSonar and may include useful information for those upgrading from earlier versions.


Contents of this README

  1. Credits
  2. Requirements
  3. Manual Installation Instructions
  4. Configuring Sonar and JSonar for bbest use
  5. Supported Sonar Features
  6. Plug-in support via Hot Spot Clicker
  7. Known Issues and Troubleshooting
  8. Tips and Tricks
  9. Revision History

Credits

Throughout the existence of the JSonar project, many people have helped us in various ways to keep the project going; either by donating money, translating scripts and documentation into other languages, contributing code, finding bugs, or encouraging the project in other ways. Therefore the following list of contributors is not by any means complete.


Requirements

In order to use JSonar, you will need the following:


Manual Installation Instructions

Note: If you installed JSonar using the installer, these steps have been performed automatically and you should continue to the configuring Sonar and JSonar for best use section. Please be aware that the installer is the recommended way to install JSonar. The zip archive should only be used in special circumstances and by advanced users. If you decided not to use an installer but instead use a zip archive (not recommended), follow these steps after unzipping the scripts:

  1. Switch to the folder where you unzipped the scripts.
  2. Find and switch to the regkeys folder.
  3. Look for files with an extension .reg and the name containing your particular version of Sonar, e.g. the file with registry entries for Sonar 5.0 Producer Edition would be called "Sonar Producer 5.0 Accessibility Mode.reg".
  4. Press ENTER key on that file and answer positively to the two dialog boxes that are presented.
  5. Move back to the previous folder and switch to the surface folder.
  6. Copy the file named jsonar.dll to a Permanent location on your system drive; e.g. c:\Program Files\JSonar 5.
  7. Register jsonar.dll in this new location with a command like the following from the Start menu->Run dialog:
    regsvr32 "c:\Program Files\JSonar 5\jsonar.dll"
  8. Now proceed to the Configuring Sonar and JSonar for bbest use section for your first run of Sonar and the JSonar scripts.


Configuring Sonar and JSonar for bbest use

For best results with Sonar and JSonar, please follow the steps outlined below:

  1. *** This step is essential!!! ***
    Upon running JSonar scripts for the first time, use Control+JAWSKey+R to start the "Setup Wizard", which enables the Sonar JAWS control surface plug-in. You need only do this once, unless JSonar complains that the surface is not installed at a later time.
  2. In order to run JSonar optimally in Sonar 5, it is necessary to configure Sonar toolbars in the following way. In order for some information to be read or commands to function, certain toolbars must be enabled in Sonar while others have to be disabled. The visibility of toolbars can be toggled in the Toolbars dialog under the View menu. Some toolbar names are self-explanatory, but notes have been included where this is not the case:
    1. Inline Piano View (shift Tab from General) (unchecked)
    2. Standard (checked): "new", "open", "print" etc.
    3. Loop (checked): looping, punching, set loop to selection etc.
    4. Markers (checked): insert, delete and move between markers.
    5. Metronome (checked): , audio metronome, MIDI metronome, set metronome options etc.
    6. Position (checked): Now time etc.
    7. Record (checked): autopunch, recording options etc.
    8. Playback State (checked): mute/solo/arm/input echo for all tracks etc.
    9. Controll Surfaces (checked): control surface monitoring, etc.
    10. Select (checked): From and Through times.
    11. Sync (unchecked)
    12. Tempo (checked)
    13. Transport (checked)
    14. Transport (Large) (unchecked)
    15. Views (unchecked)
    16. Automation (checked): Envelope/Offset mode etc.
    17. Event Inspector (unchecked)
    18. Allow Wrap (unchecked)


Supported Sonar Features

JSonar primarily supports the following features of Sonar:


Plug-in support via Hot Spot Clicker

We are now using Hot Spot Clicker software to provide support for many of the third-party plug-ins and software synthesizers. In order to use some of the built-in Sonar plug-ins, such as Session Drummer2 and sonitus suite of effects, you will have to install the Hot Spot Clicker program. Otherwise, you will not be able to use those and other plug-ins because they are not natively accessible. To help you out,, the JSonar installer will copy for you all the hot spot sets that support Sonar's built-in plug-ins. Please note: if you installed JSonar scripts manually, you will have to copy all the necessary HSC sets on your own.

The following are the steps to get started with Hot Spot Clicker:


Known Issues


Tips and Tricks

Here are some initial suggestions to help you along the way:


Revision History

The following is a summary of the changes in each revision. Note that there are most certainly other minor, less noteworthy changes, fixes, etc. not included here for brevity.

Key: new = new feature, bug = bug fix or work around, change = change in functionality.

5.4

5.3

5.2


5.1


5.0


5.0 beta 1


4.0 beta 6


4.0 beta 5


 

4.0 beta 4 and prior