Super Mario Land — Recomp

A modern recompilation project for **Super Mario Land**, originally released for the Nintendo Game Boy.

## ROM Required

This project **does not include the original game ROM or copyrighted Nintendo assets**.

To play, you must provide your **own legally obtained ROM copy** of *Super Mario Land*. The recompilation uses the user's supplied ROM as the source material.

## Features

* Game Boy recompilation
* Requires the user's own ROM file
* No copyrighted ROM files are distributed with this project
* No original Nintendo game assets are included with the project
* Full-screen support
* Press **Alt + Enter** to toggle full-screen mode
* Designed for modern systems

## Controls

| Keyboard Key   | Game Boy Button  |
| -------------- | ---------------- |
| **X**          | A                |
| **Z**          | B                |
| **Enter**      | Start            |
| **Arrow Keys** | D-Pad / Movement |

## Nintendo Switch 2

If technically feasible, compatibility/support for the **Nintendo Switch 2** version or release of *Super Mario Land* may be considered where applicable.

This project is **not affiliated with, endorsed by, or sponsored by Nintendo**.

# Contributing

Contributions and improvements are welcome!

## Getting Started

1. Fork this repository on GitHub.
2. Clone your fork to your computer.
3. Follow the build instructions in `README.md`.
4. Provide any required game ROM or other input files yourself.
5. Build the project locally.
6. Make your changes.
7. Test your changes thoroughly.
8. Commit and push your changes to your fork.
9. Open a Pull Request against the main repository.

## What You Can Contribute

Examples of useful contributions include:

* Bug fixes
* Performance improvements
* Controller improvements
* Fullscreen improvements
* Platform compatibility
* Linux compatibility
* Steam Deck compatibility
* Build-system improvements
* Documentation
* Accessibility improvements
* New configuration options
* Other improvements that do not distribute copyrighted game material

## ROM and Copyrighted Assets

**Do not submit copyrighted game ROMs, proprietary Nintendo assets, or other copyrighted material that you do not have permission to redistribute.**

Contributors must provide their own legally obtained ROM when required for building or testing.

Do not include ROM files in Pull Requests.

## Pull Requests

Before submitting a Pull Request:

* Make sure the project builds successfully.
* Test your changes.
* Explain what you changed.
* Explain how you tested the changes.
* Keep Pull Requests focused on a specific improvement or bug fix.

Pull Requests may be reviewed before being merged into the main repository.

## Issues

If you find a bug, please open an Issue and provide:

* Operating system
* Hardware/platform
* Project version or commit
* Steps to reproduce the problem
* Expected behavior
* Actual behavior
* Relevant error messages or logs

Please do not upload or attach copyrighted ROM files to Issues.

## Code of Conduct

Please be respectful to other contributors. Constructive criticism, technical discussion, and collaboration are encouraged.

Thank you for helping improve the project!

## Building From Source

This repository contains the source code required to build the recompilation.

### Requirements

* Git
* CMake
* A supported C/C++ compiler
* Any additional dependencies listed below
* Your own legally obtained ROM, if required by the build process

### Clone the Repository

```bash
git clone https://github.com/YOUR-USERNAME/PROJECT-NAME.git
cd PROJECT-NAME
```

### Configure the Build

```bash
cmake -S . -B build
```

### Build

```bash
cmake --build build --config Release
```

The resulting executable will be placed in the project's build output directory.

### ROM Requirement

The original game ROM is **not included in this repository**.

You must provide your own legally obtained ROM if the project requires it for building or runtime operation.

ROM files should **not** be committed to GitHub.

### Contributing

If you want to improve the project, fork the repository, make your changes, test them, and submit a Pull Request.

See [`CONTRIBUTING.md`](CONTRIBUTING.md) for contribution guidelines.


## Copyright

*Super Mario Land* and its associated characters, names, trademarks, artwork, music, and other intellectual property are the property of their respective copyright and trademark holders, including **Nintendo**.

This is an independent fan-made recompilation. No Nintendo ROM files or copyrighted game assets are distributed with this project.

**Nintendo retains all rights to the original game and its intellectual property.**

Users are responsible for obtaining and using ROM files in accordance with the laws applicable to them.