joaorb64 / smashremix-plus-extra

# Extra content build system
- **NOTE: This is not an official update to "Smash Remix" This is only a tool to add fan content to the game. The patches we provide are a community effort of new content all in one patch.** 
- If you would like to download our newest patch, please go here: Latest Release
 - After you have downloaded our patch, you can use this patcher to create the rom. 
# How To Play
- If you are on MOBILE, you need an emulator that will properly run ROMs over 64MB. 
For Android, best emulator would be Mupen64Plus-AE NIGHTLY BUILD
- For PC (Windows, Linux) it's recommended to use RMG-K as this emulator supports online play AND rollback.
## Prerequisites For Building Your Own Build
- Windows: Python 3.12+, pipenv
 - pipenv gets installed automatically by build.bat - to install manually, run `python -m pip install pipenv` in a terminal
- Linux: Python 3.12+, pipenv, wine
## Setting Up Your Own Build
- Clone the repository using `git clone --recursive` (note the recursive here for it to clone the original smashremix repo as a submodule)
 - If you cloned the repo non-recursively, run `git submodule update --init --recursive` in the clone directory to initialize and update the smashremix submodule
 - If you don't have Git or downloaded this repository without it (i.e. Code -> Download ZIP), download the Smash Remix source manually and extract it's files into `smashremix`
 - Clone into a local drive location and not somewhere like OneDrive to avoid potential issues
- Copy your legal vanilla SSB64 ROM into `smashremix/roms/` as `ssb.rom`. If you have a `.z64`, just rename the extension
- Set up the Python environment: In your clone directory, run `python -m pipenv install` (automatically handled by build.bat)
## Building
**To build, simply run:**
- **Windows: `build.bat`**
 - Manual build: `python -m pipenv run character_appender.py && patch_extra.bat`
- **Linux:**
 - `pipenv run python3 character_appender.py && wine patch_extra.bat`
The build consists of two parts:
- Running `character_appender.py` which does all the magic and generates a `smashremix/roms/original_extra.z64`. This is an extension of the `/roms/original.z64` file with extra content. It also prepares the `src/` and `build/` directories
- Running `patch_extra.bat` which builds the final ROM just like Remix.
## Modding Resources
- Modding Wiki
- Moveset Editor
- Scripts for extracting characters/stages from ROM, fixing normals from Blender, projectile creation, etc. are included with +EXTRA's source.
- Templates for various assets are included with +EXTRA's source. 
## FAQ
- **"Where do I download this MOD?"** 
Head over to the 'Releases' section and download the latest version. 
- **"Is this a new Smash Remix update?"** 
This mod is NOT an official Smash Remix update, it builds off Remix, and adds cool stuff from the community! 
- **"What is the purpose of Smash Remix +EXTRA?"** 
We wanted to design a project that will allow users to add their own custom content on top of Sm