Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mechanicalflower/hazyroad

☁️ A puzzle game in a hazy forest
https://github.com/mechanicalflower/hazyroad

3d first-person game gamedev godot godot-engine godot4 lsdjam puzzle

Last synced: 2 months ago
JSON representation

☁️ A puzzle game in a hazy forest

Awesome Lists containing this project

README

        

# ☁️ HazyRoad

![Godot Badge](https://img.shields.io/badge/godot-4.2-blue?logo=Godot-Engine&logoColor=white)
![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative&logoColor=white)
![reuse](./.reuse/REUSE-compliant.svg)

A short puzzle game with a dark atmosphere, made with [Godot Engine](https://godotengine.org/).

Download on  Github
Download on  itch.io

## About

Ever had one of those days where even getting home feels like a puzzle? Well, that's exactly what happens in __Hazy Road__. You're cruising home, and bam! A barrier shows up out of nowhere, blocking your way. So, you do what any sane person would do – step out of your car and figure out how to get the heck out of this crossroads mess.

Explore and interact with object to figure out how to unblock your way at the crossroads.

### Controls

Keep it simple and straight:

- WASD: Movement
- Mouse: Look
- Shift: Sprint
- Space: Jump
- E/Left Click: Interact
- ESC: Pause Menu

### Screenshots

## Installation

### From a release

Released binaries are available
on the Github repository, in the release section.

Download the zip archive, accordingly to your OS, and unzip it.

- **Windows**: Double click on `HazyRoad.exe`.
- **MacOS**: Double click on `HazyRoad.app`.
- **Linux**: In a terminal, run `./HazyRoad.x86_64`.

### From source

> [!IMPORTANT]
> For this installation, you need to have
> the Godot Editor installed.

Clone the source locally:
```
git clone https://github.com/MechanicalFlower/HazyRoad.git
```

You need to install addons first:
```
godot --headless --script plug.gd install
```

And simply run the game as any Godot project:
```
godot
```

## Development

The project use:
- [`just`](https://just.systems/man/en/) as command runner,
- [`pre-commit`](https://pre-commit.com/) to run formatters, this requires [Python 3](https://docs.python.org/3/).

> [!IMPORTANT]
> Actually, `just` recipes only support Linux.

To check all available recipes, run:
```
just
```

To run formatters:
```
just fmt
```

To install, and run the game:
```
just install-addons
just godot
```

> [!TIP]
> In `just` recipes, the Godot Editor is installed
> automatically. This ensure that you
> use the right version of the engine.

## Contributing

![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)

We welcome community contributions to this project.

Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.

## Releasing

Please read our [Release Guide](RELEASING.md) for more information on how we manage our releases.