Author Topic: Technical documentation on module formats - appropriate for the wiki?  (Read 385 times)

Offline mabersold

  • Active artist
  • *
  • Posts: 14
  • I used to be cool
I've generally been referring to this site to find technical documentation on mod formats: https://ftp.modland.com/pub/documents/format_documentation/

While it's an excellent resource, the documentation is not standardized and is sometimes written confusingly. I was wondering, is the OpenMPT wiki an appropriate place to put technical documentation on file formats? It would be nice to have a single place for reference with a standardized style and clear information on how a module type is structured.

Offline Saga Musix

  • OpenMPT Developers
  • *****
  • Posts: 7,333
  • aka Jojo
    • Download music, samples, VST plugins: Saga Musix Website
  • Operating System: Windows 10 x64
Re: Technical documentation on module formats - appropriate for the wiki?
« Reply #1 on: September 13, 2021, 17:33:27 »
Generally I don't want the wiki to grow a place to host absolutely everything remotely related to tracked music, so currently it only contains development resources relevant to the formats OpenMPT can save. I think ModLand is a great place for those documents and I don't think lack of standardization is really a problem. Documents have often been confusing but it's important to preserve those original documents, which is why often corrections have been posted (see e.g. MODFIL12 in that folder).

https://wiki.multimedia.cx/ has information on some tracked formats but it often also incomplete. In the end, nobody probably wants to convert dozens of file format documentations from one format to another in their spare time and fix all the mistakes. That's why reading other mod players' codes is often the better way to learn how to accurately play a file. I know, it's not optimal, but you can hardly blame people for not wanting to do technical documentation at such a detailed level without any compensation.
ยป No support, bug reports, feature requests via private messages - they will not be answered. Use the forums and the issue tracker so that everyone can benefit from your post.

Offline manx

  • OpenMPT Developers
  • *****
  • Posts: 298
Re: Technical documentation on module formats - appropriate for the wiki?
« Reply #2 on: September 13, 2021, 17:52:01 »
In the end, nobody probably wants to convert dozens of file format documentations from one format to another in their spare time and fix all the mistakes. That's why reading other mod players' codes is often the better way to learn how to accurately play a file.

Not only that, but "converting" the confusing and old documentation to any standardized form will inevitably create further confusion due to "translation" errors, in particular if the person has not yet dealt with the specific format directly in code form.