Difference between revisions of "Hacker's Guide"
From OdaWiki
(→Debugging the client on Linux) |
(A table of functions) |
||
| Line 37: | Line 37: | ||
=== Network Interface === | === Network Interface === | ||
| − | The network interface is rather simple and is composed of multiple Read/Write functions. These functions wrap converting from host to network byte order, building packets, and sending data. They are mainly composed of '''MSG_Read*''' and '''MSG_Write*''' The wildcards can be replaced with anything from the following table | + | The network interface is rather simple and is composed of multiple Read/Write functions. These functions wrap converting from host to network byte order, building packets, and sending data. They are mainly composed of '''MSG_Read*''' and '''MSG_Write*''' The wildcards can be |
| + | replaced with anything from the following table. | ||
| − | + | {|border=1 | |
| − | + | ||
| + | |- | ||
| + | ! Function !!Description | ||
| + | |||
| + | |- | ||
| + | | '''Functions that write data to a buffer''' | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteMarker(buf_t *, svc_t) | ||
| + | | Writes a data block identifier (from server messages to client) | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteMarker(buf_t *, clc_t) | ||
| + | | Writes a data block identifier (used for client messages to server) | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteBool(buf_t *, bool) | ||
| + | | Writes a boolean (true/false) value | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteByte(buf_t *, int) | ||
| + | | Writes an 8bit value | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteShort(buf_t *, int) | ||
| + | | Writes a 16bit value | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteLong(buf_t *, int) | ||
| + | | Writes a 32bit value | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteFloat(buf_t *, float) | ||
| + | | Writes a 32bit floating point value | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteString(buf_t *, const char *) | ||
| + | | Writes a null-terminated string | ||
| + | |||
| + | |- | ||
| + | | void MSG_WriteChunk(buf_t *, const void *, unsigned l) | ||
| + | | Writes a block of data, last parameter is the length | ||
| + | |||
| + | |- | ||
| + | | | ||
| + | | | ||
| + | |||
| + | |- | ||
| + | | '''Functions that read data from a received buffer''' | ||
| + | |||
| + | |- | ||
| + | | bool MSG_ReadBool(void) | ||
| + | | Reads a boolean value | ||
| + | |||
| + | |- | ||
| + | | int MSG_WriteByte(void) | ||
| + | | Reads an 8bit value | ||
| + | |||
| + | |- | ||
| + | | int MSG_ReadShort(void) | ||
| + | | Reads a 16bit value | ||
| + | |||
| + | |- | ||
| + | | int MSG_ReadLong(void) | ||
| + | | Reads a 32bit value | ||
| + | |||
| + | |- | ||
| + | | float MSG_ReadFloat(void) | ||
| + | | Reads a 32bit floating point value | ||
| + | |||
| + | |- | ||
| + | | const char *MSG_ReadString(void) | ||
| + | | Reads a null-terminated string | ||
| + | |||
| + | |- | ||
| + | | void *MSG_ReadChunk(size_t &) | ||
| + | | Reads a block of data, the parameter is the size to read | ||
| + | |||
| + | |} | ||
| + | |||
| + | |||
| + | Miscellaneous network functions and their descriptions are included in the table below. | ||
| + | |||
| + | {|border=1 | ||
| + | |||
| + | |- | ||
| + | ! Function !!Description | ||
| + | |||
| + | |- | ||
| + | | MSG_BytesLeft(void) | ||
| + | | Returns the number of bytes left in the received buffer | ||
| + | |||
| + | |- | ||
| + | | MSG_NextByte(void) | ||
| + | | Returns the next byte (similar to MSG_ReadByte, only it peeks) | ||
| + | |||
| + | |- | ||
| + | | SZ_Clear(buf_t *) | ||
| + | | Clears the data from a buffer | ||
| + | |||
| + | |} | ||
=== Players === | === Players === | ||
Revision as of 11:27, 3 June 2008
Contents
Getting Started
You'll want to have a look at our svn and bugs pages.
Code structure
Conventional file prefix
- am_*: automap related code
- c_*: console related code
- cl_*: client only code
- d_*: game/net code
- f_*: finale related code
- g_*: game related code
- hu_*: hud related code
- i_*: system/hardware dependant code
- m_*: ???
- p_*: game/object related code
- r_*: render related code
- s_*: sound related code
- sv_*: server only code
- st_*: ??? (mostly hud render related code)
- v_*: video related code
- wi_*: intermission related code
- z_*: memory allocation related code
Files of interest
- i_main.cpp: application entry point
Style and guidelines
See the coding standard
Subsystems, APIs, and Interfaces
Odamex is a very large and deep program with around 13 years worth of hacks and additions added to it. It can be very daunting to a new developer, so in this section we will try to document some of the interfaces provided by the source and some of the quirks that need to be accounted for.
Network Interface
The network interface is rather simple and is composed of multiple Read/Write functions. These functions wrap converting from host to network byte order, building packets, and sending data. They are mainly composed of MSG_Read* and MSG_Write* The wildcards can be replaced with anything from the following table.
| Function | Description |
|---|---|
| Functions that write data to a buffer | |
| void MSG_WriteMarker(buf_t *, svc_t) | Writes a data block identifier (from server messages to client) |
| void MSG_WriteMarker(buf_t *, clc_t) | Writes a data block identifier (used for client messages to server) |
| void MSG_WriteBool(buf_t *, bool) | Writes a boolean (true/false) value |
| void MSG_WriteByte(buf_t *, int) | Writes an 8bit value |
| void MSG_WriteShort(buf_t *, int) | Writes a 16bit value |
| void MSG_WriteLong(buf_t *, int) | Writes a 32bit value |
| void MSG_WriteFloat(buf_t *, float) | Writes a 32bit floating point value |
| void MSG_WriteString(buf_t *, const char *) | Writes a null-terminated string |
| void MSG_WriteChunk(buf_t *, const void *, unsigned l) | Writes a block of data, last parameter is the length |
| Functions that read data from a received buffer | |
| bool MSG_ReadBool(void) | Reads a boolean value |
| int MSG_WriteByte(void) | Reads an 8bit value |
| int MSG_ReadShort(void) | Reads a 16bit value |
| int MSG_ReadLong(void) | Reads a 32bit value |
| float MSG_ReadFloat(void) | Reads a 32bit floating point value |
| const char *MSG_ReadString(void) | Reads a null-terminated string |
| void *MSG_ReadChunk(size_t &) | Reads a block of data, the parameter is the size to read |
Miscellaneous network functions and their descriptions are included in the table below.
| Function | Description |
|---|---|
| MSG_BytesLeft(void) | Returns the number of bytes left in the received buffer |
| MSG_NextByte(void) | Returns the next byte (similar to MSG_ReadByte, only it peeks) |
| SZ_Clear(buf_t *) | Clears the data from a buffer |
Players
Map Objects
szp pointers
Proper practices considering networking
Networking
Odamex uses UDP
Debugging the client on Linux
There's a problem with breakpoints and SDL under Linux. When a breakpoint pauses execution, the client keeps a lock on the mouse and keyboard (you can no longer do anything). If you kill the client process, you lose the breakpoint info. The current workaround is to use the -nomouse commandline parameter.