Skip to main content

A terminal-based snake game

Project description

# Ouroboros > A terminal-based game inspired by Snake.

[![Build Status](https://travis-ci.com/terminal-based-games/ouroboros.svg?branch=master)](https://travis-ci.com/terminal-based-games/ouroboros)

“Snake” is a game that was preloaded on Nokia phones in 1997. A single player controls a square, which continually grows as it moves, resembling a snake. The objective of the game is to get the snake to eat items (by running into food objects) without running into the border of the screen, any obstacles, or itself.

## Build & Run

OS X & Linux: `sh $ pip3 install -r requirements.txt $ git clone https://github.com/terminal-based-games/ouroboros.git $ cd ouroboros $ python3 ouroboros.py `

Windows: `sh $ pip3 install -r requirements.txt $ git clone https://github.com/terminal-based-games/ouroboros.git $ cd ouroboros $ python3 ouroboros.py `

## Play

Objective: Eat as many apples as you can without running into yourself.

Move: Use the arrow keys on your keyboard to move the snake (that’s you!) into any apples that appear. The goal is to eat as many as you can without running into yourself. With each apple, the snake grows a bit in length.

Pause: Hit the space bar to pause the game, and hit the space bar again to resume.

Exit: Press the Escape key at any time to exit the game.

## Demo

![Snake Demo](https://media.giphy.com/media/MdGrSYHxXItqPhXukM/giphy.gif)

## Technology

  • Python 3.7

  • curses

## Roadmap

Deadline | Event | Description |
— | — | — |
07/02/19 | Research | Finalize open source project goal and discuss scope. |
07/06/19 | Design | High-level design, flow charts, and structure for prototype. |
07/09/19 | Demo | Deliver a prototype. |
07/23/19 | Sprint | Develop minimum viable product (“MVP”). |
07/30/19 | Test | Conduct QA and testing. |
08/01/19 | Deploy | Deploy MVP to production. |
08/13/19 | Sprint | Fix bugs, improve UX, polish final product. |

### MVP Our minimum viable product is a functional terminal-based game of Snake. This will be a single player game that can run on Mac OS X.

## Future Work * 2-player mode * AI players * High-score leaderboard

## Contribute

Interested in contributing to this project? We’d love to have you! Please take a moment to review our [guide to contributing](/CONTRIBUTING.md) before getting started.

We welcome developers of any background and skill level. :seedling:

## Testing

Enter the following command to run unit tests:

` pytest `

## Credits

## Built By

All contributors who participate in this project will be recognized here.

## License Distributed under the MIT License. See [LICENSE](/LICENSE) for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open-ouroboros-0.1.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_ouroboros-0.1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file open-ouroboros-0.1.tar.gz.

File metadata

  • Download URL: open-ouroboros-0.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for open-ouroboros-0.1.tar.gz
Algorithm Hash digest
SHA256 59c7a5a36e5c0dd60b4d4041d0fba9a7e966536aabeb5a0c34824a82e87c1e3d
MD5 74ecedacfbe04a13ffbad2fb644f78d9
BLAKE2b-256 1295ea45c0e03a2cd2a35bbdaa55159fc76b0e8e149a9fcd3dcb3395e22752ce

See more details on using hashes here.

File details

Details for the file open_ouroboros-0.1-py3-none-any.whl.

File metadata

  • Download URL: open_ouroboros-0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for open_ouroboros-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e072803bee4bff67dd605155c22271590659242118ad5872252e4ac9c932739d
MD5 e224d1c73d7f85e7e509faa1d36c1f27
BLAKE2b-256 ea1d2823c90d4793e99ed962ae78f5762eed823133ed80ee55ed649b9f465ff1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page