qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-03-28 13:11:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

make the connection sequency pretty

Browse source 
(for certain values of pretty). we now require mscgen to build docs.
This commit is contained in:
Bill Currie 2010-08-19 21:29:29 +09:00
parent 43114f5e92
commit 7052f8cf1e
2 changed files with 41 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
INSTALL
View file

@ -32,8 +32,8 @@ To build and install only the quakeworld server:
./configure --without-clients --without-tools --with-servers=qw
make install
To build documentation (doxygen is required, as is an already configured
source tree):
To build documentation (doxygen, dot and mscgen are required, as is an already
configured source tree):
cd doc
make doc

67
doc/connect.txt
View file

@ -1,28 +1,39 @@
[oob]getchallenge\n
[oob]c[challenge][ext]
[oob]connect [protover] [qport] [challenge] [userinfo]
[oob]j
[chan][clc_stringcmd]new
[chan][svc_serverdata][data]
[chan][clc_stringcmd]soundlist [svcount] 0
{
[chan][svc_soundlist][data][next]
[chan][clc_stringcmd]soundlist [svcount] [next]
}
[chan][svc_soundlist][data]0
[chan][clc_stringcmd]modellist [svcount] 0
{
[chan][svc_modellist][data][next]
[chan][clc_stringcmd]modellist [svcount] [next]
}
[chan][svc_modellist][data]0
[chan][clc_stringcmd]prespawn [svcount] [n=0] [wcsum]
{
[chan][signon buffer n][stuffcmd]prespawn...
[chan][clc_stringcmd]prespawn [svcount] [n]
}
[chan][signon buffer n][stuffcmd]spawn...
[chan][clc_stringcmd]spawn [svcount] 0
[chan][spawn info][stuffcmd]skins
[chan][clc_stringcmd]begin [svcount]
....
//unfortunately, have to wrap the docs in a C comment for doxygen
/**
\page connection_sequence QW Connection Sequence
\msc
Client,Server;
Client=>Server [label = "getchallenge\n"];
Server=>Client [label = "c[challenge][ext]"];
Client=>Server [label = "connect [protover] [qport] [challenge] [userinfo]"];
Server=>Client [label = "j"];
Client->Server [label = "[clc_stringcmd]new"];
Server->Client [label = "[svc_serverdata][data]"];
|||;
Client->Server [label = "[clc_stringcmd]soundlist [svcount] 0"];
--- [label = "soundlist loop start"];
Server->Client [label = "[svc_soundlist][data][next]"];
Client->Server [label = "[clc_stringcmd]soundlist [svcount] [next]"];
--- [label = "soundlist loop end"];
Server->Client [label = "[svc_soundlist][data]0"];
|||;
Client->Server [label = "[clc_stringcmd]modellist [svcount] 0"];
--- [label = "modellist list loop start"];
Server->Client [label = "[svc_modellist][data][next]"];
Client->Server [label = "[clc_stringcmd]modellist [svcount] [next]"];
--- [label = "modellist list loop end"];
Server->Client [label = "[svc_modellist][data]0"];
|||;
Client->Server [label = "[clc_stringcmd]prespawn [svcount] [n=0] [wcsum]"];
--- [label = "prespawn loop start"];
Server->Client [label = "[signon buffer n][stuffcmd]prespawn..."];
Client->Server [label = "[clc_stringcmd]prespawn [svcount] [n]"];
--- [label = "prespawn loop end"];
Server->Client [label = "[signon buffer n][stuffcmd]spawn..."];
|||;
Client->Server [label = "[clc_stringcmd]spawn [svcount] 0"];
Server->Client [label = "[spawn info][stuffcmd]skins"];
Client->Server [label = "[clc_stringcmd]begin [svcount]"];
#... [label = "in game message sequence"];
\endmsc
*/