home *** CD-ROM | disk | FTP | other *** search
/ GameStar Special 2004 July / GSSH0704BF.iso / Programme / BFServerManager / readme.txt < prev   
Text File  |  2004-07-28  |  17KB  |  450 lines
  1. ======================================================================
  2. Battlefield Server Manager 2.0 for Windows README
  3. Version 2.0 beta 4e
  4. 11 July 2004
  5. Copyright (c) 2004, Black Bag Operations, www.blackbagops.com
  6. ======================================================================
  7.  
  8. This file contains information about new program features that is not in the
  9. manual. Please read these notes carefully before asking for support.
  10.  
  11. CONTENTS
  12.  
  13. 1. About the New Ban System
  14. 2. About the In-Game Administration System
  15. 3. About the New User Permissions
  16. 4. User Permission Presets
  17. 5. Admin CSV log
  18. 6. Custom Console Commands
  19. 7. Banned Words
  20. 8. Editing PunkBuster Server Settings
  21. 9. UserAccess.con
  22. 10. Additional Information
  23.  
  24. ----------------------------------------------------------------------
  25. 1. About the New Ban System
  26. ----------------------------------------------------------------------
  27.  
  28. Server Manager nows keeps its own player banlist in the file ServerBanList.con
  29. on the server. This banlist is only used by BxSM and is separate from the server
  30. application's banlist kept in BanList.con.
  31.  
  32. When you ban a player in SM or RM, BxSM will ban that player using their keyhash
  33. on an Internet server or their IP on a LAN server. If you have the "ban in both"
  34. option on the Friendly Fire dialog page enabled, BxSM will also ban the player's
  35. GUID on the PunkBuster server.
  36.  
  37. When a player is banned BxSM adds the ids it banned on the server to an entry
  38. for that player in the banlist on the Bans page. A blank id field (IP, keyhash
  39. or GUID) in this list means there is no ban on that id for that player.
  40.  
  41. BxSM also records additional information about the ban including the name of the
  42. BxSM user who banned the player, when the ban took place, when the ban expires,
  43. and a reason for the ban.
  44.  
  45. When you unban a player BxSM unbans all of the player ids that are recorded in
  46. the banlist entry for that player. If multiple banlist entries share the same id
  47. (e.g. IP address) the common id will be removed from all of the banlist entries.
  48.  
  49. When all player ids have been unbanned for a particular player, BxSM will delete
  50. the entire ban entry from the banlist. This is done to help prevent the banlist
  51. growing to a large size over time.
  52.  
  53. You can see that the bans shown on the Bans page are a listing of the CURRENT
  54. player bans in place, not a list of every ban that has ever occured. The new
  55. admin CSV log fulfills this purpose.
  56.  
  57. How to Ban and Unban Using the New System
  58. -----------------------------------------
  59.  
  60. When you ban a player using the Player menu, the ban is automatically added to
  61. the banlist on the Bans dialog page. See the section "About the Player menu" in
  62. the BxSM manual for more information about the Player menu.
  63.  
  64. You can also ban players manually using the controls on the Bans page:
  65. 1. Enter at least one ban id in the fields provided
  66. 2. Click Save to record the ban
  67.  
  68. To unban a player:
  69. 1. Select an entry in the banlist using the mouse
  70. 2. Click Delete to unban the player
  71.  
  72. To clear BOTH the BxSM AND server banlists:
  73. 1. Click the Clear button
  74. 2. Click Yes to the failsafe prompt
  75.  
  76. Banlist Synchronisation Functions
  77. ---------------------------------
  78.  
  79. There are several functions available to control synchronisation between the
  80. BxSM and server banlists. These functions are available from the right-click
  81. menu on the Bans dialog page.
  82.  
  83. 1. Verify synchronisation
  84.  
  85. This function does a two-way comparison between the BxSM and server banlists and
  86. records the outcome in the BxSM log. Use this function to determine whether or
  87. not the banlists are in sync. If they are not synchronised you can use one of
  88. the following two functions to synchronise them again.
  89.  
  90. 2. Sync to server banlists
  91.  
  92. This function will force synchronisation by exporting FROM the BxSM banlist TO
  93. the server banlist. This action can cause loss of information if the server
  94. banlist contains bans that are not recorded in the BxSM banlist. Use this
  95. function after reinstalling a server application to recover the server banlist.
  96.  
  97. 3. Sync from server banlists
  98.  
  99. This function will force synchronisation by importing FROM the server banlist TO
  100. the BxSM banlist. This action can cause loss of information if the BxSM banlist
  101. contains bans that are not recorded in the server banlist. Use this function
  102. when migrating to BxSM beta 4e to import an existing server banlist into BxSM.
  103.  
  104. Please note that bans cannot be edited once they are added to the list on the
  105. Bans dialog page.
  106.  
  107. ----------------------------------------------------------------------
  108. 2. About the In-Game Administration System
  109. ----------------------------------------------------------------------
  110.  
  111. The in-game administration system works via the chat message system in the game.
  112. This feature does NOT require users to be connected with Remote Manager.
  113.  
  114. NOTE: In-game admin only works on Internet game servers, it will not work on LAN
  115. game servers. In-game administration will not work in BFVietnam before v1.1.
  116.  
  117. To enable in-game administration for a particular player you must create a BxSM
  118. user account with the keyhash of the player that is permitted to issue admin
  119. commands in-game.
  120.  
  121. Use the new "Copy keyhash to user" player menu command to associate a player's
  122. keyhash with a BxSM user account. You must click Save on the Users page after
  123. using this command to save the keyhash permanently.
  124.  
  125. Players that do not have a BxSM user account with an associated keyhash cannot
  126. issue in-game admin commands.
  127.  
  128. BxSM looks for commands in the chat messages formatted in the following manner;
  129.  
  130. !alias name
  131. OR
  132. !alias .id
  133.  
  134. The exclamation mark (!) identifies the chat message as a BxSM in-game admin
  135. command.
  136.  
  137. The 'alias' is a command alias configured in PlayerMenu.con. This system allows
  138. you to use any Player menu command in-game. Specify command aliases in [square
  139. brackets] at the end of a line in PlayerMenu.con like so:
  140.  
  141. Warn server>"Please do not chat spam"|global,[gwspam]
  142.  
  143. To issue the above global warning message in-game, send the following command
  144. chat message:
  145.  
  146. !gwspam
  147.  
  148. The PlayerMenu.con file that comes with BxSM contains a command alias for each
  149. command in the default menu. Print this file for use as a reference to in-game
  150. commands aliases until you learn them.
  151.  
  152. You can target admin commands at particular players using a partial name or id
  153. number like so;
  154.  
  155. !kick bozo
  156. OR
  157. !kick .10
  158.  
  159. Player id numbers MUST be prepended with a period (.) character.
  160.  
  161. You can match multiple players with a single command by prepending the @ symbol
  162. to the partial player name like so:
  163.  
  164. !kick @tag
  165.  
  166. The above command would cause all players with 'tag' in their player name to be
  167. kicked from the server.
  168.  
  169.  
  170. In-game Map Commands
  171. --------------------
  172.  
  173. There are four in-built map commands that are available to any BxSM in-game
  174. admin user that has access to the Maps dialog page:
  175.  
  176. 1. !change <mapname> <gamemode> <modname>
  177. This command changes the server to the specified map immediately.
  178. <gamemode> is the same syntax used in MapList.con (GPM_CQ, GPM_COOP, etc).
  179.  
  180. 2. !setnext  <mapname> <gamemode> <modname>
  181. This command sets the specified map to play next in the rotation.
  182.  
  183. 3. !runnext
  184. This command causes the server to change to the next map in the rotation.
  185.  
  186. 4. !restart
  187. This command restarts play on the current map.
  188.  
  189. BxSM will display error messages relating to in-game administration as chat
  190. messages in-game. Keep a watch for these messages after you issue a command.
  191.  
  192. See the section on Custom Console Commands in these notes for instructions about
  193. how to make custom console commands available via the in-game admin system.
  194.  
  195. ----------------------------------------------------------------------
  196. 3. About the New User Permissions
  197. ----------------------------------------------------------------------
  198.  
  199. Beta 4e changes the way user permissions are granted in the SM and RM GUI. To
  200. grant or revoke permissions, right-click a user account in the list on the Users
  201. dialog page and check or uncheck the desired permission. Click Save to make
  202. changes permanent.
  203.  
  204. 1. User can start/stop the server
  205. Controls who can use the Start/Stop button in RM.
  206.  
  207. 2. User can view server log
  208. Controls who can view the Server Manager log in Remote Manager.
  209.  
  210. 3. User can connect multiple times
  211. Prevents more than one user connecting with the same user account
  212. simultaneously.
  213.  
  214. 4. User can change critical settings
  215. Controls who can change server hardware settings on the Server dialog page.
  216.  
  217. 5. User can issue console commands
  218. Controls who can use custom console commands defined in PlayerMenu.con.
  219.  
  220. 6. User can edit PunkBuster settings
  221. Controls who has access to the PunkBuster commands in the Settings button-menu.
  222.  
  223. To make a user an -admin- user, click 'Grant admin access' in the User menu. To
  224. revoke all permissions, click 'Revoke all access' in the User menu.
  225.  
  226. ----------------------------------------------------------------------
  227. 4. User Permission Presets
  228. ----------------------------------------------------------------------
  229.  
  230. You can configure customised presets for permissions in the BXServerManager.ini
  231. or BXRemoteManager.ini files by choosing "Edit permissions presets" from the
  232. User menu.
  233.  
  234. Each preset is displayed as a menu item in the User menu. Selecting the menu
  235. item selects all the page buttons and permissions configured in the preset.
  236.  
  237. To configure presets, add an INI file section called [presets] and specify up to
  238. 10 presets like so;
  239.  
  240. Preset[#]=[name],[permissions]
  241.  
  242. For example,
  243.  
  244. [presets]
  245. Preset0=Sergeant,2272
  246. Preset1=Lieutenant,2528
  247. Preset2=Major,211455
  248. Preset3=Colonel,229375
  249.  
  250. The permissions number is constructed by adding up the permissions you want from
  251. the following table;
  252.  
  253. Server Page          1
  254. Game Page            2
  255. Friendly Fire Page   4
  256. Miscellaneous Page   8
  257. Admin Page           16
  258. Status Page          32
  259. Maps Page            64
  260. Players Page         128
  261. Bans Page            256
  262. Users Page           512
  263. Schedule Page        1024
  264. Clients Page         2048
  265. Start/stop server    4096
  266. View SM log          8192
  267. Logon multiple times 16384
  268. Critical settings    32768
  269. Console commands     65536
  270. Edit PB settings     131072
  271.  
  272. ----------------------------------------------------------------------
  273. 5. Admin CSV log
  274. ----------------------------------------------------------------------
  275.  
  276. BxSM now keeps a record of all kicks and bans in adminlog.csv. This
  277. comma-separated-values text file has the following format;
  278.  
  279. name, address, keyhash, guid, admin, bantime, mapname, action, expires, reason
  280.  
  281. The 'bantime' and 'expires' fields are date/time values in Epoch format (number
  282. of seconds elapsed since Jan 1 1970).
  283.  
  284. The admin CSV log can be used with an external application to provide "Why Was I
  285. Kicked/Banned" functionality for external users.
  286.  
  287. ----------------------------------------------------------------------
  288. 6. Custom Console Commands
  289. ----------------------------------------------------------------------
  290.  
  291. Server Manager beta 4e allows you to configure customised console commands via
  292. the Player menu. This feature allows you to configure commands that are not
  293. built-in to Server Manager. These commands can also be made available via the
  294. in-game administration system by specifying a command alias.
  295.  
  296. Use the new "cmd" Player menu keyword to configure custom console commands like
  297. so;
  298.  
  299. Console Commands>"admin.toggleGamePause"|cmd,[pause]
  300.  
  301. The console command goes inside the "double-quotes". You can use the following
  302. parameters in custom console commands which will be substitued for the indicated
  303. value when the command is executed;
  304.  
  305. %bfid
  306. %pbid
  307. %name
  308. %keyhash
  309. %guid
  310.  
  311. For example,
  312.  
  313. Console Commands>"pb_sv_power %pbid 100"|cmd,[deputy]
  314.  
  315. This command makes the selected player a PunkBuster "deputy". By specifying a
  316. command [alias] you can also use this command via in-game admin like so;
  317.  
  318. !deputy player
  319.  
  320. The new "User can issue console commands" permission controls who can issue
  321. these commands. See the "About the New User Permissions" section in these notes
  322. for more information about the new permissions.
  323.  
  324. ----------------------------------------------------------------------
  325. 7. Banned Words
  326. ----------------------------------------------------------------------
  327.  
  328. The Banned Names functions in previous versions of BxSM has been replaced by the
  329. new Banned Words function.
  330.  
  331. The "Enable auto-kick on banned word" function available from the Admin dialog
  332. page will kick any player that has a banned word in his/her player name or chat
  333. messages. Players are not warned before being kicked.
  334.  
  335. Specify the words you want to ban in BannedWords.con using the same format
  336. previously used in BannedNames.con (you can rename BannedNames.con to
  337. BannedWords.con to preserve your existing list if you want).
  338.  
  339. Click the Edit BannedWords.con button on the Admin dialog page and add the names
  340. that you want to ban one-per-line. By default, BxSM will look for a partial
  341. match of any name you specify here. If you want to specify an exact match, start
  342. the line with a dollar sign ($). All names are matched without regard to case.
  343.  
  344. ----------------------------------------------------------------------
  345. 8. Editing PunkBuster Server Settings
  346. ----------------------------------------------------------------------
  347.  
  348. You can now edit your server's PunkBuster configuration using the new commands
  349. in the Settings button-menu.
  350.  
  351. Access to these commands is controlled using the new "User can edit PunkBuster
  352. settings" permission. See the "About the New User Permissions" section in these
  353. notes for more information about the new permissions.
  354.  
  355. There are three commands available from this menu;
  356.  
  357. 1. Dump PunkBuster settings
  358. This command causes the current PunkBuster server config to be written to
  359. pbsv.cfg in the PB directory on the server.
  360.  
  361. 2. Edit PunkBuster settings
  362. This command opens the PunkBuster server's config file (pbsv.cfg) locally for
  363. editing in Notepad. Edit the file as desired and save it before using the next
  364. command.
  365.  
  366. 3. Load PunkBuster settings
  367. This command saves the modified config pbsv.cfg file to the server and causes it
  368. to be loaded into the running PunkBuster server thereby applying the changes.
  369.  
  370. The PunkBuster server config file contains detailed remarks about each setting
  371. and its allowable values. Consult this file and the following webpage for more
  372. information about PunkBuster server settings;
  373.  
  374. http://www.evenbalance.com/publications/bf1942-ad/index.htm
  375.  
  376. ----------------------------------------------------------------------
  377. 9. UserAccess.con
  378. ----------------------------------------------------------------------
  379.  
  380. This file records information about BxSM users on the server. This file is
  381. normally encrypted but beta 4e will recognise unencrypted entries in this file
  382. which can be generated by scripted server setup systems used by GSPs.
  383.  
  384. The file format is as follows;
  385.  
  386. username,password,keyhash,permissions,state
  387.  
  388. The 'username', 'password' and 'keyhash' fields are limited to 32 characters in
  389. length. Keyhash must be a valid 32-digit hexadecimal number.
  390.  
  391. The permissions field is constructed by adding up the permissions you want from
  392. the following table;
  393.  
  394. Server Page          1
  395. Game Page            2
  396. Friendly Fire Page   4
  397. Miscellaneous Page   8
  398. Admin Page           16
  399. Status Page          32
  400. Maps Page            64
  401. Players Page         128
  402. Bans Page            256
  403. Users Page           512
  404. Schedule Page        1024
  405. Clients Page         2048
  406. Start/stop server    4096
  407. View SM log          8192
  408. Logon multiple times 16384
  409. Critical settings    32768
  410. Console commands     65536
  411. Edit PB settings     131072
  412.  
  413. The state field is either '1' for enabled or '0' for disabled.
  414.  
  415. Server Manager will encrypt any clear-text entries it finds in UserAccess.con
  416. the first time this file is read.
  417.  
  418. ----------------------------------------------------------------------
  419. 10. Additional Information
  420. ----------------------------------------------------------------------
  421.  
  422. This software is not endorsed or supported by either Electronic Arts or Digital
  423. Illusions CE. Do not contact them about any problems you may experience while
  424. using this program.
  425.  
  426. For more information about BxSM read the Users Guide available at;
  427. http://www.blackbagops.com/files/bfsm20ug.pdf
  428.  
  429. See the News page for a list changes from previous versions of BxSM;
  430. http://www.blackbagops.com/news.shtml
  431.  
  432. You can find a list of resources for trouble-shooting problems with BFSM at;
  433. http://www.blackbagops.com/bf1942/bfsm/support.shtml
  434.  
  435. Post questions and other support requests in the BBO forums;
  436. http://www.blackbagops.com/forums.shtml
  437.  
  438. Read the answers to frequently asked questions in the FAQ here;
  439. http://www.blackbagops.com/bf1942/bfsm/faq.shtml
  440.  
  441. Get the latest version of BVSMD at "Black Bag Operations";
  442. http://www.blackbagops.com/bf1942/index.shtml
  443.  
  444. Find contact details for the author of this software at;
  445. http://www.blackbagops.com/contact.shtml
  446.  
  447. ======================================================================
  448. END
  449. ======================================================================
  450.