Skip to content

Two enthusiastic open source developers aim to recreate the old school game of Snake for the terminal.

License

Notifications You must be signed in to change notification settings

terminal-based-games/ouroboros

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ouroboros

A terminal-based game inspired by Snake.

Build Status

"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:

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

Windows:

$ 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

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 before getting started.

We welcome developers of any background and skill level. 🌱

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 for more information.

About

Two enthusiastic open source developers aim to recreate the old school game of Snake for the terminal.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages