Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 2.98 KB

README.md

File metadata and controls

104 lines (74 loc) · 2.98 KB
Raw

So_Long

So_Long is a minimalistic 2D game developed as part of a project to learn the basics of game development and the use of the MinilibX library.

Table of Contents

Introduction

So_Long is a simple 2D game where the player navigates through a maze to collect items and reach an exit. The project is designed to provide hands-on experience with basic game mechanics and graphics programming using the MinilibX library.

Features

  • Classic 2D maze gameplay
  • Simple graphics using MinilibX
  • Item collection and scoring system
  • Exit to complete the level

Requirements

  • gcc (GNU Compiler Collection)
  • make
  • MinilibX library

Installation

  1. Clone the repository: 
    git clone https://github.com/yourusername/so_long.git

Navigate to the project directory:

bash

cd so_long

Compile the project:

bash

make

Usage

After compiling, run the game with:

bash

./so_long path_to_map_file

Replace path_to_map_file with the path to your game map file. Controls

W: Move up
A: Move left
S: Move down
D: Move right
ESC: Quit the game

Game Rules

Collect all items to unlock the exit.
Reach the exit to win the game.
Avoid obstacles and enemies (if any).

Screenshots

Contributing

Contributions are welcome! Please fork the repository and submit a pull request. License

This project is licensed under the MIT License. See the LICENSE file for details. Acknowledgements

The developers of MinilibX<img width="822" alt="Screen Shot 2024-06-15 at 6 01 35 AM" src="https://github.com/Sebrani-Aymane/so_long/assets/123418261/eef258bf-3e96-4f7e-8f46-4f485dc0f6f6">

The open-source community for providing numerous resources and tutorials

markdown

Explanation:

  • Introduction: A brief overview of what the project is and its purpose.
  • Features: A list of key features in the game.
  • Requirements: Necessary tools and libraries needed to run the project.
  • Installation: Step-by-step instructions on how to clone, navigate, and compile the project.
  • Usage: How to run the game, including command-line instructions.
  • Controls: The controls for playing the game.
  • Game Rules: Basic rules and objectives of the game.
  • Screenshots: A placeholder for a screenshot of the game.
  • Contributing: Information on how others can contribute to the project.
  • License: Licensing information.
  • Acknowledgements: Credits and thanks.

Feel free to customize this template to better suit the specifics of your "So_Long" project.

Screen Shot 2024-06-15 at 6 03 39 AM