Modding docs

[BadMagic100]

Background

We want a dedicated docs website for silksong modding, similar to the HK modding docs (https://prashantmohta.github.io/ModdingDocs/) since the games are just different enough. This task is not necessarily to create all of the docs, but rather to create the infrastructure so that documentation can be contributed (though including some initial docs wouldn't hurt!). A blank repository exists at https://github.com/silksong-modding/silksong-modding.github.io ready to be PR'd

Requirements

• The site should be servable as a static website (ie, no server needed) on github pages. Some options that have been discussed are vitepress and starlight. Jekyll (built in to github pages) is probably out because of the next bullet
• The approach should have simple support for custom theming (think like silksong themed fonts & colors).
• A workflow should be configured to build the site and publish to github pages on pushes
• Nice to have - coverage for common topics
  • How to create a new mod (use our template)
  • How to work with FSMs (show FSM express, fsm util)
  • Hooking
  • Publishing to thunderstore

[flibber-hk]

Common topics: Add an article for how to grab game assets at runtime (a la HK's preloads)

The way I see it, there are three cases:

• It's easy to go from (scene name, object name) to (object cached and ready to use). This will require a guide on how to do it, and possibly a library with helper utils to find where the object is in the asset bundles.
• It's hard to do the above without loading an entire scene. In this case something similar to the HK preloader system might be polite, partially because you can save time on loading scenes that multiple mods need assets from.
• The community decides that it's OK to ship game assets with mods. This will require additional software (probably?) and a guide.

[BadMagic100]

I've created #10 to look into prefabs more deeply and determine next steps