Final changes with AI refactoring

Author: Nihisil

.gitignore

@@ -6,7 +6,7 @@ __pycache__
 .DS_Store
 logs
 project/settings_local.py
-old_version.py
+project/game/ai/common
 
 tests_validate_hand.py
 loader.py

README.md

@@ -60,8 +60,8 @@ For the next version I have a plan to improve win rate, probably bot should push
 
 ## How to run it?
 
-Run `pythone main.py` it will connect to the tenhou.net and will play a match. 
-After the end of the match it will close connection to the server
+1. `pip install -r requirements.txt`
+2. Run `pythone main.py` it will connect to the tenhou.net and will play a game
 
 ## Configuration instructions
 
@@ -70,6 +70,21 @@ They will override settings from default `settings.py` file
 2. Also you can override some default settings with command argument. 
 Use `python main.py -h` to check all available commands
 
+## Implement your own AI
+
+We tried to isolate default AI from the project as much as we could.
+
+There is `game.ai.base.InterfaceAI` with one required method `discard_tile` that had to be implemented by your AI.
+
+### Start with your AI
+
+This command will make a copy of the simple bot (it is discarding random tiles from the hand)
+1. `cd project`
+2. `cp -a game/ai/random game/ai/common` 
+3. You can run new AI with command: `python main.py -a common` (or change `AI_PACKAGE` in settings)
+
+After that you can change all what you want in `game.ai.common` package and test it in real games.
+
 ## Round reproducer
 
 We built the way to reproduce already played round. 

project/game/ai/base/main.py

@@ -16,15 +16,15 @@ def __init__(self, player):
 
     def discard_tile(self, discard_tile):
         """
-        Simple tile discard (after draw)
-        :param discard_tile: 136 tile format
+        AI should decide what tile had to be discarded from the hand on bot turn
+        :param discard_tile: 136 tile format. Sometimes we want to discard specific tile
         :return: 136 tile format
         """
         raise NotImplemented()
 
-    def init_state(self):
+    def init_hand(self):
         """
-        Method will be called after bot hand initialization
+        Method will be called after bot hand initialization (when tiles will be set to the player)
         :return:
         """
 
@@ -43,23 +43,22 @@ def draw_tile(self, tile):
 
     def should_call_win(self, tile, enemy_seat):
         """
-        When we can call win by other player discard
-        this methid will be called
+        When we can call win by other player discard this method will be called
         :return: boolean
         """
         return True
 
     def should_call_riichi(self):
         """
-        When bot in tempai this method will be run
+        When bot can call riichi this method will be called.
         You can check additional params here to decide should be riichi called or not
         :return: boolean
         """
         return False
 
     def should_call_kan(self, tile, is_open_kan):
         """
-        Method will decide should we call a kan or upgrade pon to kan (chankan)
+        When bot can call kan or chankan this method will be called
         :param tile: 136 tile format
         :param is_open_kan: boolean
         :return: kan type (Meld.KAN, Meld.CHANKAN) or None
@@ -68,7 +67,7 @@ def should_call_kan(self, tile, is_open_kan):
 
     def try_to_call_meld(self, tile, is_kamicha_discard):
         """
-        Determine should we call a meld or not.
+        When bot can open hand with a set (chi or pon/kan) this method will be called
         :param tile: 136 format tile
         :param is_kamicha_discard: boolean
         :return: Meld and DiscardOption objects or None, None

project/game/ai/first_version/main.py

@@ -51,7 +51,7 @@ def __init__(self, player):
         self.in_defence = False
         self.last_discard_option = None
 
-    def init_state(self):
+    def init_hand(self):
         """
         Let's decide what we will do with our hand (like open for tanyao and etc.)
         """

project/game/player.py

@@ -133,7 +133,7 @@ def erase_state(self):
     def init_hand(self, tiles):
         self.tiles = tiles
 
-        self.ai.init_state()
+        self.ai.init_hand()
 
     def draw_tile(self, tile):
         self.last_draw = tile