Package: schieber
Copyright (c) 2017 Samuel KurathCopyright (c) 2018 Joel NiklausPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.Description: [![Build Status](https://travis-ci.org/JoelNiklaus/schieber.svg?branch=master)](https://travis-ci.org/JoelNiklaus/schieber)<a href="url"><img src="/docs/images/jasskarten.gif" align="right" width="300" ></a># schieberSchieber is an implementation of the well known Swiss Schieber Jass game.As OpenAI Gym provides APIs for several popular games to learn your algorithms master these games.Schieber aims to offer an API in the same manner.## UsageTo install schieber, simply:```bashpip install schieber```schieber officially supports Python 3.4, 3.5, 3.6, 3.7, 3.5-dev, 3.6-dev, 3.7-dev, nightly and PyPy3.### CLI :computer:Beside of the API, schieber provides a CLI client to play the funny Scheiber Jass game.Currently your opponent will be a bot choosing a random card.After the pip installation you could run the ```schieber``` command on the console to play a game:```bash$ schieberTournament starts, the goal are 1500 points.--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------Round 1 starts.--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------Hand cards:0 : <BELL:Koennig>1 : <ACORN:9>2 : <ROSE:9>3 : <ACORN:Ober>4 : <ROSE:Banner>5 : <SHIELD:8>6 : <ACORN:Ass>7 : <ROSE:Ass>8 : <ROSE:Under>Trumpf:0 : Trumpf.OBE_ABE1 : Trumpf.UNDE_UFE2 : Trumpf.ROSE3 : Trumpf.BELL4 : Trumpf.ACORN5 : Trumpf.SHIELD6 : Trumpf.SCHIEBENGeschoben: FalsePlease chose the trumpf by the number from 0 to 6:```### Jass ChallengeThe usage of a CLI to play Schieber Jass could be boring.Therefore schieber provides a wrapper for your bots to play on the Zühlke Jass Server.The [ServerPlayer](schieber/player/server_player/server_player.py) takes a schieber conform playerAn example how to launch is provide under [Server Launcher](schieber/example/server_launcher.py).For further information have a look at:*  https://github.com/webplatformz/challenge*  https://github.com/jakeret/elbotto## API :clipboard:The idea of schieber is to extend the game with your own implemented player.Hence schieber provides entry points to fulfill this requirement.## Environment introductionTo get a first feeling for the schieber playground let's have a look at a runable example.1. The first thing you have to do, is to instantiate a new Tournament.```pythonfrom schieber.tournament import Tournamenttournament = Tournament(point_limit=1500)```2. Add the players to your tournament. In our example we use the erratic RandomPlayers Tick, Trick, Track and the GreedyPlayer Dagobert.```pythonfrom schieber.player.random_player import RandomPlayerfrom schieber.player.greedy_player.greedy_player import GreedyPlayerplayers = [RandomPlayer(name='Tick'), RandomPlayer(name='Trick'),RandomPlayer(name='Track'), GreedyPlayer(name='Dagobert')][tournament.register_player(player) for player in players]```3. Now we are ready to play, let the games begin!```pythontournament.play()```## Build your own Player :runner:As you might have noticed we registered two different types of players on our tournament.Thus the idea is to implement your own Player to beat Trick, Trick and Track.Basically the Player has to provide the methods:* set_card(card)* called by the dealer to get your cards at the start of every round* choose_trumpf(geschoben)* called when it's your turn to choose a trumpf, this has to be a generator and is recalled until the chosen trumpf is allowed* choose_card(state)* called when it's your turn to choose a card, this has to be a generator and is recalled until the chosen card is allowedAdditionally there is the stich_over(state) method, that is called after all players had chosen their cards.The easiest way to implement your own player is to inherit from the BasePlayer class (due to the fact that Python uses duck typing it is not absolutely necessary), which provieds some basic functionality like store your cards.To get more familiar with this concept let's have a look at the already mentioned Random Player.```pythonimport randomfrom schieber.player.base_player import BasePlayerfrom schieber.trumpf import Trumpfclass RandomPlayer(BasePlayer):def choose_trumpf(self, geschoben):return move(choices=list(Trumpf))def choose_card(self):return move(choices=self.cards)def move(choices):allowed = Falsewhile not allowed:choice = random.choice(choices)allowed = yield choiceif allowed:yield None```What's going on here?The Random Player is pretty naive and he simply chooses randomly a card or a trumpf from the list of choices.If the turn is not allowed he randomly chooses a new one until the rules of Schieber are satisfied.Other player examples are the [GreedyPlayer](schieber/player/greedy_player/greedy_player.py) or the [CliPlayer](schieber/player/cli_player.py).Now you should be ready to get your hands dirty to implement your own player and beat the random players Tick, Trick and Track! :trophy:## Enhancements* Add Wiesen to the game* Beautify the CLI :trollface:* Provide a simple network player* Implement Matschbonus!Platform: UNKNOWNDescription-Content-Type: text/markdown