summaryrefslogtreecommitdiff
path: root/README.md
blob: 509a805cd6a175873ea6725b49f06c228d1063ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
46
47
48
49
50
51
52
53
#pyenet

pyenet is a python wrapper for the ENet library by Lee Salzman,
 http://enet.bespin.org

It was originally written by Scott Robinson <scott@tranzoa.com> and is
currently maintained by Andrew Resch <andrewresch@gmail.com>

##License
pyenet is licensed under the BSD license, see LICENSE for details.
enet is licensed under the MIT license, see http://enet.bespin.org/License.html

##Dependencies

Building pyenet requires all the same dependencies as enet plus Cython and,
obviously, Python.

##Installation

The first step is to download the enet sources from http://enet.bespin.org and
extract it to the enet/ directory in pyenet's source directory.  You could also
check out the enet source code from their CVS repository.

This version of pyenet requires enet 1.3.

Next step is to run the setup.py build:
```
$ python setup.py build
```
Once that is complete, install the new pyenet module:
```
# python setup.py install
```

##Usage

Once you have installed pyenet, you only need to import the enet module to
start using enet in your project.

Example server:
```
>>> import enet
>>> host = enet.Host(enet.Address("localhost", 33333), 1, 0, 0)
>>> event = host.service(0)
```
Example client:
```
>>> import enet
>>> host = enet.Host(None, 1, 0, 0)
>>> peer = host.connect(enet.Address("localhost", 33333), 1)
```
More information on usage can be obtained from:
 http://enet.bespin.org/Tutorial.html