Skip to content
FlaringK edited this page May 23, 2024 · 3 revisions

Welcome to the mspfaViewer wiki!

This repo contains two templates that let you port an mspfa and self host it on your own site, like neocites or github pages.

1. Downloading the templates

The two files in the root of this repo, mspfa & uhc, are the two templates that this repo provides, they can both be previewed here: https://flaringk.github.io/mspfaViewer/

In both cases you should download the repo, extract it, and copy the file of the style that you want, the contents of such will act as the root to your site.

2. Downloading your adventure data in .json format from MSPFA

There are two ways to download your adventure's data from MSFPA.

If you have the MSPFA Extras Userscript installed, then in the adventure info page of your adventure there will be an EXPORT button, this will let you select from 2 formats to download your adventure, select the JSON format.

Otherwise on your adventure's page editor if you scroll down to the bottom there is an Export Data button which will let you download the same data.

3. Loading your data into the Template

In your template folder there is a file named adventure.json. This is where your adventure data should go. Simply remove this file, place your own in it's place, and rename it to adventure.json.

Other infomation

This is all the steps you need to take to prep your adventure for self hosting, you can now move the contents of your template file into which every hosting service you'd like and it will host your adventure.

Note the following:

  • If your adventure has custom Javascript or loads a custom style from another adventure it will not transfer over.
  • Your adventure's CSS style may break on these templates, uhc moreso then mspfa, but the template will do it's best with the style that is given.

It is recommended and encoraged that you implement your own custom CSS style and Javascript for your adventure.