User:Pixloen/FPANModding: Difference between revisions

Latest revision as of 20:49, 9 June 2024

	Now, this is a surprise... This wiki is being rewritten from the ground up! If you're interested in helping, join the French Bread Modding Discord!

Welcome to the French Bread Modding Wiki! This wiki is meant to provide a comprehensive documentation of the engine used in modern French Bread games, as well as basic examples and tutorials.

Games covered include UNDER NIGHT IN-BIRTH II: Sys:Celes, UNDER NIGHT IN-BIRTH Exe:Late [cl-r], and MELTY BLOOD: TYPE LUMINA. Some minor information about Blazblue Cross Tag Battle and Dengeki Bunko Fighting Climax Ignition is included too!

Credits

pixloen - Lead writer, proofreader and formatter
_Bootysama - Proofreader and Known Gatekeeper
Blake - Writer on .pat and Audio sections

Contributors

NerfNoobPls - MBTL section in HA6 Pattern Reference

French Bread Modding Wiki
(FBModdingWiki)

Systems

Steam / PC Versions of Games Only

Community Channels

French Bread Modding Discord

UNICLR Color Vault

Melty Blood Server

MBTL Palette Gallery

Melty Blood Community Server

**Note**
The Under Night In-Birth Player Hub has a rule that bans discussion of modding any games. Don't go there expecting any help with mods!

For Beginners

File Formats & Software Guide

Engine Documentation

Guides & Tutorials

	Disclaimer: Better not die on me! This section of the wiki isn't ready yet. If you are knowledgeable enough in modding, please consider helping!

Navigation (old)

Modding French Bread Games
For Beginners	Getting Started File Structure Installing Mods Example Mods Glossary Links & Resources
File Formats & Software Guide	Hantei-chan CGTOOL & CGLIB .pat Effects Palettes DDS Images
Engine Documentation	Audio Backgrounds Classes and Methods Cutscenes D File Folder Functions Shaders

Old Navigation
Quick Start	Getting Started Installing Mods Mods List
Guides	Character File Setup Using Hantei-chan Character Scripts Miscellaneous Dialogue HUD and UI Stages Audio Battle Scripts CG & Patterns Editng Vectors Define
Documentation	Classes and Methods Functions HA6 Pattern Reference UNI2 Modding Notes

