FRUA MODULE MANAGER
===================

http://gbc.zorbus.net
joonas.hirvonen@pp.inet.fi


Release 3
(19-Aug-2020)



FRUA-MM is module manager tool for FRUA (Forgotten Realms: Unlimited Adventures) that helps downloading and installing modules.



BEFORE USING
============

- FRUA-MM is still in experimental state, especially applying module hacks.

- It's best to start the tool first time when FRUA is in a vanilla, unmodded state as backups of the FRUA files are made at first start.

- FRUA-MM does not need Gold Box Companion but if it's in the same folder as GBC.exe it uses the same settings-file.

- You can use FRUA-MM just for installing modules and then use UAShell or UADAP (UA Design Apply, graphical Windows tool) to apply hacks.

  UADAP can be found here:
  http://frua.rosedragon.org/pc/hacks/uadap.zip
  http://frua.rosedragon.org/pc/hacks/uadap.txt

  UADAP discussion: 
  http://ua.reonis.com/index.php?topic=3428.0
  


USAGE
=====

- When you first start FRUA-MM, it asks you to locate the folder where FRUA is installed (the folder that has the "CKIT.EXE" file).
  It uses the same settings as Gold Box Companion so if you have set the FRUA folder already in GBC, you can skip this part.

- If this is the first start of the tool, backups of original FRUA-files are made (files in folders "DISK1"-"DISK3" and "CKIT.EXE").

- If not already downloaded, FRUA-MM tries to automatically download the module list from UA File Archive (http://frua.rosedragon.org).
  If all goes well you should see a list of modules. 
  You can later refresh the module list by clicking DOWNLOAD MODULE LIST.

- You can filter the module list by entering keywords (separated by space) in the filter field.
  You can filter any of the seen fields and the description (shown in the memo box when you click a module).

- By pressing DOWNLOAD MODULE or doubleclicking a module will download and install it.
  Installing means that the zip-archive and all subarchives inside the archive are extracted to a temporary folder
  and the files are copied to a <module_name>.DSN folder.

- After pressing APPLY MODULE HACKS, original FRUA files are restored from the backup folder, hacked files are copied to the "DISK1"-"DISK3" 
  folders replacing the original ones, "CKIT.EXE" is patched based on the "DIFF.TBL" file, and the module is set active in FRUA (module name 
  is written to the file "START.DAT").



OTHER STUFF
===========

- By pressing APPLY PATCHES, you can patch file "CKIT.EXE" with patches found in the "FRUA_Patches"-folder.
  You can store patches in the "FRUA_Patches\Storage"-folder, these won't be applied.
  You can open this folder quickly with the OPEN PATCHES FOLDER button.
  Use this function after using APPLY MODULE HACKS.

- Patch files can have comments. If the first character on a line is not 0-9 or A-F then the line will be skipped.

- You can delete installed modules with the DELETE MODULE button.
  The "HEIRS.DSN" and "TUTORIAL.DSN" modules that come with FRUA can not be removed this way.

- RESTORE ORIGINAL FILES button deletes the contents from folders "DISK1"-"DISK3" and copies the original files to them.
  File "CKIT.EXE" is restored to the original. The file "START.DAT" is cleared.

- You can doubleclick an installed module to open its folder.

- Rightclick an installed module to run "FRUA_Module_Manager.bat".
  Sets the currently selected module active in FRUA (module name is written to the file "START.DAT").
  You can for example start DOSBox this way. Included batch file runs the GOG Galaxy version of FRUA.

- Press Control + D to toggle debug mode. In debug mode the download and extract batch windows are shown.
  
- External program "Tools\curl.exe" is used for downloading the module list and files.

- External program "Tools\7za.exe" is used for extracting the downloaded zip-archives.

