ReadMe.txt 2.71 KB
Newer Older
TheOnlyJoey's avatar
TheOnlyJoey committed
1
# OIS: Object oriented Input System
2

TheOnlyJoey's avatar
TheOnlyJoey committed
3
4
Cross Platform Object Oriented Input Lib System. Meant to be very robust and
compatiable with many systems and operating systems.
5

TheOnlyJoey's avatar
TheOnlyJoey committed
6
This is the official repository and is a continuation of the great work done by pjcast on the old sourceforge repo.
7

TheOnlyJoey's avatar
TheOnlyJoey committed
8
## Todo
9

TheOnlyJoey's avatar
TheOnlyJoey committed
10
11
12
13
- Add CMake for compiling
- Merge pull requests/patches send in over time
- Cleanup and remove dead-code
- Start implementing support for new platforms and backends
14

TheOnlyJoey's avatar
TheOnlyJoey committed
15
## Compiling:
16
17
18
Win32/
	Contains Visual Studio .Net Solution Files
	Contains CodeBlocks project files for OIS
Ben Hymers's avatar
Ben Hymers committed
19

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
	---- Dependencies ------------------------------------------------------
	DirectInput 8


Linux/
	---- Dependencies ------------------------------------------------------
	X11
        Newer Linux Kernel (2.6+ ?) for Event API

	Steps to build on Linux:
	./bootstrap
	./configure
	./make && make install

	---- Configure build options --------------------------------------------
	./configure --help              --- List all configure options


LinuxCB/
        Contains CodeBlock files for building OIS and Demos with codeblocks
        This project file looks for Ogre and other dependencies in /usr/local/lib
        and /usr/local/include. If installed elsewhere, modify the project
        settings. It also installs libOIS to ~/libs

Mac/
	XCode-2.2/
TheOnlyJoey's avatar
TheOnlyJoey committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
		Working, mostly complete OSX vackend.

## License

The zlib/libpng License

Copyright (c) 2005-2010 Phillip Castaneda (pjcast -- www.wreckedgames.com)

This software is provided 'as-is', without any express or implied warranty. In no
event will the authors be held liable for any damages arising from the use of this
software.

Permission is granted to anyone to use this software for any purpose, including
commercial applications, and to alter it and redistribute it freely, subject to the
following restrictions:

    1. The origin of this software must not be misrepresented; you must not claim that
		you wrote the original software. If you use this software in a product,
		an acknowledgment in the product documentation would be appreciated
		but is not required.

    2. Altered source versions must be plainly marked as such, and must not be
		misrepresented as being the original software.

    3. This notice may not be removed or altered from any source distribution.


### License Explained
In case the license was not clear enough... Basically, you can link with this lib
which puts no restrictions on what you have to license your code as. You can modify
this lib, and not have release your changes. Though, as explained above,
**Altered source versions must be plainly marked as such, and must not be misrepresented
as being the original software.**

This is to allow users the greatest flexibility in what you can use this lib for.