No edit summary |
Pk-chiptune (talk | contribs) |
||
(11 intermediate revisions by one other user not shown) | |||
Line 7: | Line 7: | ||
=== Quick Start === | === Quick Start === | ||
Download BepInEx from Gamebanana [https://gamebanana.com/tools/15310 here]. | |||
Extract the .zip file. Drag and drop everything from this extracted folder, and place it into the root folder for NASB2. Then run the game once for BepInEx to generate the necessary files. | |||
Most mods you download will be .dll files. You'll place them inside the "plugins" folder, which is inside the Bepinex folder. | |||
Steam -> steamapps -> common -> Nickelodeon All-Star Brawl 2 -> BepInEx -> plugins -> (place your mods here). | |||
---- | ---- | ||
Line 15: | Line 19: | ||
=== Skin Mods === | === Skin Mods === | ||
Manual Installation: | |||
# PLACEHOLDER INSTALL GUIDE | |||
DOWNLOAD LINK PLACEHOLDER | |||
Usage: | Usage: | ||
PLACEHOLDER | # PLACEHOLDER | ||
==== Popular Skins Repositories: ==== | ==== Popular Skins Repositories: ==== | ||
* PLACEHOLDER | * PLACEHOLDER | ||
* PLACEHOLDER | * PLACEHOLDER | ||
Line 33: | Line 41: | ||
---- | |||
=== Music Mods === | |||
Manual Installation: | |||
---- | # Download the [https://github.com/megalon/nasb2-custom-music-mod/releases/latest latest release zip] such as '''''NASB2CustomMusicMod-9.9.9.zip''''' | ||
# Extract this zip into your [[#Necessary_files|BepInEx]] folder, and the mod should be installed! | |||
## Your BepInEx folder should now have a '''''CustomSongs''''' folder, and you should have the '''''plugins''''' in your plugins folder | |||
[https://github.com/megalon/nasb2-custom-music-mod NASB2 Custom Music Mod GitHub page] | |||
Usage: | Usage: | ||
# Your BepInEx folder should have a CustomSongs folder | |||
# Place '''''.wav''''', '''''.ogg''''', or '''''.mp3''''' files into the CustomSongs folder corresponding to the stage or menu you want to change. | |||
## For example, if you want to use a different song for the Jellyfish Fields stage, place the audio file in '''''BepInEx\CustomSongs\Stages\Jellyfish Fields\''''' | |||
## If multiple audio files are in the same folder, one is randomly selected each time that stage / menu / victory theme is loaded! | |||
Line 55: | Line 67: | ||
---- | |||
=== Voice Mods === | |||
Manual Installation: | |||
# PLACEHOLDER INSTALL GUIDE | |||
DOWNLOAD LINK PLACEHOLDER | |||
Usage: | Usage: | ||
PLACEHOLDER | # PLACEHOLDER | ||
Line 77: | Line 88: | ||
---- | |||
=== Other Helpful Mods === | === Other Helpful Mods === | ||
Line 91: | Line 96: | ||
! Name !! Info | ! Name !! Info | ||
|- | |- | ||
| [https://pixeldrain.com/u/1iFmWjZX Training Mode | | [https://pixeldrain.com/u/1iFmWjZX Training Mode v1.3 Update (Sanji)] || CPU blocking mode, 2 players in training mode (if you want it), advanced HUD shows frame data for both characters, better frame counter. | ||
|- | |- | ||
| [https://pixeldrain.com/u/c8yHZR3u Direct Steam Links (Sanji)] || Create links that will directly launch NASB2 and join your lobby! This is the fastest way to get someone to join your game. To use this mod, just tap the Invite Friends button in the Lobby. A link will be automatically copied to your clipboard. | | [https://pixeldrain.com/u/c8yHZR3u Direct Steam Links (Sanji)] || Create links that will directly launch NASB2 and join your lobby! This is the fastest way to get someone to join your game. To use this mod, just tap the Invite Friends button in the Lobby. A link will be automatically copied to your clipboard. | ||
|- | |- | ||
| [https://pixeldrain.com/u/P4hYwx6Y Rotation Mode | | [https://pixeldrain.com/u/P4hYwx6Y Rotation Mode v11/25 Update (Sanji)] || 3 or more people all enter one game but play 1v1 with 2 stocks. When someone runs out of stocks, the next player in the queue instantly spawns into the game and playing continues! The "winner" gets their health and stocks restored. To activate this mod, make a game in Timed mode with at least 3 people in a lobby (not spectating, act like it's a FFA with everyone playing). Everyone playing needs to have the mod. | ||
|- | |- | ||
| [https://pixeldrain.com/u/suEGsGqa Unlock West (Sanji)] || Adds a new server option to the left of Best. The USA option to the right of Best will be US East. The USA options to the left is US West. Note: Password lobbies will not work on US West when someone without the mod tries it but it should work if both people have the mod. | | [https://pixeldrain.com/u/suEGsGqa Unlock West (Sanji)] || Adds a new server option to the left of Best. The USA option to the right of Best will be US East. The USA options to the left is US West. Note: Password lobbies will not work on US West when someone without the mod tries it but it should work if both people have the mod. | ||
|} | |} | ||
---- | ---- | ||
=== Necessary files === | === Necessary files === | ||
These files are required by most mods | These files are required by most mods. | ||
* [https://gamebanana.com/dl/1084830 BepInEx]: | |||
* | # Extract the .zip contents into your NASB2 root directory. | ||
## This directory should be located at '''''C:\Program Files (x86)\Steam\steamapps\common\Nickelodeon All-Star Brawl 2\'''''. | |||
## Please note there may be an outdated '''''NASB2TrainingMode.dll''''' in the '''''BepInEx\plugins\''''' folder that should be deleted. | |||
Line 153: | Line 148: | ||
PLACEHOLDER GUIDE ON MODEL SWAPS | PLACEHOLDER GUIDE ON MODEL SWAPS | ||
---- | ---- | ||
=== Custom Music Creation === | === Custom Music Creation === | ||
For FAQs and in-depth information about using the NASB2 Custom Music Mod, please visit the [https://github.com/megalon/nasb2-custom-music-mod NASB2 Custom Music Mod GitHub page]. | |||
==== Custom Loop Points ==== | ==== Making Custom Loop Points ==== | ||
# To define a loop start and end point, create a JSON file in the same folder as your audio file, and give it the same name as your audio file. | |||
# A JSON file is just a regular text file, but instead of '''''.txt''''' it is '''''.json'''''. | |||
## You may need to turn on file extensions on Windows to be able to see and edit the .json extension. | |||
'''JSON file contents:''' | |||
Samples are more precise than seconds, but the NASB1 version of this mod used seconds, so this mod allows both for backwards compatibility. | |||
'''''Using samples:''''' | |||
<pre> | |||
{ | |||
"loopPoints": { "start": 199665, "end": 21977555 } | |||
} | |||
</pre> | |||
When '''''21,977,555''''' samples have elapsed in the song, it will loop back to '''''199,665''''' samples! | |||
'''''Using Seconds:''''' | |||
<pre> | |||
{ | |||
"loopStartPointSec": "4.462", | |||
"loopEndPointSec": "49.803" | |||
} | |||
</pre> | |||
When '''''49.803''''' seconds have elapsed in the song, it will loop back to '''''4.462''''' seconds! | |||
==== Making Song Packs ==== | |||
A Song Pack is a more efficient way to reuse songs across multiple stages / menus / victory themes! | |||
Song Packs should be placed in the folder '''''BepInEx\CustomSongs\_Song Packs\''''' | |||
# Navigate into the '''''BepInEx\CustomSongs\_Song Packs\''''' folder. | |||
# Duplicate the '''''_Template''''' folder, and rename it. Something like '''''Absolute Jammers'''''. | |||
# Place all of the songs you want to use in this song pack into the '''''Absolute Jammers\_Music Bank''''' folder. | |||
# Open the text file for the menu / stage / victory theme you want to add music to. For example, the main menu is Absolute '''''Jammers\Menus\MainMenu.txt'''''. | |||
# In this text file, enter a list of song file names from the '''''_Music Bank''''' folder that you want to play on this menu / stage / victory theme. The order doesn't matter, but you must put each song on it's own line! | |||
---- | ---- | ||
=== Custom Voice Pack Creation === | === Custom Voice Pack Creation === | ||
PLACEHOLDER GUIDE ON CREATING VOICES FOR THE MOD | PLACEHOLDER GUIDE ON CREATING VOICES FOR THE MOD | ||
---- | ---- | ||
=== Other Creation Tools === | === Other Creation Tools === |
Latest revision as of 14:15, 7 November 2024
Nickelodeon All-Star Brawl 2 is created in Unity, which makes it a particularly good target for modding. This page aims to serve as a public repository of knowledge for new and experienced modders alike.
Installing Mods
Quick Start
Download BepInEx from Gamebanana here.
Extract the .zip file. Drag and drop everything from this extracted folder, and place it into the root folder for NASB2. Then run the game once for BepInEx to generate the necessary files.
Most mods you download will be .dll files. You'll place them inside the "plugins" folder, which is inside the Bepinex folder.
Steam -> steamapps -> common -> Nickelodeon All-Star Brawl 2 -> BepInEx -> plugins -> (place your mods here).
Skin Mods
Manual Installation:
- PLACEHOLDER INSTALL GUIDE
DOWNLOAD LINK PLACEHOLDER
Usage:
- PLACEHOLDER
Popular Skins Repositories:
- PLACEHOLDER
- PLACEHOLDER
Music Mods
Manual Installation:
- Download the latest release zip such as NASB2CustomMusicMod-9.9.9.zip
- Extract this zip into your BepInEx folder, and the mod should be installed!
- Your BepInEx folder should now have a CustomSongs folder, and you should have the plugins in your plugins folder
NASB2 Custom Music Mod GitHub page
Usage:
- Your BepInEx folder should have a CustomSongs folder
- Place .wav, .ogg, or .mp3 files into the CustomSongs folder corresponding to the stage or menu you want to change.
- For example, if you want to use a different song for the Jellyfish Fields stage, place the audio file in BepInEx\CustomSongs\Stages\Jellyfish Fields\
- If multiple audio files are in the same folder, one is randomly selected each time that stage / menu / victory theme is loaded!
Voice Mods
Manual Installation:
- PLACEHOLDER INSTALL GUIDE
DOWNLOAD LINK PLACEHOLDER
Usage:
- PLACEHOLDER
Other Helpful Mods
Name | Info |
---|---|
Training Mode v1.3 Update (Sanji) | CPU blocking mode, 2 players in training mode (if you want it), advanced HUD shows frame data for both characters, better frame counter. |
Direct Steam Links (Sanji) | Create links that will directly launch NASB2 and join your lobby! This is the fastest way to get someone to join your game. To use this mod, just tap the Invite Friends button in the Lobby. A link will be automatically copied to your clipboard. |
Rotation Mode v11/25 Update (Sanji) | 3 or more people all enter one game but play 1v1 with 2 stocks. When someone runs out of stocks, the next player in the queue instantly spawns into the game and playing continues! The "winner" gets their health and stocks restored. To activate this mod, make a game in Timed mode with at least 3 people in a lobby (not spectating, act like it's a FFA with everyone playing). Everyone playing needs to have the mod. |
Unlock West (Sanji) | Adds a new server option to the left of Best. The USA option to the right of Best will be US East. The USA options to the left is US West. Note: Password lobbies will not work on US West when someone without the mod tries it but it should work if both people have the mod. |
Necessary files
These files are required by most mods.
- Extract the .zip contents into your NASB2 root directory.
- This directory should be located at C:\Program Files (x86)\Steam\steamapps\common\Nickelodeon All-Star Brawl 2\.
- Please note there may be an outdated NASB2TrainingMode.dll in the BepInEx\plugins\ folder that should be deleted.
Creating Mods
Skin Creation
PLACEHOLDER GUIDE ON GETTING STARTED WITH SKIN CREATION WITH THE GENERAL TOOLS NECESSARY
Textures
PLACEHOLDER GUIDE ON SIMPLE SKINS SUCH AS BASIC COLOR ALTS
Advanced Textures
PLACEHOLDER GUIDE GOING MORE IN DEPTH FOR TECHNICALLY UNNECESSARY STEPS BUT WOULD MAKE SKINS LOOK BETTER
Models
PLACEHOLDER GUIDE ON EDITING MODELS
Model Swaps
PLACEHOLDER GUIDE ON MODEL SWAPS
Custom Music Creation
For FAQs and in-depth information about using the NASB2 Custom Music Mod, please visit the NASB2 Custom Music Mod GitHub page.
Making Custom Loop Points
- To define a loop start and end point, create a JSON file in the same folder as your audio file, and give it the same name as your audio file.
- A JSON file is just a regular text file, but instead of .txt it is .json.
- You may need to turn on file extensions on Windows to be able to see and edit the .json extension.
JSON file contents:
Samples are more precise than seconds, but the NASB1 version of this mod used seconds, so this mod allows both for backwards compatibility.
Using samples:
{ "loopPoints": { "start": 199665, "end": 21977555 } }
When 21,977,555 samples have elapsed in the song, it will loop back to 199,665 samples!
Using Seconds:
{ "loopStartPointSec": "4.462", "loopEndPointSec": "49.803" }
When 49.803 seconds have elapsed in the song, it will loop back to 4.462 seconds!
Making Song Packs
A Song Pack is a more efficient way to reuse songs across multiple stages / menus / victory themes!
Song Packs should be placed in the folder BepInEx\CustomSongs\_Song Packs\
- Navigate into the BepInEx\CustomSongs\_Song Packs\ folder.
- Duplicate the _Template folder, and rename it. Something like Absolute Jammers.
- Place all of the songs you want to use in this song pack into the Absolute Jammers\_Music Bank folder.
- Open the text file for the menu / stage / victory theme you want to add music to. For example, the main menu is Absolute Jammers\Menus\MainMenu.txt.
- In this text file, enter a list of song file names from the _Music Bank folder that you want to play on this menu / stage / victory theme. The order doesn't matter, but you must put each song on it's own line!
Custom Voice Pack Creation
PLACEHOLDER GUIDE ON CREATING VOICES FOR THE MOD
Other Creation Tools
Name | Category | Platforms | Notes |
---|---|---|---|
PLACEHOLDER HYPERLINK | CATEGORY | PLATFORM | NOTE |
PLACEHOLDER HYPERLINK | CATEGORY | PLATFORM | NOTE |
PLACEHOLDER HYPERLINK | CATEGORY | PLATFORM | NOTE |
PLACEHOLDER HYPERLINK | CATEGORY | PLATFORM | NOTE |
PLACEHOLDER HYPERLINK | CATEGORY | PLATFORM | NOTE |
PLACEHOLDER HYPERLINK | CATEGORY | PLATFORM | NOTE |
External Modding Resources
- #modding Channel on the Official Nick Brawl Discord
- #modding Channel on the Nick Brawl Grinders Discord