]> git.pond.sub.org Git - empserver/blob - info/Introduction/Clients.t
ee02171624b633603e4e5cfd71f06d9103260dda
[empserver] / info / Introduction / Clients.t
1 .TH Introduction "Empire4 Compatible Clients"
2 .NA Clients "Clients which communicate well with the Empire4 Server"
3 .LV Basic
4 .NF
5 What follows is a list of clients which support the new Empire4
6 protocol.  All of these clients may be found on the Wolfpack Empire
7 Archives located at:
8   http://www.wolfpackempire.com
9 or
10   ftp://ftp.wolfpackempire.com/pub/empire/
11
12 empclient-2.8 and later - full support
13
14 If you are using one of these clients, then you should type
15 "toggle inform" once you have broken sanctuary.  These clients
16 are fully asynchronous, which means that they are able to respond
17 immediately when an unexpected message arrives from the server.  So,
18 for example, if someone sends you a "flash" message, then the message
19 will be printed on your screen immediately.  Similarly, with "inform"
20 toggled on, you will be informed the moment a telegram arrives.  Note,
21 the server remembers your toggle flags when you log out, so you do not
22 have to type "toggle inform" again the next time you connect.
23
24 Most other clients should work fine with the Empire4 server, however
25 they may get confused if a flash message comes in.  Users of other
26 clients should keep the "inform" flag toggled off, and ask a friend to
27 send them a "flash" message to see how the client handles it (note,
28 you must declare friendly relations towards them in order to receive
29 the flash message).  If the flash message confuses your client, then I
30 recommend you type "toggle flash" to turn flash mode off.
31 .FI
32 .s1
33 In addition, there are a list of commands which have been added to the
34 server to help the development of clients.  They are:
35 .NF
36    dump - Dump sector information
37    ldump - Dump land unit information
38    sdump - Dump ship information
39    pdump - Dump plane information
40    ndump - Dump nuclear stockpile information
41    lost - Report lost items
42 .FI
43 .s1
44 See the various info pages on these for complete documentation on how they
45 work and how you can use them to help improve your clients.
46 .s1
47 In addition, there is a "timestamp" field on each object (sectors, ships,
48 land units, planes, nuclear stockpiles, lost items) that you can use to 
49 compare against to keep data between clients and the database in sync with
50 each other.  These timestamps are kept in systems seconds, so they should
51 be accurate down to 1 second.  Every time an object is changed, it's
52 timestamp is updated.
53 .SA "toggle, dump, ldump, sdump, pdump, ndump, lost, Empire4, Communication, Introduction"