AFKMud Database Help Files - QSF Portal 2.0+ Module
===================================================

This set of files will allow you to pair an installation of QSF Portal 2.0 or higher with the module to allow you to read your MUD's helpfiles from the web.

You can also add, edit, or delete help files via the web UI as long as the person doing so is designated as an admin in the QSFP site. Obviously make sure you trust people you make admins!

Visit https://smaugmuds.afkmods.com/index.php?a=afk_helps for an example of how this system works.

Prerequsite Requirements
------------------------

Working MUD based on the AFKMud Codebase, version 2.0 or higher.
QSF Portal 2.0 or higher installed on the website. This module is NOT backward compatible with older QSFP installs!
AFKMud SQL Helpfiles snippet installed in your MUD, with the helpfiles converted to the database your QSFP site is installed on.

Installation
------------

Upload the "func" and "skins" folder to your QSFP install.
Once uploaded, access it via your web browser: https://yourdomainhere.com/index.php?a=afk_helps to verify it works.
Add a navigation link to it somewhere on your site.

If you are using a custom skin instead of the default that came with QSFP, install the "skins\afk_helps" folder into it and adjust the .xtpl files as desired to fit your skin.