Installing Unshake

Meerkat says - You looking at me,
mate?

Contents

  1. Installing Unshake for Java
    1. System Requirements
    2. Installation Under Windows
    3. Installation Under Unix
    4. Installation on Mac's
  2. Installation of the C version under Linux
  3. Mirroring
  4. Disclaimers and Acknowledgements
  5. Technical note

Installing Unshake for Java

System Requirements

You will need Sun's Java 2, or a Java 2 which includes Sun's JPEG routines, "com.sun.image.codec.jpeg". It is relatively easy to download, and instructions are given below. Apart from that, your system limits only the time taken to "Unshake" an image, and the size of image which can be processed: On a Gigahertz PC with 256 MByte of RAM, it should take less than 5 seconds for a 256 by 256 pixel image, and 4 times that for a 512 by 512 image. On a 300 Megahertz PC, it takes about 3 times as long, and on my little 75 Megahertz PC it takes nearly 15 minutes for a 512 by 512 pixel image!

RAM is also a consideration: My little PC only has 64 MByte of RAM, so it slows down a lot if I do anything else with it while it is processing a 512 by 512 pixel image.

So the conclusion is: If you can run Java 2, you can run Unshake, though if you have a small or slow computer, you will have to be patient. A newly bought PC should have no trouble at all running the code.

Installation Under Windows

  1. Download this zip file, and unpack it in a convenient place. A folder will appear called Unshake.
  2. Now you need to install Sun's Java 2 Runtime Environment, if you haven't already. It should be enough simply to install the Java Runtime Environment (JRE), and the best way to do that is to download it directly from here, or somewhere else in the site if that link is out of date. Use the SDK or JRE 1.4, if it is available for your machine, although earlier versions will be good enough.

    Make sure you do not download "Java 1", also known as "1.0" and "1.1". You need "Java 2", which is "1.2", "1.3" etc.

  3. You will now be able to run Unshake, from the launcher (see Use of Unshake, Instructions.html).
If you want an icon on your desktop which will launch Unshake, try right-clicking on "Launch" in the Unshake folder, and choosing copy, then pointing to your desktop and choosing "Paste Shortcut". Maybe I'll try creating a nice icon later. If you tell me that it matters!

Any updates for the code will be posted at http://www.hamangia.freeserve.co.uk/Updates/index.html, ISP's permitting.

Installation Under Unix

(Including Linux.)
  1. Download this zip file, and unpack it in a convenient place. A directory will appear called Unshake.
  2. Change directory to Unshake, and make the script unlaunch.sh executable;
    cd Unshake
    chmod 755 unlaunch.sh
    
  3. Now you need to install Sun's Java 2, if you haven't already. Download it directly here, or somewhere else in the site if that link is out of date. Use the SDK or JRE 1.4, if it is available for your machine, although earlier versions will be good enough. Follow Sun's instructions for installing it, bearing in mind that Unshake will automatically look for it in your PATH, and in a few other known places. So if you have root access to your computer, you might type
    # cd /usr/local/bin
    # ln -s ../../java/j2sdk1.4.0/bin/java
    
  4. With java installed, you will be able to run Unshake from the launcher (see Use of Unshake, Instructions.html).
Any updates for the code will be posted at http://www.hamangia.freeserve.co.uk/Updates/index.html, ISP's permitting.

Installation on Mac's

The launcher for Mac OS X (sorry, this does not work for earlier versions of Mac OS) is on trial release, because I do not have a Mac at home. However, I have created an applescript which might work with Unshake 1.4;

  1. Download this zip file, and unpack it in a convenient place. A folder will appear called Unshake.
  2. Move the Unshake folder into Applications>Utilities on your hard drive. Only this location will work.
  3. In the Unshake folder is a file MacOSX.dmg. Open this disc image, and drag the applescript file Unshake from it to a convenient place, such as your desktop.
  4. You can now run Unshake by opening the applescript file at any time.
If this fails, open a terminal window (Applications>Utilities>Terminal), and type "cd Applications/Utilities" if you have already moved the Unshake folder there , then follow Installation under Unix, steps 2 and 4 before following the rest of the instructions for generic UNIX, and please let me know.

In either case, to run Unshake, please see Use of Unshake, Instructions.html.

Installation of the C version under Linux

First check the licence for the C version, LICENCE.txt. Download the zip file as above, and unpack it. In it you will find a "tarball" UnshakeC1.4r1.tar.gz. Unpack this, and read the file "README".

Mirroring

You are welcome to put Unshake on your own web site (so long as it is in a country which respects copyright and patents granted in the European Union). Note that the distribution includes a Linux distribution, which has its own licence file.
  1. Download the zip file, and unpack it.
  2. Move the zip file into the resulting Unshake directory.
  3. Make the entire directory available on your site.
  4. Email me, so that I can let you know if I ever update Unshake.

Disclaimers and Acknowledgements

Technical Note

Unshake uses Sun's JPEG algorithms to save files. These are not standard Java, so I have set the file-saving routine apart in a special subclass, Unshakes. If there ever comes a time when these algorithms are not available, it is possible to write your own class to use a different algorithm. Here is a template for such a class.

© M.D. Cahill 2000-2003.