Jump Thingy Documentation

Introduction

Jump Thingy is a simple platformer game where you control a character that must jump between platforms while avoiding falling off the screen. It is a project developed in C using raylib as the graphics library.

Description

In Jump Thingy, your goal is to keep the player moving across platforms without falling into the kill zone. Platforms are generated randomly, and the player can move sideways and jump to avoid obstacles and keep progressing.

Features

• Random platform generation.
• Basic physics simulation (gravity and forces).
• Collision detection with platforms and screen edges.
• Smooth movement and intuitive controls.
• Uses raylib for graphics and input handling.

Requirements

To compile and run the game, you need:

• Operating System: Linux.
• Compiler: GCC or any C-compatible compiler.
• Libraries:
  • raylib (installed and linked).

Compilation

1. Clone this repository:

   git clone https://github.com/uwiwiow/jump-thingy.git
   cd jump-thingy

2. Compile the project using CMake:

   mkdir build
   cd build
   cmake ..
   make

3. Run the generated binary:

   ./jumpThingy

Online Documentation

You can access the documentation directly online via GitHub Pages: Jump Thingy Documentation

Local Documentation Generation

If you prefer to generate and view the documentation locally, follow these steps:

1. First, ensure you have Doxygen installed.
2. In the project root directory, where the docs folder is located, run the following command:

   doxygen docs/Doxyfile

3. The documentation will be generated in the docs/doxygen directory. Open the HTML files inside the docs/doxygen/html folder in your browser to view the documentation.

Controls

A: Move left.
D: Move right.
S: Reduce falling speed.
R: Restart the game.

Debug Mode

The game includes a Debug Mode to help with development and testing. You can enable or disable it by modifying the globals.h file.

• How to Enable Debug Mode:
  1. Open the includes/globals.h file.
  2. Set the DEBUG macro to 1 to enable debug mode, or 0 to disable it:

     #define DEBUG 1  // Enable Debug Mode

• Debug Features:
  • The positions of all platforms are displayed on the screen.
  • Pressing the C key resets the player's position without restarting the entire game.

Project Structure

    .
    ├── CMakeLists.txt        # Build configuration with CMake
    ├── docs
    │   ├── Doxyfile          # Documentation configuration with Doxygen
    │   ├── doxygen           # Documentation output
    ├── includes              # Header files
    └── src                   # Source files

How to Play

The goal is to avoid falling into the kill zone while jumping across platforms. Use A and D to move sideways, S to control your falling speed, and R to reset the game. Try to survive as long as possible!

License

This project is licensed under the MIT License. Feel free to use, modify, and share it.

Contributions

Contributions are welcome! If you find a bug or have a suggestion, open an issue or submit a pull request.

Contact

Developed by Uwiwiow.

GitHub | Mail