Metadata-Version: 1.0
Name: wordseek
Version: 1.0.7
Summary: Robot word search game
Home-page: https://github.com/dmhacker/wordseek
Author: David Hacker
Author-email: dmhacker@yahoo.com
License: MIT
Description: wordseek
        ========
        
        .. image:: https://travis-ci.org/dmhacker/wordseek.svg
            :target: https://travis-ci.org/dmhacker/wordseek
           
        .. image:: https://pypip.in/wheel/wordseek/badge.png
           :target: https://pypi.python.org/pypi/wordseek
           :alt: Wheel Status
           
        WordSeek is a new take on the classic puzzle game, `Word Search <http://en.wikipedia.org/wiki/Word_search>`__.
        
        WordSeek follows the same rules as its original counterpart except that it is completely automated. Every game, it pits 2 or more Python bots against one another. The fastest bot (in culminative time) wins that round. Time is added for incorrect answers.
        
        Rules
        -----
        
        WordSeek is comprised of 50 turns in one game. Each turn, a random word and 9x9 grid is generated.
        
        Sample grid:
        
        ::
        
                 0    1    2    3    4    5    6    7    8
            0 [['x', 'A', 'd', 'f', 'o', 'x', 'D', 'd', 'd']
            1  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            2  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            3  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            4  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            5  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            6  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            7  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']
            8  ['d', 'd', 'd', 'd', 'd', 'd', 'd', 'd', 'd']]
         
        
        Find word: xAdfoxD
         
        It is your job to create a robot that can return as fast as possible **a list of tuples with each tuple corresponding to a character in the grid so that the list 'spells' out the given word**. For example, the answer to the above grid would be:
        
        ::
        
            [(0,0), (1,0), (2,0), (3,0), (4,0), (5,0), (6,0)]
        
        Note: Possible characters all come from Python's ASCII. No numbers. *CAPS do count!*
        
        If the robot returns the wrong answer, additional penalty time is added to the robot's total time. Penalities are incremental up until the third one.
        
        +-----------+--------------+
        | Mistake   | Penalty      |
        +===========+==============+
        | 1st       | +0 seconds   |
        +-----------+--------------+
        | 2nd       | +5 seconds   |
        +-----------+--------------+
        | 3rd+      | +10 seconds  |
        +-----------+--------------+
        
        Programming
        -----------
        
        When WordSeek is first run, it attempts to read the specified files and find the **Robot class** in your python file. If it has successfully found the class, it will initialize your bot and prepare it for battle!
        
        Every turn, WordSeek will call the method **find_turn(self, grid, word)**. The method should return the location of the word as described in the Rules section.
        
        A dummy implementation goes as follows:
        ::
        
            class Robot:
            
            	# optional
            	author = "Your Name" 
            	
                def find_word(self, grid, word):
                    answer = []
                    # Logic goes here ...
                    return answer
         
        It is strongly recommended that you check out this `starter bot <https://github.com/dmhacker/wordseek/blob/master/wskit/bots/Brutus.py>`__.
         
        Usage
        -----
        
        In order to use this, first, install wordseek using "pip install wordseek" or manually download and run setup.py with the "install" argument. Allowed arguments for running the program are posted below:
        ::
        
            usage: wordseek [-h] [-q] [-i]
                            [--seed SEED]
                            players
        
            wordseek execution script
        
            positional arguments:
              players               Player file names
        
            optional arguments:
              -h, --help            show this help message and exit
              -q, --quiet           Suppress game output
              -i, --immediate       Run the game immediately after startup 
              --seed SEED           Determines output of word grids
        
        Additional credit to `WhiteHalmos and others <https://github.com/RobotGame/rgkit/graphs/contributors>`__ who have contributed to `rgkit <https://github.com/RobotGame/rgkit>`__, the precursor to wordseek.
        
Platform: UNKNOWN
