Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benjimixvidz/suicube

A Tetris-like puzzle game developed with Godot Engine. Stack falling blocks, complete lines, and challenge yourself with classic tetromino gameplay.
https://github.com/benjimixvidz/suicube

arcade-game game-development gamedev gdscript godot-engine open-source puzzle-game tetris

Last synced: 27 days ago
JSON representation

A Tetris-like puzzle game developed with Godot Engine. Stack falling blocks, complete lines, and challenge yourself with classic tetromino gameplay.

Awesome Lists containing this project

README

        

# Suicube

*A Tetris clone developed with the Godot Engine*

![DALLยทE 2024-10-23 10 12 19 - Create a retro pixel art game cover for a game called 'Suicube' The cover should depict a Tetris-like scene with pieces stacking, small details like ](https://github.com/user-attachments/assets/8ae80e09-2d3b-40b6-bc27-d2752c4380de)

## ๐Ÿ“‹ Table of Contents
- [Introduction](#-introduction)
- [Screenshots](#-screenshots)
- [Features](#-features)
- [Requirements](#-requirements)
- [Installation](#-installation)
- [How to Play](#-how-to-play)
- [Controls](#-controls)
- [Contributing](#-contributing)
- [License](#-license)
- [Acknowledgments](#-acknowledgments)

## ๐Ÿ“– Introduction

**Suicube** is a puzzle game inspired by the classic **Tetris**, developed using the open-source Godot Engine. This project was created to learn game development with Godot and to practice using Git and GitHub for version control.

## ๐Ÿ“ท Screenshots

Soon

## ๐Ÿš€ Features

- ๐ŸŽฎ Classic Tetris gameplay with intuitive controls
- ๐Ÿ”„ Piece rotation and collision detection
- ๐Ÿ† Scoring system with points for completed lines
- ๐ŸŽฏ Game Over screen with options to replay or quit
- โธ๏ธ Game pause functionality
- ๐Ÿ–ฅ๏ธ Simple and clear user interface

## ๐Ÿ“ฆ Requirements

- **Godot Engine 4.x**: Download from the [official Godot website](https://godotengine.org)
- **Git**: Ensure Git is installed on your system. Download from the [official Git website](https://git-scm.com)

## ๐Ÿ’พ Installation

1. **Clone the GitHub repository**
```bash
git clone https://github.com/your_username/suicube.git
```
Replace `your_username` with your GitHub username.

2. **Open the project in Godot**
- Launch Godot Engine
- Click on "Import"
- Navigate to the folder where you cloned the repository
- Select the `project.godot` file and click on "Import & Edit"

3. **Run the game**
- In the Godot editor, click the "Play" button or press `F5`

## ๐ŸŽฎ How to Play

The objective is to manipulate falling pieces to form complete horizontal lines without letting the stack reach the top of the grid. Each completed line awards points. The game ends when new pieces can no longer be placed.

## ๐Ÿ•น๏ธ Controls

| Action | Key |
|--------|-----|
| Move Left | Left Arrow (โ†) |
| Move Right | Right Arrow (โ†’) |
| Rotate | Up Arrow (โ†‘) |
| Soft Drop | Down Arrow (โ†“) |
| Hard Drop | Space |
| Pause / Resume | P |
| Restart | R |

## ๐Ÿค Contributing

Contributions are welcome! To improve the game or add new features, follow these steps:

1. **Fork the repository**
- Click the "Fork" button at the top of the repository page

2. **Clone your fork**
```bash
git clone https://github.com/your_username/suicube.git
```

3. **Create a branch for your feature**
```bash
git checkout -b your_branch_name
```

4. **Make your changes**

5. **Commit your changes**
```bash
git add .
git commit -m "Description of your changes"
```

6. **Push to your fork**
```bash
git push origin your_branch_name
```

7. **Create a Pull Request**
- Go to the original repository
- Click "New Pull Request"
- Fill out the form describing your changes

If you encounter any issues or have questions, feel free to open an Issue on GitHub.

## ๐Ÿ“„ License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## ๐Ÿ‘ Acknowledgments

- The Godot Engine team for their fantastic game engine
- The open-source community for their continuous support
- All contributors who participated in this project