PIXL bg001.png

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:Modding French Bread Games}}
+{{Disclaimer MFPG
+|border-color=#FF60B0
+|bg-color=
+|image=UNI2_resources_icon.png
+|text='''Now, this is a surprise...'''<br/>This wiki is being rewritten from the ground up! If you're interested in helping, join the [https://discord.gg/RP2mN3YJps French Bread Modding Discord]!
+}}
+{{DISPLAYTITLE:French Bread Modding Wiki}}
+{{2 Column Flex|flex1=7|flex2=3|reverse=yes
+|content1=
+{{Content Box|content=
+<center><div style="max-width:686px;">[[File:PIXL banner.png|class=flex-image|link=]]</div></center>
+Welcome to the '''French Bread Modding Wiki'''! This wiki is meant to provide a comprehensive documentation of the engine used in modern French Bread games, as well as basic examples and tutorials.
-==Can we mod Under Night In-Birth II: [sys:celes]?==
+Games covered include '''UNDER NIGHT IN-BIRTH II: Sys:Celes''', '''UNDER NIGHT IN-BIRTH Exe:Late [cl-r]''', and '''MELTY BLOOD: TYPE LUMINA'''. Some minor information about '''Blazblue Cross Tag Battle''' and '''Dengeki Bunko Fighting Climax Ignition''' is included too!
-'''Status at the moment: Yes?'''
+==Credits==
-The game uses UNIST style compression; so everything is all set! UNIST Unpacker at the moment cannot extract files for UNI2. This can be partially fixed by modifying source and changing a single integer in the files(?). tbh just wait for u4 to update it lol
+*'''pixloen''' - Lead writer, proofreader and formatter
+*'''_Bootysama''' - Proofreader and Known Gatekeeper
+*'''Blake''' - Writer on .pat and Audio sections
-===Initial Notes===
+===Contributors===
-*d file hex editing is still required for '''basically every file'''
+*'''NerfNoobPls''' - MBTL section in HA6 Pattern Reference
-*character data is structured like lumina rather than uniclr
+}}
+|content2={{Infobox Game
-==Introduction==
+| gamename    = French Bread Modding Wiki
-<div style="max-width:800px;">[[File:PIXL_banner.png|class=flex-image|link=]]</div>
+| abbreviation = FBModdingWiki
-'''Welcome to the French Bread Modding Wiki! This wiki is meant to provide a comprehensive documentation of the engine used in modern French Bread games, as well as basic examples and tutorials.'''
+| image        = PIXL hyde.png
+| system      = Steam / PC Versions of Games Only
-The guides and tutorials here should be considered a way to successfully make mods, but not '''the correct way'''. The techniques and methods used are simply what the author (pixloen) uses, but for others there may be better routes to suite the types of mods that you want to make.
+| community    = [https://discord.gg/RP2mN3YJps French Bread Modding Discord]
+| community2    = [https://discord.gg/uPUtrySvYp UNICLR Color Vault]
-===Contents Covered===
+| community3  = [https://discord.gg/meltyblood Melty Blood Server]
+| community4  = [https://discord.gg/HDX7STnDyb MBTL Palette Gallery]
-'''Games covered here:'''
+| community5  = [https://discord.gg/melty-blood-community-server-851550129684086800 Melty Blood Community Server]
-*Under Night In-Birth Exe:late [cl-r]
+| extra        =
-*MELTY BLOOD: TYPE LUMINA
+{{!}} colspan="2" {{!}}<!--
+-->{{(!}} style="margin:auto;" cellpadding="1" cellspacing="0"
-'''Games Partially covered here'''
+{{!}}+ '''Note'''
-*Dengeki Bunko Fighting Climax
+{{!}}-
+{{!}} The Under Night In-Birth Player Hub has a rule that bans discussion of modding any games. Don't go there expecting any help with mods!
-'''Games not covered here:'''
+{{!}}
-*Under Night In-Birth Exe:late / Under Night In-Birth
+{{!)}}
-*Melty Blood Actress Again Current Code
+}}}}
+====<span class="invisible-header" style="font-size: 0em;">For Beginners</span>====
-=== Assumed Knowledge ===
+{{Content Box|header=For Beginners|content=
+<div style="margin-left: auto; margin-right: auto; display: flex; flex-direction: row; flex-wrap: wrap; justify-content: center; max-width:1500px; align-items: center;">
-*Basic understanding of navigating File Explorer
+{{PIXL FP Banner|image=started|name=Getting Started}}
-*Basic understanding of batch files
+{{PIXL FP Banner|image=files|name=File Structure}}
-*Basic understanding of programming
+{{PIXL FP Banner|image=install|name=Installing Mods}}
+{{PIXL FP Banner|image=list|name=Example Mods}}
-Note that French Bread uses Squirrel for most functions, but such code can be easily understood if you have JS, LUA, C and etc. experience. If others can do it, so can you!
+{{PIXL FP Banner|image=glossary|name=Glossary}}
+{{PIXL FP Banner|image=links|name=Links and Resources}}
-== Tools, Other Guides & Useful Resources ==
+</div>
+}}
-=== Game Rips ===
+====<span class="invisible-header" style="font-size: 0em;">File Formats & Software Guide</span>====
+{{Content Box|header=File Formats & Software Guide|content=
-*[https://drive.google.com/drive/folders/16Ez4O_Dw6cD-KvZRILkY4_EonKjUkeOv Melty Blood Type Lumina] (outdated)
+<div width="fit-content" style="display: flex; flex-direction: row; flex-wrap: wrap; justify-content: center;">
-*[https://drive.google.com/drive/folders/1iJDh5pXszLjDcGp9XUUW5YMuRh-0vm57?usp=sharing UNICLR] (incomplete) (Londrekia's sprites can be found here.)
+{{PIXL FP Bar|image=ha6|name=Hanteichan}}
+{{PIXL FP Bar|image=cg|name=CG}}
-*[https://www.spriters-resource.com/pc_computer/meltybloodtypelumina/ Lumina Spriters Resource]
+{{PIXL FP Bar|image=pat|name=Pat Effects}}
-*[https://www.justnopoint.com/lbends/index.php?location=sprites&gallery=unist UNIST sprites from JustNoPoint]
+{{PIXL FP Bar|image=pal|name=Palettes}}
+{{PIXL FP Bar|image=dds|name=DDS Images}}
-=== Basic Tools ===
-*Hantei-chan, a HA6 editor
-*CGlib, .cg extractor by u4ick
-*CGTool, .cg compiler by u4ick
-*[https://drive.google.com/drive/folders/15cGQmmbqk2wSmuX-oTkSfwuC818sn4wT?usp=sharing FPAN Modding Resources] all of the above
-*[https://github.com/DamienIsPoggers/Hantei-chan Hantei-chan with jonbin] (DamienIsPoggers, can convert to BlazBlue files, optional)
-*Notepad++. Other text editors may be fine, but Notepad++ gets the best results due to it's SHIFT-JIS encoder.
-*A hex editor. [https://mh-nexus.de/en/hxd/ HxD] is used commonly.
-*.pat editor / visualizer. None are public, but you can use HA6 + hex editor as a close enough replacement.
-*DDS decomp/compression tool. Found in the .pat cut-ins guide.
-=== Game Specific Injectors / Extractors ===
-'''MBTL'''
-*[https://github.com/Eiton/MBTL-Hitbox-Viewer MBTL Hitbox Viewer], injector
-*[https://github.com/Ekey/MBTL.BIN.Tool/releases MBTL BIN Tool], file extractor
-*[https://cdn.discordapp.com/attachments/891200226273161216/1113822492688142357/cache_5_31_23.zip Current Cache for the MBTL BIN Tool] as of 02/06/2023 courtesy of u4ick
-'''UNICLR'''
-*[https://github.com/ucuckic/unist-unpacker/releases/tag/3 UNIST Unpacker], file extractor
-'''UNI2'''
-*[https://drive.google.com/drive/folders/15cGQmmbqk2wSmuX-oTkSfwuC818sn4wT?usp=drive_link UNI2 Unist Unpacker] by u4, edited by pixloen (does not fully work atm)
-*[https://github.com/Ekey/UNIB.Data.Tool/tree/main UNIB Data Tool] actually designed for UNI2.
-=== Written Guides & Documentation ===
-*[https://docs.google.com/document/d/11hPfvxlvdkzkFEScYJzDKp2FsxCqpzWUOQ8bFQa3gxI/edit?usp=sharing .pat Image Editing Guide] by AyanamiRei0
-*[https://docs.google.com/document/d/1zjWYuGVWBbKd22YC_ZcIT6WuPbqjVaZ9pu96yng--6c/edit?usp=sharing Detailed .pat documentation] by Blake
-*[https://docs.google.com/document/d/1CsXdXQwz8rYQgO2W3XtGB0ycwJJxOXal9YooXfqd1nw/edit?usp=sharing MBTL Music Modding Guide] by Sera, Yvette & AyanamiRei0
-*[https://imgur.com/a/5GQ2JDO MBTL Unpacker Guide] by koenji
-*[https://docs.google.com/document/d/1YxiOS1V0VaWnvkn-LKABzEoMWTxDi1rJR4qCj_jzLAo/edit?usp=sharing UNICLR Music Modding Guide] by Sera
-*[https://docs.google.com/document/d/1Y8Xymash1fCR2h-2AQDQZcC7agqgKM7ujQW5q6GdDjQ/edit?usp=sharing UNICLR Old Palette Modding Guide] by Sera
-*[https://docs.google.com/document/d/1dKXJgNR5ndunL4TJ1JTCi7TQr5SVSx1plYed_OmQxMM/edit?usp=sharing UNI2 Palette Modding Guide] by Sera and Hikari
-For the following guide:
-If you aren't tech-literate, it's recommended NOT to use Symlinks.bat as it creates Symlinks which can only be removed through command-line.
-Preferably, using Copying.bat or copy the files yourself by following these steps:
-*Find _English/data/csel and grab your character's palette (e.g. Aka.pal)
-*Copy and paste/replace over the same file found in _English/data/Character_0 (Aka_0 in this example)
-[https://docs.google.com/document/d/1ypJMX0bqzKgMG06KMtoNimPLxOTG6Ifkrp8YB23E73A/edit?usp=sharing UNICLR Color Modding Guide] by Sera, AyanamiRei0
-*[https://www.reddit.com/r/meltyblood/comments/widwxl/tl_performance_sucking_on_pc_use_dgvoodoo/ DGVoodoo Setup for Lumina (works with UNI too) ] by u/SK91_NO
-== Where can I get help? ==
-(organised from most active to least active)
-*[https://discord.gg/meltyblood Melty Blood Server's #modding-tl]
-*[https://discord.gg/HDX7STnDyb MBTL Palette Gallery's Other Mods Category]
-*[https://discord.gg/uPUtrySvYp UNICLR Color Vault's #general 2]
-*[https://discord.gg/melty-blood-community-server-851550129684086800 Melty Blood Community Server's Type Lumina Modding thread (under #type-lumina)]
-*[https://www.reddit.com/r/UnderNightInBirth idk the under night reddit if you really must]
-Note: The community UNICLR server has a rule banning any discussion about modding due to French Bread (or just kamone)'s stance against it. While this makes the modding scene quite small, do respect the rule by not openly encouraging extensive mods of the game. (Pray that this rule gets lifted for UNI2. I'll make a bunch of QoL mods like subtitles and full 1440p support if it does.)
-== Navigation ==
+</div>
+}}
+====<span class="invisible-header" style="font-size: 0em;">Engine Documentation</span>====
+{{Content Box|header=Engine Documentation|content=
+<div width="fit-content" style="display: flex; flex-direction: row; flex-wrap: wrap; justify-content: center;">
+{{PIXL FP Bar|image=audio|name=Audio}}
+{{PIXL FP Bar|image=bg|name=Backgrounds}}
+{{PIXL FP Bar|image=class|name=Classes and Methods}}
+{{PIXL FP Bar|image=cutsc|name=Cutscenes}}
+{{PIXL FP Bar|image=dfile|name=D File}}
+{{PIXL FP Bar|image=func|name=Functions}}
+</div>
+}}
+====<span class="invisible-header" style="font-size: 0em;">Guides & Tutorials</span>====
+{{Content Box|header=Guides & Tutorials|content=
+<div width="fit-content" style="display: flex; flex-direction: row; flex-wrap: wrap; justify-content: center;">
+{{Disclaimer MFPG
+|border-color=#FF1060
+|bg-color=
+|image=PIXL hyde.png
+|text='''Disclaimer: Better not die on me!'''<br/>This section of the wiki isn't ready yet. If you are knowledgeable enough in modding, please consider helping!
+}}
+</div>
+}}
+==Navigation (old)==
 {{Navbox-MFPG}}
-[[Category:Modding French Bread Games]]
+[[Category: Modding French Bread Games]]
-== Credits ==
-=== Members ===
-*'''pixloen''' - lead writer, template creator, custom asset maker etc etc
-*'''Blake / Blakieboo''' - music and pat information writer
-*'''Bootysama''' - provided many of the assets that i used to study the engine and gave me useful advice or tips and might have written one or two things (general information checker too)
-<!-- Contributed to the wiki? Feel free to add yourself in this section! -->
-=== Contributors ===
-*'''NerfNoobPls''' - MBTL section in HA6 Pattern Reference
-=== Special Thanks ===
+<templatestyles src="Pixl/frontpage.css"/>
-*'''Rion / u4ick''' - made basically all of the tools and programs and started the modding scene in general
+<div style="position: fixed; bottom: 0; left: 0; z-index:-1;display:flex; width:100%;">
-*'''Melty Blood Discord''' - helped me mess around with .cg editing to port a singular satsuki sprite, starting my interest in modding french bread games, resulting in this mess of a wiki you're reading now
+[[File:PIXL bg001.png|10000px|class=image|link=]]
+</div>