Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 3.79 KB

README.md

File metadata and controls

32 lines (22 loc) · 3.79 KB

Bug-Fables-Internal-Docs

A repository to aggregate documentation about Bug Fables's inner working

This repos contains all the documentation I have accumulated throughout the years as well as new ones that will be pushed here as I learn more about the game. The purpose of this repos is to have a centralised place to consult my docs. It also prevent a situation where these files are lost and it provides a source that doesn't involve the wiki or the Discord. I will seek plans to present the info better such as GitHub pages in the future, but for now, I just put the raw information in markdown which will be refined as I continue working on the game's internals.

The reason information shouldn't be from the wiki or the discord is because the former has proven to not be as reliable and it is difficult to consult or edit while the later is complex to lookup and isn't guaranteed to always remain available. Informations about the internals are going to be ESSENTIAL for anyone looking to mod anything and for myself in my current project so they MUST be provided in a central place that everyone has access to. This repos also has a wiki which will be more focussed on important procedures such as extracting assets, decompiling and debugging the game.

This repos will get updates as more information is aggregated and figured out so it isn't lost in time. I accept pull requests or issues (in case of typos or innacurate informations), but everything needs to provide a way for me to validate the infoormation.

What is allowed in this repos and what isn't

This repos will ONLY contain the informations that describes the interface of the game. This mostly includes:

  • Documentations on any data file (its format and what each lines or fields does)
  • List of enum values
  • Field's names or method's signature (without any code body)
  • High level documentation on a subsystem of the game or as a whole. This means sentences in mostly English describing how something works without providing any code from the game.

This means it will NEVER contain any of the following:

  • Visual or audio assets
  • Unity assets files generated from an extractor
  • Data files or dialogue files (even in aggregated format)
  • Code body of a method
  • Any binary files from the game

This isn't just for obvious legal reasons (mainly the code part), but also because these aren't actually helpful here. There are many reasons:

  • For code, It can leave the wrong impression without understanding the proper context of how the game was made. This is because there are parts of the code that suffers from tight coupling or have a monolithic approach which can lead to developmental issues which affects modding. This context explains everything, but is easily overlooked and it isn't really necessary to mention to document the internals unless it becomes historically relevant (such as described a known issue with how it happened). Avoiding to share code avoids this perception problem.
  • For data files, it's simply because there's no point: the formats are not made to be human readable because automated tools generated them. The goal of this repos is to allow them to be readable by external tools or by a human manually. As for why not providing aggregated versions of them, it's because they arguably don't belong in a docs repos which should only contain the specification of the data, but not its implementation. I rather decouple the 2 since the data won't change, but the knowledge of it can.
  • For Unity assets, it's just because the actual instances (mainly the maps prefabs) don't matter as much for this repos. What matters is how they work so one can pick an actual instance and understand what it is telling the game to do.
  • For anything else, it's not needed + the less files I share from the game, the better.