View source for Cookbook:Accessing CD Key Hash

== Problem ==

You want to access the [[Player Identity#CD Key Hash|CD Key Hashes]] for players in a game from within a Python script.


== Solution ==

Use the <code>host.rcon_invoke</code> method to send the <code>admin.listPlayers</code> command to the game engine; then use a regular expression to parse the resulting table.

   <nowiki>import re
  
  def playerData():
      '''Returns a dictionary containing player data; dictionary keys are
         playerIDs, values are 4-element tuples, containing player name,
         IP address, IP port, and cd-key hash.'''
      
      rawData = host.rcon_invoke("admin.listplayers")
      
      pattern = re.compile(r'''^Id:\ +(\d+)                              # PlayerID
                               \ -\ (\S+)                                # Player Name
                               \ is\ remote\ ip:\ (\d+\.\d+\.\d+\.\d+):  # IP Address
                               (\d+)                                     # Port Number
                               (?:.*hash:\ (\w{32}))?                    # CD Key Hash
                            ''', re.DOTALL | re.MULTILINE | re.VERBOSE)
      
      result = {}
      for player in pattern.findall(rawData):
          result[int(player[0])] = player[1:]
      
      return result</nowiki>


== Discussion ==

This function packages the parsed data into a dictionary keyed by [[Player Identity#Player ID|Player ID]] for easy access.

A simple example of how you would use this function:
  # print a list of [[Player Identity#Player Name|player names]], [[Player Identity#IP Address|IP addresses]], and [[Player Identity#CD Key Hash|CD key hashes]]:
  
  info = playerData()
  for playerID in info:
      print info[playerID][0], info[playerID][1], info[playerID][3]

In principle you could do the same sort of thing with the <code>pb_sv_plist</code> command to retrieve each player's [[Player Identity#PunkBuster GUID|PunkBuster GUID]]. Unfortunately, there is a bug/"unimplemented feature" in BF2, the result of which is that Python and RCon clients never get any output from PunkBuster commands.

If you need to convert CD keys into key hashes, check out [[Cookbook:Computing_CD_Key_Hashes|keyHash]] or [[BF2_Key_Hasher]].


== Submitted By ==

--[[User:woody|Woody]]