EyeSim-VR
—————————

This is a brief description on how to quickly setup the simulator.
For more detailed instructions on how to use and setup, please download and check the user manual from following link:
  https://robotics.ee.uwa.edu.au/eyesim/ftp/EyeSim_VR_User_Manual.docx


	Installation:
	-------------

Mac OS:
(1) Download and install XCode: https://itunes.apple.com/au/app/xcode/id497799835?mt=12

(2) Download and install XQuartz: https://robotics.ee.uwa.edu.au/eyesim/ftp/aux/mac/ or https://www.xquartz.org/
     Note: Your system default XQuartz app may need to be removed and reinstall from above link to include X11. 

(3) Run following command in terminal to link the x11 library:
      sudo ln -s /opt/X11/include/X11 /usr/local/include/X11

(4) Download and install EyeSim for macOS: https://robotics.ee.uwa.edu.au/eyesim/ftp/

(5) Download and unzip eyesimX (EyeSim Examples): https://robotics.ee.uwa.edu.au/eyesim/ftp/


Windows:
(1) Download and install EyeSim for Windows: https://robotics.ee.uwa.edu.au/eyesim/ftp/

(2) Download cygwin.zip and Xming.zip from: https://robotics.ee.uwa.edu.au/eyesim/ftp/aux/win/

(3) Unzip cygwin.zip to C:\Program Files (x86)\eyesim\cygwin

(4) Unzip Xming.zip to C:\Program Files (x86)\eyesim\Xming 

(5) Download and unzip eyesimX (EyeSim Examples): https://robotics.ee.uwa.edu.au/eyesim/ftp/


Linux(64bit):
(1) Install X11 library using following command: 
		sudo apt-get install libx11-dev

(2) Download the latest EyeSim for Linux: https://robotics.ee.uwa.edu.au/eyesim/ftp/

(3) Unarchive the .tar.gz file and run the 'install.sh' script

(4) Download and unzip eyesimX (EyeSim Examples): https://robotics.ee.uwa.edu.au/eyesim/ftp/


	Get Started:
	------------

Mac OS:
(1) Create a "myscripts" folder to work from.
    
(2) Compile your robot application program:
      gccsim myprog.c -o myprog.x

(3) Start the EyeSim app and your application program from the Terminal - it will automatically 
    connect to the simulation environment:
      ./myprog.x
   Note: You need to have at least one robot in the simulation for the script to work.

OR

(3) Start the EyeSim app from the Terminal and specify a SIM file to run
      eyesim mysimfile.sim
   Note: You need to have at least one robot in the simulation for the script to work.


Windows:
(1) Create a "myscripts" folder and navigate to the folder from cygwin terminal(opened from File/Open terminal).
	To get to the C: drive first, use the command:
      cd /cygdrive/c

(2) Use following command to compile the script:
      gccsim -o program main.c

(3) Start the EyeSim app

(4) Start the EyeSim app and your application program from Cygwin - it will automatically 
    connect to the simulation environment:
      ./program
    Note: You need to have at least one robot in the simulation for the script to work.

OR

(4) Start the EyeSim app from Cygwin and specify a SIM file to run
      eyesim mysimfile.sim
   Note: You need to have at least one robot in the simulation for the script to work.

	
Linux:
(1) create a folder called "myscripts", and navigate to the folder using terminal.

(2) Use following command to compile the script:
      gccsim -o program main.c

(3) Start the EyeSim app and your application program from the terminal - it will automatically 
    connect to the simulation environment:
      ./myprog.x
   Note: You need to have at least one robot in the simulation for the script to work.

OR

(3) Start the EyeSim app from the terminal and specify a SIM file to run
      eyesim mysimfile.sim
   Note: You need to have at least one robot in the simulation for the script to work.



-------------
Alex Arnold, Michael Finn, Thomas Braunl, 2018
Travis Povey, Joel Frewin, Thomas Braunl, 2017