doc/plugins.ini
changeset 0 d15304fcb7a7
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/plugins.ini	Tue Apr 06 07:36:14 2004 +0000
     1.3 @@ -0,0 +1,35 @@
     1.4 +// vim: set ft=c :
     1.5 +//
     1.6 +// Format is as follows:
     1.7 +//  <platform>	<path>			<description>
     1.8 +//
     1.9 +// Fields are whitespace delimited (tabs/spaces).
    1.10 +//
    1.11 +// - Platform must be either "linux" or "win32".
    1.12 +// - Path can be either an absolute pathname, or a pathname relative to the
    1.13 +//   gamedir.  Paths should use unix-style forward slashes (/) rather than
    1.14 +//   windows-style backslashes (\), even on windows platforms.  Also, the
    1.15 +//   path (once expanded to full path name) is expected to be unique within
    1.16 +//   the list of plugins.  Thus, a plugin with a fullpathname matching that 
    1.17 +//   of a previous plugin is considered a duplicate, and is not loaded.
    1.18 +// - Description is optional, and replaces the plugin's internal name in
    1.19 +//   console output and log messages.
    1.20 +//
    1.21 +// Comments are either c++ style ("//") or unix shell style ("#"), and 
    1.22 +// can appear ONLY at the beginning of a line.
    1.23 +//
    1.24 +// Note that the plugins are loaded and accessed in the order specified, so
    1.25 +// ordering CAN be important, depending on the plugin(s).
    1.26 +//
    1.27 +// The following are examples of valid lines.
    1.28 +//
    1.29 +
    1.30 +// linux	dlls/mybot.so
    1.31 +# win32		dlls/mybot-old.dll	Mybot old
    1.32 +win32		dlls/mybot.dll		Mybot current
    1.33 +linux		/tmp/stub_mm_i386.so
    1.34 +win32		/tmp/stub_mm_i386.dll
    1.35 +linux		../dlls/trace_mm_i386.so
    1.36 +win32		../dlls/trace_mm_i386.dll
    1.37 +linux		dlls/admin_MM_i386.so
    1.38 +win32		dlls/admin_MM_i386.dll