RadiS Radial Menu System
http://radis.sf.net/

Copyright (C) 2009  Johannes Frank

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Contents
--------
1. Overview
2. Features
3. Installation
4. Quick Usage
5. Acknowledgements
6. Requirements
7. Feedback


1. Overview
   --------
   RadiS is a small program that allows the user to have shortcuts at his
   disposal around his mouse curser at the press of a shortcut key combination.
   Due to the native library required for Global Hotkeys, this Program runs
   ONLY on Windows.

   If you ever played Neverwinter Nights (1), you might have noticed the cool,
   radial context-menu that popped up whenever you clicked on an object.
   In this menu, you could select your actions, such as casting a spell,
   attacking or whatever else seemed suitable. If you chose to cast a spell,
   a sub-menu opened to give you a choice of spells at your disposal.
   
   I always loved that menu.

   So we wrote it for windows. And made it cooler.

2. Features
   --------
   -> Radial Menu that opens on a global hotkey combination (currently WIN+A)
   -> Very simple to configure. Reads most its settings from its folder by itself.
   -> Anything that can be called using the shell can be used in Radis 
	(via .bat / .png combination)
   -> Also, every Windows .lnk can be read

3. Installation
   ------------
   There is nothing to install. Copy the content of the archive to a location
   of your choice and run the program by clicking "radis.jar". For maximum
   convenience, add a link to the "radis.jar" to your Autostart.

4. Quick Usage
   -----------
   In order to use RadiS, you have to commit some files to its "content" folder,
   following a couple of rules.
   RadiS supports two different types of elements: Folders and Shortcuts

   Shortcut:
      In order to add a shortcut to RadiS, you have to provide two files:
      A .bat file containing the command to execute on click and a .png file
      containing the Icon to display for this shortcut. Both files have to have
      exactly the same name (except the .bat/.png part of course) and can lie
      either in "content" or any sub-directory you might have created.
      Currently, the files MUST have an underscore (since anything BEFORE that
      underscore is used to sort the files, 00_ comes before 01_) and must NOT
      have Spaces. 
      An example set of files would be "00_Calc.bat" and "00_Calc.png"
      
      Since Version 0.4, RadiS also allows the use of simple Windows Shortcuts 
      (".lnk" files). 
      For these, all you have to do is put the Shortcut of your
      choice into the content Folder. RadiS will then extract the Icon, Name and
      Action automatically.
      
      Since Version 1.0, RadiS also allows for drag and Drop of Windows Shortcuts
      For this, you first have to fixate RadiS (so that it doesn't move or hide
      when it looses focus) and then simply drag a shortcut onto the RadiS center
      circle (or one of the subcircles)
      
   
   Folders:
      In order to add a sub-menu, you have to add a folder to the "content" 
      root folder. This folder has to follow the same naming rules as Shortcuts.
      However, the icon for that folder has to be inside that folder in a file 
      named "default.png".
      An example folder could be "00_Editors" with an image 
      at "00_Editors/default.png".
      
      Since Version 0.4, RadiS also allows the use of Windows Shortcuts as 
      references to directories. Therefore, if you put a shortcut to a directory
      into the content folder, RadiS will treat that shortcut like a real
      directory and process its content. You can configure that behavior on the
      Configuration Dialog.
    
   After everything is set up, you can start RadiS by double-clicking the
   "radis.jar". After that, pressing WIN+A will pop up RadiS around your current
   cursor position. This shortcut can also be configured in the Configuration
   Dialog.
   
   In order to close RadiS (should you ever want to) you can press ALT+F4
   while RadiS is visible. You can also right-click on the RadiS icon in the
   tray bar and select "Shutdown".

   If you press F1 (or use the "Help" field in the tray bar icon) you will get
   a Window with this file in it for help.

   A demonstrational Set of different Shortcuts is available with the
   distribution package of RadiS.

5. Acknowledgements
   ----------------
   RadiS is distributed with a small number of libraries on which it depends.
   Those libraries are:

   -> JIntellitype (http://melloware.com/products/jintellitype/index.html)
      This native windows library with Java Wrapper allows RadiS to use
      global hotkeys in Windows.
      I also somewhat took their readme.txt design for this Readme :)
   -> Log4J (http://loggign.apache.org)
      This is the java implementation of the appache logging framework and
      is used for debug logging

6. Requirements
   ------------
   Since RadiS uses some exotic technology, we have considerable requirements.
   The transparency is created using a proprietary and undocumented (wohoo)
   API by SUN introduced with Java 1.6.0_u12. Any jre older than that will have
   problems displaying transparency. Also, the API for reading .lnk files
   is proprietary and might break in future releases. We hope not though.
   
   Also, due to the fact that we use a native library to register global
   hotkeys, Windows as Operating System is required.

7. Feedback
   --------
   Your feedback on RadiS is always welcome. Positive feedback is preferred,
   though ;-). Please visit http://radis.sf.net/ for further information, 
   updates, bug tracker and contact.