shenmue-mods / shenmuedksharp

Shenmue I & II HD Modding SDK for C#

Shenmue Modding Knowledgebase

Creating, collecting & preserving knowledge of modding & hacking Shenmue games.

---

Contents

• Shenmue I
• Shenmue II
• Shenmue II (Xbox)
• What's Shenmue
• Dreamcast Information
• Miscellaneous
• Links

Shenmue I

• 1ST_READ.BIN Interface Content
• 1ST_READ Text/Pointer modifications
• Analysis of a simple MAPINFO
• Artificial Intelligence System
• Beta Debug Flags
• COLI Data Visualization
• Change Loaded Area When Leaving Tomato Convenience Store
• Change Title Screen's Debug Menu Data
• Changing Fighting Style
• Character Swapping Tutorial
• Characters Names/IDs/Models
• Fusing Maps Together
• Increase the size of the Loading Screen area names
• Load Model In Area 0000
• Make Beta Areas Playable
• Map Names/IDs
• Notebook Hacking
• Remove Collision Data From Maps without COLI in MAPINFO
• Remove/Swap Area Collision Data
• Remove Warp Zone from Tomato Convenience Store
• Shenmue Patch Code Guide
• Vending Machine Swapping
• WAV to STR

Shenmue II

• Character Database
• Character Database per Filenames
• Hack Into QTE Cutscenes To Explore Them In Game
• How to Play Any Music Track in the Title Screen
• Map Names + IDs
• Notebook Editing
• Remove Collision Data

Shenmue II (Xbox)

• Shenmue IIx NTSC Retail CheckSums
• Shenmue IIx PAL Retail Checksums

What's Shenmue

• 1ST_READ Text quirks
• Animations in MOTION.BIN
• MOTION.BIN File Structure
• Notebook Hacking
• Triggering Alternative Animations for Ryo

---

Contribute

Contributions are most welcome, please adhere to the contribution guidelines.

⬆ back to top

shenmuedksharp's Issues

OBJ Reader

For basic model editing a wavefront OBJ reader is needed.

MT7 UV mirrored

Some the models have mirrored UVs which get not read out correctly yet.

Models:

• 5GASALNI.MT7 (the face texture is mirrored)

DDS writing support

For creating PVR texture files DDS would be recommended for performance reasons so we need DDS writing support.

Extension finder for container files

Currently the extension finder is not being used in the container files.

DDS ImageClass is broken

DDS class fails to deliver propper images.

Simple Code example (read dds and write as new file):

DDS oldImage = new DDS(fileNode.FullPath);
oldImage.Write(fileNode.RootPath + "\\Dummy\\" + fileNode.RelativPath);

will deliver binary incompatible output, that is unreadable by dds tools.

Same problem with custom BaseImage object creation (read png into baseclass, convert and write to dds format):

object baseimage = Activator.CreateInstance(typeof(PNG), new object[] {  AppDomain.CurrentDomain.BaseDirectory + "Dummy\\test.png" });
BaseImage entry = (BaseImage)baseimage;
DDS image= new DDS(entry);
image.FormatDetails = new DDSFormats.DDSFormatDetails(image.FormatDetails.Format);
image.AlphaSettings = image.AlphaSettings;
image.MipHandling = image.MipHandling;
image.HasTransparency = image.HasTransparency;
image.Write(fileNode.RootPath + "\\Dummy\\" + fileNode.RelativPath);

Microsoft DDS analyse tool (texdiag.exe) fails also to analyse the created dds files:

texdiag.exe analyze test.DDS
Microsoft (R) DirectX Texture Diagnostic Tool
Copyright (C) Microsoft Corp. All rights reserved.

test.DDS FAILED (80070032)

Input file is in this case a 32bit-A8R8G8B8" DDS file (32kb + header)
returned file is much smaller (6kb + header, compression?)
Same also happens with the Texture Converter.

MT5 missing strip color

Most sonic models are missing their color.
Because they have no vertex color strip, the color must be stored somewhere else.

Models:

• GACRSO1G.MT5

PVR MipMap support

Only the first mipmap is being read at the moment.

PVR Bump Conversion

Some PVR textures contain the Bump format which is currently not supported yet.

Other "damaged" models

SCENE\01\MODEL\CHARA\BGA_L.MT5 - https://vgy.me/s5So7f.jpg
SCENE\01\MODEL\CHARA\RFD_L.MT5
SCENE\01\OP02_SHD2.PKS_\MAP02.MAPM - https://vgy.me/DGzRIN.jpg

FBX Reader/Writer

For conserving the node structure from MT5/MT7 a node based model format is needed.

MT7 wrong facing normals or wrong triangle winding

Some models have wrong facing normals or maybe even wrong triangle winding.

Files:

• 1GAS2A2I.MT7

MT5 UV mapping (mirror, repeat, clamp, fan)

MT5 UV mapping attributes are not read out yet.
Only the 0x0200 and/or 0x0300 strip function may contain these UV attributes.

Example Files:
SCENE\01\JU00_SHUKI.PKS_\BIKK3S2G.CHRM - https://vgy.me/AUpK70.png
SCENE\01\JU00_SHUKI.PKS_\BKGS501G.CHRM - https://vgy.me/KCLE86.png
SCENE\01\JU99\MAP.MT5 - https://vgy.me/SVRXpY.jpg (road uv map flip missing)
SCENE\01\MODEL\CHARA\BIKS504G.MT5 - https://vgy.me/WtbMUr.jpg

ModelOverride: Custom "FBX" format from d3t

Find out how this special "fbx" format is structured and implement a reader/writer for this format.

MT5 EndOfStreamException

In the MT5Mesh constructor there is an EndOfStreamException for some files.

Files:

• GACK6HKG.MT5
• GACK6TSG.MT5
• GACK6TZG.MT5
• GACK6XKG.MT5
• GACRDR1G.MT5
• GACRDR2G.MT5
• GACRGBIG.MT5
• GACRMETG.MT5
• SPBK6BRG.MT5
• SPBK6REG.MT5
• SPBK6YEG.MT5

MT5/MT7 Writer

Currently only reading is supported.