Outer Wilds Mods

Page for aggregating info related to mods for the game Outer Wilds. Built with SvelteKit.

The content of this website is generated at build time based on a few things:

• Basic information about the available mods and their thumbnails come from the Outer Wilds Mod Database;
• The main content of each mod page (for example, outerwildsmods.com/mods/nomaivr) is taken from that mod's README.md (from the default branch);
• Images present in mod readmes are analyzed to retrieve their dimensions, so that the height/width can be included in the HTML and improve SEO;
• The download count history chart (for example, outerwildsmods.com/mods/nomaivr/downloads) is taken from this repo which goes through all the commit diffs in the mod database.

What to do if the website is down?

If you notice the website is down, please notify the admins in the Outer Wilds Modding Discord. In the meantime, you can use staging.outerwildsmods.com. If both of these are down, then God help us all.

Development setup

• Install Node;
• Run npm install;
• Run npm run dev;
• Server will run in localhost.

Testing changes

Before deploying changes live, it's a good idea to test them on the staging website. Just push to the master branch of the staging repo and changes will be deployed to staging.outerwildsmods.com. These two repos aren't kept automatically in sync, so one thing you can do is develop on a new branch in the outerwildsmods.com repo, and then use this command to force-push the changes to the staging repo:

git push https://github.com/ow-mods/staging.outerwildsmods.com.git master -f

Deploying to production

Anything that's merged to master will be deployed to production with the Auto Deploy workflow.