Getting Started (v1.7)

Heavily adapted from @Joris

Note: This is a guide on actually opening the game in the Unity editor, no actual modding will be done just yet. This guide will also assume that you're using Windows. If you're using Linux, chances are you already know how to do all this.

You will need:

• Git, available here, use the installer.
• Unity Hub, available here
• Unity Editor, 2022.1.12f1 or newer. Available through the Unity Hub's "Installs" tab (on the left).
• Optional: GitHub Desktop, available here.

Cloning the project

1. (Optional) Fork the repository on GitHub. This will create a "fork", which is a separate copy of MvLO on your GitHub account. You can commit/push (save) to this fork, but you can't commit/push to the official repository.

2. Download a local copy of the project (through Git)

   • If you installed GitHub Desktop:
     1. Open GitHub Desktop and make a local clone of the project with File > Clone Repository.
   • If you did not install GitHub Desktop:
     1. Open File Explorer and navigate to the folder you want the project to be within.
     2. Right-click the folder you want the project to be within, and click "Open in Terminal" from the context menu.
     3. Type git clone https://github.com/<YourUsernameHere>/NSMB-MarioVsLuigi.git into the terminal if you created a fork, or git clone https://github.com/ipodtouch0218/NSMB-MarioVsLuigi.git if you did not create a fork.
     4. Allow the project to download, it might take a while.

3. Opening in Unity Hub: Open Unity Hub, click "Add" > "Add project from disk", then select the folder you cloned the repository into.

4. Open the MainMenu scene: Inside the Assets folder in the bottom center of your screen, double click to open the "Scenes" folder, and then double click to open the "MainMenu" scene. This should bring up the main menu of the game. From here, try running the game by clicking the play button (looks like ►) at the top center of your screen.

---

Troubleshooting

If you get an error stating:

"No 'git' executable was found. Please install Git on your system and restart Unity"

this means that you did not install Git properly, or you installed Git while Unity Hub was still open.

• Try restarting Unity Hub by right-clicking its taskbar icon (click on the ^ in the bottom right, find the white Unity logo, right-click that, click "Quit Unity Hub"), and then reopening Unity Hub.
• Reinstall Git, available here, make sure to use the installer. Make sure that any option that mentions "PATH" or "environment variables" are CHECKED.