| Name | snakey JSON | 
            
| Version | 
                  2.1.0
                   
                  JSON | 
            
 | download  | 
            
| home_page |   | 
            
| Summary | A simple snake game written in python. | 
            | upload_time | 2023-01-23 20:21:52 | 
            | maintainer |  | 
            
            | docs_url | None | 
            | author |  | 
            
            | requires_python | >=3.7 | 
            
            
            | license | MIT | 
            | keywords | 
                
                    snake
                
                    pygame
                 | 
            | VCS | 
                
                    | 
                
            
            | bugtrack_url | 
                
                 | 
             
            
            | requirements | 
                
                  No requirements were recorded.
                
             | 
            
| Travis-CI | 
                
                   No Travis.
                
             | 
            | coveralls test coverage | 
                
                   No coveralls.
                
             | 
        
        
            
            # Snakey
A simple snake game made with pygame with multiplayer option.
## Running the game
To install Snakey, run the following command:
```bash
python -m pip install snakey
```
Then, to run the game, execute:
```bash
python -m snakey
```
A new window should appear where you and your friend can play a game of snake. Default keys for player one are 
<kbd>↑</kbd>, <kbd>↓</kbd>, <kbd>→</kbd> and <kbd>←</kbd>. Keys for player two are 
<kbd>W</kbd>, <kbd>S</kbd>, <kbd>D</kbd> and <kbd>A</kbd>.
## Game configuration
Game configuration is defined with a json configuration file, by default, this configuration is set like this:
```json
{
    "main_window_size": [640, 480],
	"block_size": 10,
    "refresh_rate": 100,
    "num_snakes": 2,
    "start_pos": [[300, 100],
			   [300, 200],
			   [300, 300],
			   [300, 400]],
    "keys": [["K_UP", "K_RIGHT", "K_DOWN", "K_LEFT"],
		     ["K_w", "K_d", "K_s", "K_a"],
		     ["K_t", "K_h", "K_g", "K_f"],
		     ["K_i", "K_l", "K_k", "K_j"]],
	"initial_snake_length": 10,
	"num_cherries": 2
}
```
In order to run the game with different configuration, create a new .json file, and modify the configuration there.
Then, provide the path to the created file with *--config* option, like this
```bash
python -m snakey --config {path to configuration file}
```
            
         
        Raw data
        
            {
    "_id": null,
    "home_page": "",
    "name": "snakey",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "snake,pygame",
    "author": "",
    "author_email": "Jost Prevc <jost.prevc@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f8/24/2dc980b5c662bcac69c1110f1272042e4f26926c6017c2ed8755d0a9f37f/snakey-2.1.0.tar.gz",
    "platform": null,
    "description": "# Snakey\n\nA simple snake game made with pygame with multiplayer option.\n\n## Running the game\n\nTo install Snakey, run the following command:\n\n```bash\npython -m pip install snakey\n```\n\nThen, to run the game, execute:\n\n```bash\npython -m snakey\n```\n\nA new window should appear where you and your friend can play a game of snake. Default keys for player one are \n<kbd>↑</kbd>, <kbd>↓</kbd>, <kbd>→</kbd> and <kbd>←</kbd>. Keys for player two are \n<kbd>W</kbd>, <kbd>S</kbd>, <kbd>D</kbd> and <kbd>A</kbd>.\n\n## Game configuration\nGame configuration is defined with a json configuration file, by default, this configuration is set like this:\n\n```json\n{\n    \"main_window_size\": [640, 480],\n\t\"block_size\": 10,\n    \"refresh_rate\": 100,\n    \"num_snakes\": 2,\n    \"start_pos\": [[300, 100],\n\t\t\t   [300, 200],\n\t\t\t   [300, 300],\n\t\t\t   [300, 400]],\n    \"keys\": [[\"K_UP\", \"K_RIGHT\", \"K_DOWN\", \"K_LEFT\"],\n\t\t     [\"K_w\", \"K_d\", \"K_s\", \"K_a\"],\n\t\t     [\"K_t\", \"K_h\", \"K_g\", \"K_f\"],\n\t\t     [\"K_i\", \"K_l\", \"K_k\", \"K_j\"]],\n\t\"initial_snake_length\": 10,\n\t\"num_cherries\": 2\n}\n```\n\nIn order to run the game with different configuration, create a new .json file, and modify the configuration there.\nThen, provide the path to the created file with *--config* option, like this\n\n```bash\npython -m snakey --config {path to configuration file}\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple snake game written in python.",
    "version": "2.1.0",
    "split_keywords": [
        "snake",
        "pygame"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "265a6f9c905b0a7d71864b5ed7bf312536258f92aecc513c53abf87d0e6a366e",
                "md5": "927f28aaadda53c9398c4a0685ba3baf",
                "sha256": "391a71039c4f6988039aa379258ed6cdb9b16511bc636b6f49e1807a5166188c"
            },
            "downloads": -1,
            "filename": "snakey-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "927f28aaadda53c9398c4a0685ba3baf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 7161,
            "upload_time": "2023-01-23T20:21:51",
            "upload_time_iso_8601": "2023-01-23T20:21:51.184994Z",
            "url": "https://files.pythonhosted.org/packages/26/5a/6f9c905b0a7d71864b5ed7bf312536258f92aecc513c53abf87d0e6a366e/snakey-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f8242dc980b5c662bcac69c1110f1272042e4f26926c6017c2ed8755d0a9f37f",
                "md5": "1e0ff2bccb45830aff7b9d77d7ae7490",
                "sha256": "63c25ee41f9523a701925cc20bc14f769c29e1e413d65da8d717be6de42f7500"
            },
            "downloads": -1,
            "filename": "snakey-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1e0ff2bccb45830aff7b9d77d7ae7490",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 16965,
            "upload_time": "2023-01-23T20:21:52",
            "upload_time_iso_8601": "2023-01-23T20:21:52.329991Z",
            "url": "https://files.pythonhosted.org/packages/f8/24/2dc980b5c662bcac69c1110f1272042e4f26926c6017c2ed8755d0a9f37f/snakey-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-23 20:21:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "snakey"
}