root/trunk/VBoxVentriloControl/README

Revision 107, 2.8 KB (checked in by kfitzgerald, 3 years ago)

Added source for VBoxVentriloControl for using ventrilo inside a virtualbox virtual machine

Line 
1VirtualBox Ventrilo Contoller v1.0
2 Adapted from ventriloctrl
3By Kevin Fitzgerald kevin@kevinfitzgerald.net
4
5Requirements
6 * Reading rights for event device
7 * make, gcc, etc...
8 * (On ubuntu/debian, apt-get install build-essential )
9 
10Compiling
11 * Change into the current directory in a terminal
12 * Type 'make' to build the project
13 * A susccessful build will tell you 'Compilation Successful'
14
15Configuration & Usage
16 * First, you have to figure out what event device your keyboard is.
17   Run the command `cat /proc/bus/input/devices | less` (q to quit) and
18   look for an entry with a name like N: Name="AT Translated Set 2 keyboard"
19   or something to that effect, which describes your keyboard. Then look for
20   the Handlers line of that entry, and remember the event# (e.g. event1).
21 * Run the findkey command to get the keycode you want to use to transmit
22   in Ventrilo. Run: `./findkey /dev/input/event#` using the previous event#,
23   You have to have permission to read from /dev/input/event#, so you may have
24   to sudo or change the group permissions of the device.
25    ** CAREFUL ** If you change the permissions of the device, this could leave
26     you vaunerable to keyloggers or other nasty stuff. Make sure you are careful
27     if you choose to change permissions of the device. If you're the only one
28     you uses this computer, you can probably change this without trouble.
29     See the WARNING section below for more info.
30   You can also setup an automatic way of doing this though /etc/udev/rules.d/
31   Once you are running, hit the key you want to use to transmit with. Remember
32   the Key value. (Don't worry about the state value)
33 * Edit the config.sh file to your likings. Specifically, change VBoxUsername,
34   EventDevice, VBoxMachineName, InputKeyCode, and ConfigFinished to your preference.
35 * Make sure your VM is running, and start Ventrilo.
36 * Set the Ventrilo transmit key to LEFT SHIFT (by default, this is changeable
37   though config.sh file)
38 * After configuration, run `./run.sh` to start the controller. Hit your key
39   and with any luck, you'll be transmitting in Vent! :D
40
41License
42 * See the enclosed LICENSE file
43
44Credits
45 * This version: Kevin Fitzgerald - kevin@kevinfitzgerald.net
46   - Code cleanup, Compilation, Docs, Scripts
47 * ventriloctrl:
48  * Spets <toni.spets@gmail.com>
49  * Markus Lindqvist <markus.lindqvist@gmail.com>
50  * Original code by Adam Pierce - http://www.doctort.org/adam/
51    http://www.doctort.org/adam/nerd-notes/x11-fake-keypress-event.html
52  * Niko "np1" Ikonen
53  * Toni "hifi" Spets
54
55###########
56# WARNING #
57###########
58No rights to read event device?
59
60This is totally wrong way to do this and don't even try if you are not the only user.
61
62Run next as superuser (root)
63# chown <your username> /dev/input/eventx
64where x is number of right event device.
65
Note: See TracBrowser for help on using the browser.