============
= CONTENTS =
============

1. Introduction
2. Requirements and compatibility
3. Building/running the mod
    3.1 If you downloaded the mod from ModDB, Google Drive or Dropbox
    3.2 If you downloaded a ZIP of the source from GitHub
4. Reporting bugs
5. License information
6. Credits
7. Links


1. INTRODUCTION
===============

Satanic Gameshow Deluxe is a gameplay mod for the classic Doom games, powered
by GZDoom. The mod's core feature set consists of a completely new weapon
arsenal, a "feat"-based weapon upgrade system and finishers a la Wrack.

Best played with your megawad of choice.


2. REQUIREMENTS AND COMPATIBILITY
=================================

Satanic Gameshow Deluxe requires GZDoom 4.5.0 at a minimum to run. It is
designed to be played with any commercial Doom IWAD. Compatibility with any
other IWADs is neither guaranteed nor planned.

While SGD may work with certain types of additional gameplay mods, I would
advise against using mods that modify the weapon arsenal, as SGD already comes
with its own custom weapon set. Monster mods are likely to work best when
combined with SGD.

Load SGD with Brutal Doom for a cool easter egg. Trust me, it's worth it.


3. BUILDING/RUNNING THE MOD
===========================

3.1 If you downloaded the mod from ModDB, Google Drive or Dropbox:
------------------------------------------------------------------
1.  Open sgd_*.zip with your archive manager of choice and extract sgd_v*.pk3
    into a folder of your choice. You may also extract any of the .txt files
    if you wish, but they are not necessary for running the mod.
2.  Click on and drag sgd_v*.pk3 over gzdoom.exe or use your launcher of choice
    to run the mod. If you want to load sgd_v*.pk3 alongside other PWADs, using
    a launcher is highly recommended.

3.2 If you downloaded a ZIP of the source from GitHub:
------------------------------------------------------
1.  Move sgd-master.zip to your folder of choice and unzip it.
2.  Run the _build.bat (Windows) or _build.sh (Unix) utility to generate a .pk3
    file in the _build folder.
3.  Click on and drag the generated .pk3 over gzdoom.exe or use your launcher of
    choice to run the mod. If you want to load the .pk3 alongside other
    PWADs, using a launcher is highly recommended.


4. REPORTING BUGS
=================

Bugs may be reported by the following means:

E-mail:                 mfg38thelps@aol.com
GitHub issues:          https://github.com/MFG38/sgd/issues
ModDB page:             http://www.moddb.com/mods/satanic-gameshow-deluxe

If you are sending a bug report by e-mail, please clearly state that you are
doing so in the e-mail subject line. Make sure to add any relevant attachments,
such as screenshots and/or videos, to your bug report regardless of the means
whereby you are submitting it.

Please note that due to changes committed to the GitHub repository being
incremental, builds downloaded and compiled from the repository are not guaranteed
to work as well as the stable builds. For this reason, I'd advise you to only
submit bug reports found in the stable builds (i.e. the ones with no -r### suffix).


5. LICENSE INFORMATION
======================

This work is licensed under the Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International License. To view a
copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/

You are free to copy and redistribute the material in any medium or format;
and remix, transform, and build upon the material. If you do so, you must
give appropriate credit, provide a link to the license, and indicate if
changes were made. You may do so in any reasonable manner, but not in any way
that suggests the licensor endorses you or your use. You may not use the
material for commercial purposes. If you remix, transform, or build upon the
material, you must distribute your contributions under the same license as
the original.


6. CREDITS
==========

Satanic Gameshow Deluxe is created by Santtu "MFG38" Pesonen.

See credits.txt for a full credits list.


7. LINKS
========

ModDB page:         http://www.moddb.com/mods/satanic-gameshow-deluxe
GitHub repo:        http://github.com/MFG38/sgd