JacobNickerson / cetris

Tetromino based gravity puzzle game
GNU General Public License v3.0
3 stars 0 forks source link

Contributors Forks Stargazers Issues GPL License LinkedIn


Logo

Cetris

Tetromino-based Gravity Puzzle Game


View Demo · Report Bug · Request Feature
Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

A tetromino-based gravity puzzle game! Cetris is programmed entirely in C++ using SFML for graphical and audio rendering. Boasting seven different unique tetrominos, Cetris challenges your spatial skills and quick-thinking. Use WASD for translation, Q/E for rotation, and SPACE for hard drops. The game level increases after more and more lines are cleared, increasing the speed of gravity but also the points earned. How high can you score?

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

Cetris was built using WSL (Ubuntu 22.04.2 LTS on Windows 10 x86_64). Your version may differ slightly, but should likely work so long as you have the apt-get package manager.

  1. Clone the repo
    git clone https://github.com/JacobNickerson/cetris.git
  2. Update apt-get
    sudo apt-get update
  3. Install packages with apt-get
    sudo apt-get install libsfml-dev && sudo apt-get install make
  4. Install build-essential if you don't have G++ or a C++ compiler
    sudo apt-get install build-essential
  5. Compile and run using the included Makefile
    `make`

This should be sufficient. Most of the build process is automated in the Makefile.

(back to top)

Usage

Use WASD for translation; Q/E for rotation; Space for hard drops; ESC to pause
Clear lines by filling every space in a row. Score increases by clearing lines; clearing more lines in a single move will give increasingly more points.
Level progresses by clearing lines, as level increases, the speed of tetromino automatic falling increases. Clearing lines will grant more points at higher levels.
The next window showcases the next tetromino that will appear.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Jacob Nickerson - jacobnickerson817@gmail.com

Project Link: https://github.com/JacobNickerson/cetris

(back to top)

Acknowledgments

(back to top)