https://github.com/mechanicalflower/meloncrusade

:melon: A frogger-like 3D platformer game
https://github.com/mechanicalflower/meloncrusade

frogger-clone game gamedev godot godot-engine godot4

Last synced: 2 months ago
JSON representation

:melon: A frogger-like 3D platformer game

• Host: GitHub
• URL: https://github.com/mechanicalflower/meloncrusade
• Owner: MechanicalFlower
• License: mit
• Created: 2024-07-23T11:21:33.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-01T14:15:40.000Z (2 months ago)
• Last Synced: 2024-12-01T15:25:10.776Z (2 months ago)
• Topics: frogger-clone, game, gamedev, godot, godot-engine, godot4
• Language: GDScript
• Homepage:
• Size: 36.7 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



# 🍈 MelonCrusade

![Godot Badge](https://img.shields.io/badge/godot-4.3-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 [frogger](https://en.wikipedia.org/wiki/Frogger)-like 3D platformer game, made with [Godot Engine](https://godotengine.org/).







## About

Dodge traffic on a busy road, then cross a river by jumping on floating logs and climb a rock to reach the melon.

## 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 `MelonCrusade.exe`.

- **MacOS**: Double click on `MelonCrusade.app`.

- **Linux**: In a terminal, run `./MelonCrusade.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/MelonCrusade.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.