Update README with more info regarding mercury formats #215

sabre230 · 2024-08-28T19:42:09Z

Includes some notes to help parse what each type is for, as well as a little info on them that I have knowledge of.

Includes some notes

duncathan · 2024-08-28T19:48:40Z

README.md

-| TOC       | &check;              | &check;               | &check;      | &check;       |
-| TXT       | &check;              | &check;               | &check;      | &check;       |
-| WEBM      | Missing              | Missing               | &cross;      | &cross;       |
+| Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Samus Returns (Purpose) | Samus Returns (Notes) |


these new columns are not specific to MSR. I'm also not sure the notes column is all that useful, at least for the MEDS readme. this is better suited for something like https://wiki.axiodl.com/ (but for MSE formats instead of retro)

Oh, is there already a wiki for MSE formats?

There sadly is not :(

I'm also not sure the notes column is all that useful, at least for the MEDS readme

I know Henrique has asked in the past explicitly for it to get added. IMO, having a very quick description of what the general format is about (especially while we dont have a wiki yet), helps non-familiar people to know on a quick glance what is actually supported. Telling them "bcmdl and bctex aren't supported, but bmsnd are" is way less helpful for them than "models and textures arent supported, but sounds are".

Also because I haven't made it clear before: I do think the "notes" section is useless and should be removed. Having a quick one-liner on "purpose" is more than enough.

I'm fairly fine with a quick blurb, though that could just be the purpose. We could have a wiki in this repository for more details on each format.

+1 for a wiki in the git repo. Would love to see a main hub for modders to be able to grab pertinent information from.

I would like to have a wiki, but IMO the workflow for wikis in git repos is kinda meh.
AFAIK it only allows editing from either owners or everyone (latter is bad because of vandalism, former is bad because admittedly we're all lazy), and major search engines either still dont crawl it or used to not crawl it.
I have a draft wiki locally that i have never pushed anywhere, mostly because i have no clue on most of the file formats and would rather have something filled out before I push it.

I would recommend something like MediaWiki, however that requires someone host it on a server, be it local or remote. The real benefit to Github's wiki format is that it doesn't need to be hosted by any one person. But the downsides are as you mentioned, more room for vandalism and upkeep issues. But I can confirm I've found github wikis from googling things before.

dunc already posted antidote's mediawiki above, we could probably discuss with him to host a mercury styled one instead.
but i personally dont like mediawiki that much because it also makes submitting changes harder, is harder to get themed (i very much value dark mode), and AFAIK is harder to write content for as you cant just use markdown.

My local-wiki-like-thing is using hugo, which i've always found more comfortable to work with. It also doesnt require someone to host it, as we can just host it off of github pages since it'd be a static website.

README.md

Incorporated changes from PR

sabre230 · 2024-08-28T20:48:26Z

Made revisions based on feedback.

README.md

Updated with changes requested from reviews

README.md

Miepee · 2024-08-28T21:09:45Z

README.md

+| BFSTM     | Missing              | Missing               | &cross;      | &cross;       |							|
+| BGSNDS    | Missing              | Missing               | &check;      | &check;       |							|
+| BLDEF     | Missing              | Missing               | &check;      | &check;       |							|
+| BLSND     | &check;              | &check;               | &check;      | &check;       | Sound				|	


just "sound" sounds too vague. sound effects? sound files? if sound file, whatd make it different from bcwav/bfstm?

That's a great question! I'd write it down if I knew. :P

README.md

Miepee · 2024-08-28T21:10:16Z

README.md

+| BMSEM     | &check;              | &check;               | Missing      | Missing       | Environment Data |
+| BMSES     | &check;              | &check;               | Missing      | Missing       | Environment Data |


whats the difference?

I'm not sure. I was told both are for environmental data but didn't get much info on the differences.

Iirc EM is Environment Music, and ES is Environment Sound/SFX

Environmental Sound

Miepee · 2024-08-28T21:10:32Z

README.md

+| BMSMD     | &check;              | &check;               | Missing      | Missing       | Menu Data (?)	|
+| BMSMSD    | &check;              | &check;               | Missing      | Missing       | Map Screen Data (?)	|
+| BMSNAV    | &check;              | &check;               | &check;      | &check;       | Navigation Meshes	|
+| BMSND     | &cross;              | &cross;               | Missing      | Missing       | Sound (?)   |


see sound comment above.

Miepee · 2024-08-28T21:11:29Z

README.md

+| BMSSK     | Missing              | Missing               | &check;      | &check;       |							|
+| BMSSS     | Missing              | Missing               | &check;      | &check;       |							|
+| BMSSTOC   | Missing              | Missing               | &cross;      | &cross;       |							|
+| BMTRE     | &cross;              | &cross;               | &check;      | &check;       | TRE (?)			|


im pretty sure other people know what this is. @steven11sjf at least fixed smoethingr egarding this recently.

Behavior Tree (entity AI)

README.md

"Collision Data, Geometry" to "Collision Data/Geometry" Co-authored-by: Miepee <[email protected]>

Updated with suggestions from reviews

steven11sjf

This is a lot but most of it is just adding dread stuff. there are a few SR things noted though.

steven11sjf · 2024-08-28T23:32:21Z

README.md

-| WEBM      | Missing              | Missing               | &cross;      | &cross;       |
+| Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose     |
+|-----------|----------------------|-----------------------|--------------|---------------|-------------|
+| BAPD      | Missing              | Missing               | &check;      | &check;       |                         |


Audio Preset (positional audio data)

steven11sjf · 2024-08-28T23:34:25Z

README.md

+| BCURV     | Missing              | Missing               | &cross;      | &cross;       |             |
+| BCUT      | &cross;              | &cross;               | Missing      | Missing       |	Related to cutscene files |
+| BCWAV     | &cross;              | &cross;               | Missing      | Missing       | Common 3DS audio format |
+| BFGRP     | Missing              | Missing               | &cross;      | &cross;       |							|


Sound WaveGroup (Common AAL audio format)

steven11sjf · 2024-08-28T23:35:05Z

README.md

+| BCTEX     | &cross;              | &cross;               | &check;      | &cross;       | Texture File |
+| BCURV     | Missing              | Missing               | &cross;      | &cross;       |             |
+| BCUT      | &cross;              | &cross;               | Missing      | Missing       |	Related to cutscene files |
+| BCWAV     | &cross;              | &cross;               | Missing      | Missing       | Common 3DS audio format |


Cafe/Citra Wave (Common AAL audio format)

steven11sjf · 2024-08-28T23:35:41Z

README.md

+| BCCAM     | &cross;              | &cross;               | &cross;      | &cross;       | Camera Objects |
+| BCLGT     | &cross;              | &cross;               | Missing      | Missing       | Lighting (?) |
+| BCMDL     | &cross;              | &cross;               | &check;      | &cross;       | 3D Models	  |
+| BCPTL     | &cross;              | &cross;               | &cross;      | &cross;       | PTL (?)     |


Particle Effect

steven11sjf · 2024-08-28T23:36:35Z

README.md

+| Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose     |
+|-----------|----------------------|-----------------------|--------------|---------------|-------------|
+| BAPD      | Missing              | Missing               | &check;      | &check;       |                         |
+| BCCAM     | &cross;              | &cross;               | &cross;      | &cross;       | Camera Objects |


Might want to mention that it's used exclusively for a "shot" in a cutscene (afaik)

A shot? Like another camera angle? Or a one-off used in some cutscene?

sort of? it's like a shot in a film, where the camera can move, rotate, etc but it's not jumping between positions.

looking at this, the first shot runs to about 2:50, the second goes to 2:57, etc.

Poking around the other cutscene files it calls them "takes" which should probably be used instead

So it's just there to handle when the camera angle changes and what it should be doing, exclusively in cutscenes. Is that right?

CutScene Cam?

steven11sjf · 2024-08-28T23:55:07Z

README.md

+| BSMAT     | Missing              | Missing               | &check;      | &check;       |							|	
+| BTUNDA    | Missing              | Missing               | &check;      | &check;       |							|
+| BUCT      | &check;              | &check;               | &check;      | &check;       | Font File (?) |
+| INI       | Missing              | Missing               | &check;      | &check;       |							|


Standard INI format

steven11sjf · 2024-08-28T23:55:25Z

README.md

+| PKG       | &check;              | &check;               | &check;      | &check;       | Packaged Files |
+| TOC       | &check;              | &check;               | &check;      | &check;       | Table of Contents |
+| TXT       | &check;              | &check;               | &check;      | &check;       | Text File	  |
+| WEBM      | Missing              | Missing               | &cross;      | &cross;       |							|


Standard WEBM format

steven11sjf · 2024-08-28T23:56:40Z

README.md

+| LC        | &check;              | &check;               | &check;      | &check;       | Lua Bytecode|
+| PKG       | &check;              | &check;               | &check;      | &check;       | Packaged Files |
+| TOC       | &check;              | &check;               | &check;      | &check;       | Table of Contents |
+| TXT       | &check;              | &check;               | &check;      | &check;       | Text File	  |


UTF-16 Text File

that's not quite true. TXT uses multiple encodings and follows a specific structure

README.md

steven11sjf · 2024-08-28T23:58:11Z

README.md

+| BMSEM     | &check;              | &check;               | Missing      | Missing       | Environment Data |
+| BMSES     | &check;              | &check;               | Missing      | Missing       | Environment Data |
+| BMSEV     | &cross;              | &cross;               | Missing      | Missing       | EV (?)			|
+| BMSLD     | &check;              | &check;               | Missing      | Missing       | Level Data	|


Samus Returns scenario entity data

That fills up just about all the gaps, thank you so much! ❤️ I've made another commit with those changes.

Added in all the information provided by steven11sjf (tyvm!)

randovania#215 (comment) randovania#215 (comment)

steven11sjf · 2024-08-29T03:59:49Z

README.md



 ## Example Usage

 ```python
-# TODO
+# TODOBMTRE


That looks like a typo on my part, my b.

steven11sjf · 2024-08-29T04:00:50Z

README.md

+| BFSAR     | Missing              | Missing               | &cross;      | &cross;       | FSAR (?) |
+| BFSTM     | Missing              | Missing               | &cross;      | &cross;       | Common Switch audio format |
+| BGSNDS    | Missing              | Missing               | &check;      | &check;       | BackGround Sounds (?) |
+| BLDEF     | Missing              | Missing               | &check;      | &check;       |							|


Actor Lighting Definition

steven11sjf · 2024-08-29T04:01:13Z

README.md

+| Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose     |
+|-----------|----------------------|-----------------------|--------------|---------------|-------------|
+| BAPD      | Missing              | Missing               | &check;      | &check;       | Audio Preset (positional audio data) |
+| BCCAM     | &cross;              | &cross;               | &cross;      | &cross;       | Cutscene Camera (used exclusively for cutscene takes) |


I would say "camera animation" instead of "cutscene camera"

steven11sjf · 2024-08-29T04:02:10Z

README.md

+| BLDEF     | Missing              | Missing               | &check;      | &check;       |							|
+| BLSND     | &check;              | &check;               | &check;      | &check;       | Sounds (?) |	
+| BLUT      | Missing              | Missing               | &check;      | &check;       | LookUp Table (used for ADAM animation) |
+| BMBLS     | Missing              | Missing               | &check;      | &check;       |							|


Blend Space

fixed typo, added suggested revisions

ThanatosGit · 2024-09-03T20:23:17Z

I'm not gonna scroll through 90+ messages...is this the only thing left? #215 (comment)

henriquegemignani

Just so this doesn't get lost forever, I'll merge this. I think it'll work better if we review the result and make issues of what's wrong.

stale

Update README with more info regarding MSR types

35f3d03

Includes some notes

duncathan previously requested changes Aug 28, 2024

View reviewed changes

ThanatosGit reviewed Aug 28, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Miepee reviewed Aug 28, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

cbc0265

Incorporated changes from PR

sabre230 requested a review from duncathan August 28, 2024 20:56

ThanatosGit reviewed Aug 28, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Update README.md

6d0a50b

Updated with changes requested from reviews

Miepee reviewed Aug 28, 2024

View reviewed changes

sabre230 and others added 2 commits August 28, 2024 14:21

Update README.md

7936e1b

"Collision Data, Geometry" to "Collision Data/Geometry" Co-authored-by: Miepee <[email protected]>

Update README.md

e70afa4

Updated with suggestions from reviews

steven11sjf reviewed Aug 29, 2024

View reviewed changes

sabre230 added 2 commits August 28, 2024 18:20

Update README.md

ba8768b

Added in all the information provided by steven11sjf (tyvm!)

Update README.md

2f91356

randovania#215 (comment) randovania#215 (comment)

steven11sjf suggested changes Aug 29, 2024

View reviewed changes

Update README.md

7cf01f0

fixed typo, added suggested revisions

Miepee changed the title ~~Update README with more info regarding MSR types~~ Update README with more info regarding mercury formats Aug 29, 2024

henriquegemignani approved these changes Sep 8, 2024

View reviewed changes

henriquegemignani enabled auto-merge September 8, 2024 12:13

henriquegemignani added this pull request to the merge queue Sep 8, 2024

Merged via the queue into randovania:main with commit c7b1d2b Sep 8, 2024
7 of 8 checks passed

		\| BMSEM \| &check; \| &check; \| Missing \| Missing \| Environment Data \|
		\| BMSES \| &check; \| &check; \| Missing \| Missing \| Environment Data \|

Update README with more info regarding mercury formats #215

Update README with more info regarding mercury formats #215

Conversation

sabre230 commented Aug 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sabre230 commented Aug 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steven11sjf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sabre230 Aug 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThanatosGit commented Sep 3, 2024

henriquegemignani left a comment

Choose a reason for hiding this comment

sabre230 Aug 29, 2024 •

edited

Loading