My 211 Project: Tetris Game

About

• Project Creation Date: 2023-12
• Author: Ulaş Can Demirbağ
• Student ID: -------
• Email: [email protected]
• GitHub: ulascan54

This README file provides information on how to compile and run the Tetris game, along with attributions and resources used in the project.

This project is created for the CSE 211 Data Structure Term project.

Game Description

Tetris is a tile-matching puzzle video game originally designed and programmed by Soviet Russian game designer Alexey Pajitnov. The first playable version was completed on June 6, 1984, while he was working for the Dorodnitsyn Computing Centre of the Academy of Science of the Soviet Union in Moscow. He derived its name from the Greek numerical prefix tetra- (all of the game's pieces contain four segments) and tennis, Pajitnov's favorite sport.

Project Structure

• bin folder contains the executable file.
• lib folder contains the object files and the SFML library files.
• include folder contains the header files.
• src folder contains the source code files.
• images folder contains the images used in the game.
• sounds folder contains the music used in the game.
• font folder contains the fonts used in the game.
• Makefile is used to compile the project.
• readme.md is the readme file.
• high_scores.txt is the file that stores the highscores.

Requirements

• SFML library must be installed. Refer to the SFML documentation for installation instructions: SFML Download and Installation
• macOS Apple Silicon Chip System (ARM 64) M1, M2 Recommended
• Linux x86_64
• Windows x86_64

SFML Requirements

• SFML 2.5.1
• GCC 9.3.0
• minGW w64
• Make 4.3
• Clang 12.0.0
• Xcode 12.5.1
• CMake 3.22.5

Dependencies

• freetype
• x11
• xrandr
• udev
• opengl
• flac
• ogg
• vorbis
• vorbisenc
• vorbisfile
• openal
• pthread

SFML Installation

• Genaral Guide
• Guide for macOS
• Guide for Linux
• Explanation Video

Compilation and Execution Steps

I also added CMakeLists.txt file for cmake users.

For CMake Users:

MacOS & Linux

   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
   cmake --build build
   cd build
   make
   ./build/bin/cmake-tetris

Windows

   cmake -S . -B build
   cmake --build build --config Release
   cd build
   make
   ./build/bin/cmake-tetris.exe

• You can find more details in this readme.md.
• CMakeLists.txt Run Details

For Makefile Users:

• Succestion: Run this game Development Mode
• if you want to run this game correctly you must run this game in development mode.

macOS

1. Development Mode (Compile Everything to lib): In development mode, it will compile everything in this project:

   To compile, use the following command:

   make m

   This command will compile only necessary files in the lib folder.

2. Run:

   If you want to run the game, use the following command:

   make run-m

   or

   ./bin/app-m

Linux

1. Fast Play:

2. Development Mode (Compile Everything to lib): In development mode, it will compile everything in this project:

   To compile, use the following command:

   make l

   This command will compile only necessary files in the lib folder.

3. Run:

   If you want to run the game, use the following command:

   make run-l

   or

   ./bin/app-l

Wındows

1. Fast Play:

2. Development Mode (Compile Everything to lib): In development mode, it will compile everything in this project:

   To compile, use the following command:

   make w

   This command will compile only necessary files in the lib folder.

3. Run:

   If you want to run the game, use the following command:

   make run-w

   or

   ./bin/app-w.exe

   Note: Clear Files Command

   make clear

Headers and Files Explanation

• Game.h contains the main game loop and the game logic.
• Board.h contains the board class and the board logic.
• Piece.h contains the piece class and the piece logic.
• MainMenu.h contains the menu class and the menu logic.
• highscores.h contains the highscores class and the highscores logic.
• TextBox.h contains the text box class and the text box logic.
• Player.h contains the player class and the player logic.
• CustomPieceGenerator.h contains the custom piece generator class and the custom piece generator logic.
• Pieces.h contains the piece definitions and rotation logic.
• colortheme.h contains the color theme definitions for background.
• constatns.h contains the constants used in the game.
• Position.h contains the position class and the position logic.
• pieceColors.h contains the color theme definitions for pieces.
• Portal.h contains the portal class and the portal logic.
• Node.h, LinkedList.h,Vector.h, Stack.h and Queue.h contains the data structures used in the game.
• Logic.h contains the connection between the game logic and the game objects.
• app-main.cpp contains the main function.

Game Controls

• Left Arrow, A Key: Move the piece left.
• Right Arrow, D Key: Move the piece right.
• Down Arrow, S Key: Move the piece down.
• Up Arrow, W Key: Rotate the piece clockwise.
• Z,L Key: Drop the piece.
• H Key: Hold the piece.
• P Key: Pause the game.
• Escape Key: Exit the game.

Game Modes

• Medium: In this mode, you can enjoy the classic Tetris gameplay. However, there is an added twist with the portal feature, allowing you to teleport pieces to the opposite side of the board. Experience environmental effects, including a flash bank. Additionally, you have the advantage of previewing the next piece and using the hold piece.

• Hard: A faster-paced version compared to the medium mode, offering increased point potential. The game board is also smaller after each level up, providing an additional challenge.

• Deadly: The most challenging mode in the game. Here, you are limited to rotating pieces only twice. Unique color themes and music enhance the experience. The game board shrinks faster than in hard mode as you level up. Portals and environmental effects are much faster compared to the hard mode.

How to add a custom piece

In the custom piece window: By clicking the left mouse button, you can draw a custom piece. When you are finished, click the right mouse button to draw a new piece. After completing your custom pieces, press Enter to initiate the saving process for your pieces. And you can show your custom pieces in the game.

Attributions and Resources

Pictures

• Freepik

Fonts

• 212 Keyboard Font
• Pixelify Sans Font

Music

• Background Music
• Gameplay Music

Tools

• Visual Studio Code
• Xcode
• Typora
• SFML Library

Research

• Game Design Tutorial
• Makefile Tutorial
• SFML Sprite Tutorial
• SFML Forum Discussions
• SFML Music Tutorial

Programming Resources

• CSV File Management in C++
• String Formatting in C++
• Date and Time in C++
• 2D Array Manipulation
• Function Pointer Multiple Definition
• Removing All Occurrences of a Character in C++
• Tetris Game Development Tutorial

Tetris Design References

• OOTetris Design
• TerminalRoot Tetris Implementation
• Creately Tetris Game Design
• Tutorialspoint Date and Time in C++
• GeeksforGeeks CSV File Management