# Use and adapt mario-platformer-fan-project

Use the documented interfaces and source layout for **mario-platformer-fan-project**. The sections below retain the README’s examples and configuration details.

## Project status

This is an active prototype and a complete playable slice. It is a fan-made project and is not affiliated with or endorsed by Nintendo. The repository is intended for development and experimentation rather than commercial release.

## Features

- Responsive keyboard and gamepad movement with sprinting and variable-height jumps
- Coins, question blocks, growth and fire power-ups, fireballs, and temporary invulnerability stars
- Walkers, faster turtles, player-seeking hunters, and pop-up plant enemies
- Checkpoint restoration, score and fastest-time records, pause, victory, and death screens
- A daytime meadow that transitions through a pipe into a moonlit castle section
- Landscape mobile controls for Android and iOS, including simultaneous touch input
- Separate music and sound effects for the game worlds and interactions

## Run locally

1. Install [Godot 4.7](https://godotengine.org/download/) or newer.
2. Clone this repository and open `project.godot` in Godot.
3. Press **F6** or **F5** to run the game.

### Controls

| Action | Keyboard | Gamepad |
| --- | --- | --- |
| Move | **A/D** or arrow keys | Left stick or D-pad |
| Jump | **Space** | South button |
| Sprint | **Shift** or **X** | West button |
| Fire | **F** or **C** after collecting a flower | East button |
| Enter pipe | **S** or Down | D-pad down |
| Pause | **Escape** | Start |

On mobile, the game automatically provides left, right, down, run, fire, jump, and pause buttons in landscape mode.

## Troubleshoot a local change

1. Reproduce the smallest example from the [quick-start guide](/docs/up-to-code-mario-platformer-fan-project/quick-start-guide).
2. Compare required configuration and dependency versions with the README.
3. Check the linked issue tracker for the same error. Include the command, runtime version, and relevant error when reporting a problem; omit credentials.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/mario-platformer-fan-project)
- [Original README](https://github.com/Up-to-code/mario-platformer-fan-project/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/mario-platformer-fan-project/issues)