Skip to content
Permalink
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

OWHugMod/README.md

Go to file
 
 
Cannot retrieve contributors at this time
Outer Wilds Hug Mod How to use the API
15 lines (12 sloc) 1.37 KB
Raw Blame
Open in GitHub Desktop

Outer Wilds Hug Mod

HugMod Thumbnail

Adds a hug mechanic to the game and unlocks a new DLC-exclusive option in the settings menu.
DLC not required, but there are spoilers in the source code.

Huge thanks to JohnCorby, Vesper, and the Outer Wilds modding community for their coding help and support, and Tephirax for the screenshot used in the thumbnail!

How to use the API

This mod comes with an API, allowing other mods to use its mechanics to make their custom content huggable!

  • To introduce hug functionality into your mod, add this .cs file to your project.
  • Access the API by calling something like var hugApi = ModHelper.Interaction.TryGetModApi<IHugModApi>("VioVayo.HugMod");.
    You might also have to add using HugMod; at the top of your file.
  • Use the methods defined in the interface to add and customise the hug script to fit specific characters or objects.
  • All methods included in the .cs file come with summaries that explain what they do, but if anything's unclear and you have questions, feel free to join the discord linked above and ask.