File: README.monopigator

package info (click to toggle)
monopd 0.9.0-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 796 kB
  • ctags: 568
  • sloc: cpp: 5,583; sh: 805; makefile: 26
file content (56 lines) | stat: -rw-r--r-- 2,164 bytes parent folder | download
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
54
55
56
Contents
========

	1. Introduction
	2. Requesting the server list
	3. Registering a server

1. Introduction
---------------

In order to make it easier to find people to play against, monopd can be run
as dedicated game server and clients can request a list of available servers
on-line. This document describes the implementation of this technique and
how to enable it in monopd.

2. Requesting the server list
-----------------------------
 
http://gator.monopd.net/ returns a XML page like this:
 
<monopigator>
  <server host="rotterdam.nl.eu.monopd.net" port="1234" version="0.2.1-CVS" users="1"/>
</monopigator>
 
Parse it and your client is good to go (a value of -1 for users indicates
the server did not register with a user count). Future additions might
include attributes like description, games (integer of available games) and
perhaps even game lists and descriptions for faster connects through
treeviews. _Future_ editions.

3. Registering a server
--------------------
 
To register a server, send the following GET request (or POST if you prefer)
to gator.monopd.net:
 
http://gator.monopd.net/register.php?host=rotterdam.nl.eu.monopd.net&port=1234&version=0.2.1-CVS

This keeps a server in the database for three minutes. So you'll have to
register continously. Fortunately monopd can do this for you, but it does
_not_ register by default. It will only register automatically when you
enable it in the configuration.

To enable registration, move the installed monopd.conf-dist to monopd.conf
(or edit your existing monopd.conf) and uncomment the gatoridentity entry.
You can also control some other monopigator and monopd settings here.

The hostname you enter as identity will be the one to appear in the
database, so you can use nice aliases such as rotterdam.nl.eu.monopd.net
instead of your boring reverse lookup. If you have a static IP and want to
be an "official" monopd host, let me know your IP address so you can get
toronto.on.ca.monopd.net or something like that.

Monopigator will ignore registrations if it cannot connect to the given host
and port. This prevents masqueraded and firewalled hosts from appearing in
Monopigator.