diff options
Diffstat (limited to '')
12 files changed, 727 insertions, 0 deletions
diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/architect.png?rev=1.1&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/architect.png?rev=1.1&content-type=text/plain&sortby=date/index.html Binary files differnew file mode 100644 index 00000000..39c84ccd --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/architect.png?rev=1.1&content-type=text/plain&sortby=date/index.html diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.2&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.2&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..f1493d5f --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.2&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,73 @@ +/** + \page log_howto How to log information ? + \author Olivier Cado + + This document explains how to log some information (into the screen, into a file or to a logging server), e.g. in order to debug your code. + You need to include the following header files : "nel/misc/debug.h" "nel/misc/log.h". + + \subsection init_log Initialization + + In the initialization of your service (see NLNET::IService), attach some displayers to the global NLMISC::CLog objects + \e ErrorLog, \e WarningLog, \e InfoLog, \e DebugLog and \e AssertLog. + NLMISC::CStdDisplayer is for the screen (and VC++ debug window). It is attached by default to all of the five logger objects mentionned above. + NLMISC::CFileDisplayer is for a file. + NLMISC::CMsgBoxDisplayer is for a message box. + NLNET::CNetDisplayer is for a logging server (see CLogService in the server documentation) + + If your program is not a service (i.e. it is not inherited from NLNET::IService), + don't forget to call \b NLMISC::InitDebug() at the beginning of your program, otherwise + the logging functions won't work. + + Example : + \code + + NLMISC::InitDebug(); // if your program does not inherit from NLNET::IService + NLNET::CNetDisplayer *nd = new CNetDisplayer(); // the address of the Logging Server is automatically retrieved using the Naming Service + if ( nd->connected() ) // this line is optional: here we don't want the displayer to attempt other connections if the first one failed + { + NLMISC::DebugLog.addDisplayer( nd ); + } + \endcode + + \subsection use_log Logging information + In your code, use the macros : \e nlerror, \e nlwarning, \e nlinfo, \e nldebug with a variable number of arguments. + You have to include the header "nel/misc/debug.h". + + Example : + \code + nldebug( "Toto is %d years old", age ); + if ( age < 0 ) + { + nlerror( "Invalid age for toto : %d", age ); + return -1; + } + \endcode + + - How to log a string without repeating the header ? + + The macros nldebug() and nlerror() call some methods of NLMISC::CLog, including displayNL(). + It prints a string with an information header. + If you don't want to print the header, use the others methods of NLMISC::CLog. + + Example : + \code + NLMISC::DebugLog.displayNL ( "Dump of Values :" ); + for ( int j=0; j!=height; ++j ) + { + for ( int i=0; i!=width; ++i ) + { + NLMISC::DebugLog.displayRaw( "%d ", Values[j][i] ); + } + NLMISC::DebugLog.displayRawNL( ": line %d", j ); + } + \endcode + + \subsection Analysing network transfers + + NLNET::NetLog (declared in "nel/net/nel_log.h") is a special logger that allows to send output and input logs to a logging server. + These logs are produced by the network subsystem and have a special syntax so that an analyser can process them and display the transfers + graphically in real-time. + + By default, all services (see NLNET::IService) send this kind of logs if they find a logging server. + +*/ diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.5&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.5&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..74139834 --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.5&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,88 @@ +/** + \page log_howto How to log information (for debugging purpose) ? + \author Olivier Cado + \date Updated May 4 2000 + +This document explains how to log some information (into the screen, into a file or to a logging server), e.g. in order to debug your code. + +\section basic_debug Basic usage of the debugging system +The debugging sytem allows to log information at various levels. Include the header file "nel/misc/debug.h". + +The main functionalities are offered by the macros nldebug, nlinfo, nlwarning and also nlerror and nlassert, and by their variant forms (see debug.h). They allow to display strings, with open arguments, using the "printf" syntax. In the default behaviour, the text passed to nldebug is displayed into stdout in NL_DEBUG mode, but not in NL_RELEASE. The logged texts are also written into a file called "log.log" in the working directory. These macros print the strings with an information header. + + Example : + \code + sint32 age = -2; + nldebug( "Toto is %d years old", age ); + if ( age < 0 ) + { + nlerror( "Invalid age for toto : %d", age ); + + // the program will not come here because nlerror throws an exception to exit + } + + STDOUT (logger thread_id file line: debug_string): + DBG 1234 myfile.cpp 10: Toto is -2 years old + ERR 1234 myfile.cpp 13: Invalid age for toto : -2 + Abort + + FILE OUTPUT (date time logger debug_string): + 01/04/11 18:24:50 DBG: Toto is -2 years old + 01/04/11 18:24:50 ERR: Invalid age for toto : -2 + \endcode + +Because NeL allows to create multithreaded programs, these macros use mutual exclusions (mutex) to ensure no data is corrupted and the displayed text not interlaced. + +\section adv_log Advanced usage of the logging system + +You may want to customize the logging system directly, for your own needs. Include "nel/misc/log.h". + +\subsection init_log Initialization +If your program is not a "service" in the NeL terms (i.e. if it is not built on NLNET::IService), +first call createDebug() to create the basic global loggers \e ErrorLog, \e WarningLog, \e InfoLog, \e DebugLog and \e AssertLog (the ones that are used by the nlerror, nlwarning, nlinfo, nldebug and nlassert macros). + +Then, you can attach some displayers to the global loggers (NLMISC::CLog objects). +- NLMISC::CStdDisplayer is for stdout (the console, the VC++ output window...). It is attached by default to all of the five logger objects mentionned above. +- NLMISC::CFileDisplayer is for a file. +- NLMISC::CMsgBoxDisplayer is for a message box. +- NLNET::CNetDisplayer is for a logging server (see CLogService in the nelns documentation). +- You can can create your own displayer, in order to print the logged text onto a new target (for example, see the class CChatDisplayer in Snowballs 0.2) or to customize the filter on the header. + +Example (we assume CNetDisplayer allows to log via the network): + \code + + createDebug(); // automatically done in a "service" + NLNET::CNetDisplayer *nd = new CNetDisplayer(); // the address of the Logging Server is automatically retrieved using the Naming Service + if ( nd->connected() ) // this line is optional: here we don't want the displayer to attempt other connections if the first one failed + { + NLMISC::DebugLog.addDisplayer( nd ); + } + \endcode + + \subsection use_log Logging information + + How to log a string without repeating the header ? Use the methods of NLMISC::CLog. + + Example : + \code + NLMISC::DebugLog.displayNL ( "Dump of Values :" ); + for ( int j=0; j!=height; ++j ) + { + for ( int i=0; i!=width; ++i ) + { + NLMISC::DebugLog.displayRaw( "%d ", Values[j][i] ); + } + NLMISC::DebugLog.displayRawNL( ": line %d", j ); + } + \endcode + +*/ + + \subsection network_transfers Analysing network transfers + + NLNET::NetLog (declared in "nel/net/nel_log.h") is a special logger that allows to send output and input logs to a logging server. + These logs are produced by the network subsystem and have a special syntax so that an analyser can process them and display the transfers + graphically in real-time. + + By default, all services (see NLNET::IService) send this kind of logs if they find a logging server. + diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.6&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.6&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..44dac067 --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/logging.dxt?rev=1.6&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,88 @@ +/** + \page log_howto How to log information (for debugging purpose) ? + \author Olivier Cado + \date Updated May 4 2001 + +This document explains how to log some information (into the screen, into a file or to a logging server), e.g. in order to debug your code. + +\section basic_debug Basic usage of the debugging system +The debugging sytem allows to log information at various levels. Include the header file "nel/misc/debug.h". + +The main functionalities are offered by the macros nldebug, nlinfo, nlwarning and also nlerror and nlassert, and by their variant forms (see debug.h). They allow to display strings, with open arguments, using the "printf" syntax. In the default behaviour, the text passed to nldebug is displayed into stdout in NL_DEBUG mode, but not in NL_RELEASE. The logged texts are also written into a file called "log.log" in the working directory. These macros print the strings with an information header. + + Example : + \code + sint32 age = -2; + nldebug( "Toto is %d years old", age ); + if ( age < 0 ) + { + nlerror( "Invalid age for toto : %d", age ); + + // the program will not come here because nlerror throws an exception to exit + } + + STDOUT (logger thread_id file line: debug_string): + DBG 1234 myfile.cpp 10: Toto is -2 years old + ERR 1234 myfile.cpp 13: Invalid age for toto : -2 + Abort + + FILE OUTPUT (date time logger debug_string): + 01/04/11 18:24:50 DBG: Toto is -2 years old + 01/04/11 18:24:50 ERR: Invalid age for toto : -2 + \endcode + +Because NeL allows to create multithreaded programs, these macros use mutual exclusions (mutex) to ensure no data is corrupted and the displayed text not interlaced. + +\section adv_log Advanced usage of the logging system + +You may want to customize the logging system directly, for your own needs. Include "nel/misc/log.h". + +\subsection init_log Initialization +If your program is not a "service" in the NeL terms (i.e. if it is not built on NLNET::IService), +first call createDebug() to create the basic global loggers \e ErrorLog, \e WarningLog, \e InfoLog, \e DebugLog and \e AssertLog (the ones that are used by the nlerror, nlwarning, nlinfo, nldebug and nlassert macros). + +Then, you can attach some displayers to the global loggers (NLMISC::CLog objects). +- NLMISC::CStdDisplayer is for stdout (the console, the VC++ output window...). It is attached by default to all of the five logger objects mentionned above. +- NLMISC::CFileDisplayer is for a file. +- NLMISC::CMsgBoxDisplayer is for a message box. +- NLNET::CNetDisplayer is for a logging server (see CLogService in the nelns documentation). +- You can can create your own displayer, in order to print the logged text onto a new target (for example, see the class CChatDisplayer in Snowballs 0.2) or to customize the filter on the header. + +Example (we assume CNetDisplayer allows to log via the network): + \code + + createDebug(); // automatically done in a "service" + NLNET::CNetDisplayer *nd = new CNetDisplayer(); // the address of the Logging Server is automatically retrieved using the Naming Service + if ( nd->connected() ) // this line is optional: here we don't want the displayer to attempt other connections if the first one failed + { + NLMISC::DebugLog.addDisplayer( nd ); + } + \endcode + + \subsection use_log Logging information + + How to log a string without repeating the header ? Use the methods of NLMISC::CLog. + + Example : + \code + NLMISC::DebugLog.displayNL ( "Dump of Values :" ); + for ( int j=0; j!=height; ++j ) + { + for ( int i=0; i!=width; ++i ) + { + NLMISC::DebugLog.displayRaw( "%d ", Values[j][i] ); + } + NLMISC::DebugLog.displayRawNL( ": line %d", j ); + } + \endcode + +*/ + + \subsection network_transfers Analysing network transfers + + NLNET::NetLog (declared in "nel/net/nel_log.h") is a special logger that allows to send output and input logs to a logging server. + These logs are produced by the network subsystem and have a special syntax so that an analyser can process them and display the transfers + graphically in real-time. + + By default, all services (see NLNET::IService) send this kind of logs if they find a logging server. + diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.2&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.2&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..8ac1952f --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.2&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,3 @@ +R: +cd \code\nel\doc +doxygen -s nel.dox diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.3&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.3&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..f104fb36 --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.3&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,3 @@ +R: +cd \code\nel\doc +doxygen nel.dox diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.6&content-type=text/plain&sortby=rev/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.6&content-type=text/plain&sortby=rev/index.html new file mode 100644 index 00000000..d698d129 --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/make_nel_dox.bat?rev=1.6&content-type=text/plain&sortby=rev/index.html @@ -0,0 +1,7 @@ +@echo off +R: +cd \code\nel\doc +del html\*.* /Q +s:\bin\doxygen nel.dox +S:\bin\hhc html\index.hhp +copy html\index.chm s:\doc\nel.chm diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dox?rev=1.6&sortby=date b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dox?rev=1.6&sortby=date new file mode 100644 index 00000000..15bbff6e --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dox?rev=1.6&sortby=date @@ -0,0 +1,186 @@ +# Doxyfile 1.2.13-20020210 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = NeL +PROJECT_NUMBER = +OUTPUT_DIRECTORY = +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = NO +STRIP_CODE_COMMENTS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = YES +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 8 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = NO +SHOW_USED_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = r:/code/nel/src r:/code/nel/include +FILE_PATTERNS = *.h \ + *.cpp \ + *.dxt +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = *.lex.* \ + *.yacc.* +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = C \ + I \ + P +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = YES +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = R:/code/nelns/doc/server.tag=/code/server/doc/html +GENERATE_TAGFILE = nel.tag +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +TEMPLATE_RELATIONS = YES +HIDE_UNDOC_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = gif +DOT_PATH = S:\bin\graphviz\bin +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dxt?rev=1.3&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dxt?rev=1.3&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..b6a3bd56 --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dxt?rev=1.3&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,13 @@ +/** + * \mainpage NeL + * + * \section intro Introduction + * + * "NeL" stands for Nevrax Library. + * + * NeL is a library. It is designed and maintained by Nevrax. This library contains a framework, + * a 3D engine, an AI engine and a Network engine. + * + * You will find some overviews about features of NeL in the Related Pages. + * + */ diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dxt?rev=1.5&content-type=text/plain&sortby=date/index.html b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dxt?rev=1.5&content-type=text/plain&sortby=date/index.html new file mode 100644 index 00000000..c2f931ee --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel.dxt?rev=1.5&content-type=text/plain&sortby=date/index.html @@ -0,0 +1,17 @@ +/** + * \mainpage NeL + * + * \section intro Introduction + * + * \par + * "NeL" stands for Nevrax Library. + * + * \par + * NeL is a set of free software libraries which aim to form a complete toolbox + * of technologies for the development of massively multi-player online role + * playing games. + * + * \par + * You will find some overviews about features of NeL in the Related Pages. + * + */ diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel_samples.dxt?rev=1.3&sortby=rev b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel_samples.dxt?rev=1.3&sortby=rev new file mode 100644 index 00000000..091ccf07 --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/nel_samples.dxt?rev=1.3&sortby=rev @@ -0,0 +1,135 @@ +/** + +\page nelsamples NeL Samples + +$Id: nel_samples.dxt,v 1.3 2002/04/16 13:54:27 lecroart Exp $ + +\author Olivier Cado, Vianney Lecroart + +\date 06/15/2001 + + +\section samisc NeL Misc Samples + + +Theses samples illustrates the usage of the miscellaneous library. This is the based library used by all other Nevrax libraries. +It contains all usefull class and features that are not specific for one or another library. + +\subsection samisccommand command + +This samples describes how to create commands and execute them using ICommand class. It's a generic system to create and execute +command at run time (it is used in all services, snowballs client and so on). + +\subsection samiscconfigfile configfile + +This samples describes how to use NeL configuration file. (This system is used in all services, snowballs client and so on). + +\subsection samiscdebug debug + +This program shows you how to use basic debug stuffs that are used everywhere in NeL. + +\subsection samisclog log + +This sample uses the log and displayer system that is a generic way to generate output (on screen, file, network and so one). + +\section sanetwork NeL Net Samples + + +Theses samples illustrate the usage of network library + + +\subsection sanetlogin_system login_system + +This examples shows you how to use the login system provided by NeL to connects/check/identify clients. + +\subsection sanetservice service + +This is a very simple service example to describes the architecture to create services. + +\subsection sanetlayer3 net_layer3 + +This project demonstrates the usage of layer 3 (NLNET::CCallbackClient, NLNET::CCallbackServer) and the +service framework (NLNET::IService). It contains three programs: a client, a front-end service and a ping service. + +- The client connects to a front-end server at localhost:37000. +It sends pings and expects pongs (ping replies). +- The front-end server expects pings, and forward them to +the real ping server (known as "PS" in the naming service). +When the ping server sends a pong back, the front-end server forwards it to the client. +- The ping service (PS) expects pings and sends pongs back. + +To run the front-end service and the ping service, ensure +their config files, frontend_service.cfg and ping_service.cfg, +are located in the directory where they are run. These files +state the address of the naming service. + +\subsection sanetlayer4 net_layer4 + +This project demonstrates the usage of layer 4 (NLNET::CNetManager), the +service framework (NLNET::IService), and the connection and disconnection callbacks. +It contains three programs: a client, a front-end service and a ping service. +The functionalities are close to the ones of the previous sample. + +- The client connects to a front-end server at localhost:37000. +It sends pings and expects pongs (ping replies). +- This front-end server expects pings, and forward them to +the real ping server. When the ping server sends a pong back, +the front-end server forwards it to the client. +Even if the connection to the ping server is broken, our +front-end server will keep storing the ping messages and +will forward them when the connection is restored, thanks +to layer 4. +- The ping service (PS) expects pings and sends pongs back. + +To run the front-end service and the ping service, ensure +their config files, frontend_service.cfg and ping_service.cfg, +are located in the directory where they are run. These files +state the address of the naming service. + +\subsection sanetlayer5 net_layer5 + +This project demonstrates the usage of layer 5 (NLNET::CUnifiedNetwork), the +service framework (NLNET::IService), and the connection and disconnection callbacks. +It contains a set of services that communicate between them. +The functionalities are close to the ones of the previous sample but they add some +features like unified callback array, and so on. + +\subsection sanetudp udp + +This project demonstrates the usage of a client/server architecture for +benching an UDP connection. The server listen on TCP port and UDP port +for new incoming client. When a client is connected, it communicates on +the TCP port to set the bench and after it uses the UDP port to bench the +connection. The server log information on text file and send some info on +the client using the TCP connection. + +\subsection sanetclasstransport class_transport + +This project demonstrates the usage of the CTransportClass class. +This class allows services to send easily some class to another service. +It manages different class version (For example, the sender class can have +different variables than the receiver class) + +\section sa3d NeL 3D Samples + + +\e Document \e under \e construction + +\subsection sa3dfont font + +\e Document \e under \e construction + + +\section sapacs NeL PACS Samples + + +\e Document \e under \e construction + + +\section saai NeL AI Samples + + +\e Document \e under \e construction + + +*/
\ No newline at end of file diff --git a/cvs/cvsweb.cgi/~checkout~/code/nel/doc/project.dxt?rev=1.10&sortby=date b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/project.dxt?rev=1.10&sortby=date new file mode 100644 index 00000000..ab6a41ed --- /dev/null +++ b/cvs/cvsweb.cgi/~checkout~/code/nel/doc/project.dxt?rev=1.10&sortby=date @@ -0,0 +1,114 @@ +/** + +\page present NeL General Presentation +\author Vincent Archer + +\section introd What is NeL? + +NeL is a complete platform aimed at running massively multi-user +entertainment in a 3D environment over the Internet. + +\section oss Free Software + +NeL is also a Free Software project under the GNU General Public License, +which means all its code is available for everyone to download, examine, +use, modify, and distribute, subject to the usual restrictions attached to +any GPL software. See the attached text for more details if you are not +familiar with the GPL. + +\section dev Development + +NeL is a commercially funded project which is used to create a massively +multiplayer role-playing game in a 3D world. This means that there is a +permanent core of developpers who are paid to work on NeL, build upon it, +and use it. + +The fact that the source code is available doesn't simply mean you can have a +peek at the innards of the platform. Communication works both ways, so you can +also contribute to its development. +Any bug fix, added functionality, optimisation is not only possible, but +welcome, and improvements will be integrated into the reference platform +maintained by Nevrax. + +NeL is currently developped and tested under GNU/Linux and Windows environments. + +\section structure NeL Structure + +The platform is currenty built upon 4 different components. + +\subsection subnel The NeL Library + +The NeL library provides the core functionality required to build a +multi-user platform. It provides everything from 3D representation to AI to +network services. It is the true heart of the project, and something that +makes use of the best available technologies out there. There is a lot of +room for additions in NeL, from 3D stuff to database to networking. + +\subsection subclient The client + +The client uses the NeL library to provide a user interface to a +multiplayer 3D role-playing game environment. The client is a place of +high opportunity to modify, improve or port to different environments. + +\subsection subserver The server + +The server uses the NeL library to provide a multiplayer 3D role-playing +game environment. The term "server" is misleading, as it represents a server +in logical terms, i.e. something that provides a service. Actual game servers +will be referred to as "clusters", since they typically consist of several +networked systems, acting in close cooperation to run the world simulation +for the players. + +A cluster will scale from a single high-end system that runs the server and +client at the same time to a handful of basic GNU/Linux PCs for mid-size worlds +and to large high-end multiprocessor racked systems for professional level +service. + +The server architecture offers lots of opportunities for tweaking, ranging +from the administrative interfaces, the automated monitoring, backups, to +the physics of the universe simulation, improvements in distributed model and +other enhancement directly visible by the users of the system. + +\subsection subdata The game world + +These 3 pieces of software are completed by game data, which describes a +working world and game system. + +Please note that the game data is not software, and therefore not available under the +GPL. + +As the platform would be useless without a game world, a sample game world +data is provided, which is enough to run the gaming plaform, enjoy a minimum +game experience and let the amateur see exactly what he is doing while +working with NeL. + +The game data is produced using a set of tools, notably 3D Studio's Max for all +3D environment and models, painting programs for textures, spreadsheets for +datas, and so on. When possible, conversion tools for these software are +provided to allow people to produce painlessly their own environment and game +experience. + +\section contribs Community + +Beside the working core of NeL developpers, everyone may improve the NeL +platform. There is a supported community for the development of NeL hosted by +Nevrax in the nevrax.org domain. Various tools are available there to participate: + +- A CVS server \c (cvs.nevrax.org) which allows anonymous CVS checkout to stay in + sync with the reference platform. +- A WWW site \c (www.nevrax.org) which allows you to browse documentation, check the + CVS tree in a visual manner, and register for participation in the evolution of + NeL. +- A mailing list \c (nel@nevrax.org), dedicated to the communication between all + people interested in the NeL platform, regardless of their involvment or + amount of contributions. This is an unmoderated, open mailing list. You may + subscribe thru the WWW side, or by mailing directly to \c nel-request@nevrax.org + with \c "subscribe" in the subject. +- A WWW bug tracker that allows you to submit bugs, get notified of their state, + and their eventual resolution. All you need is a valid email address to + register in the bug database. +- A submission address \c (code@nevrax.org) for user-contributed code and patches, + where your code is evaluated, and usually integrated directly in the reference + platform. + + */
\ No newline at end of file |
