Documentation

Readme

View as plain text

1.0.5.0 Release Notes:

-Reorganized the mods script structure to be more compatible with other mods
-We have created a HUD element for relevant information (NOTE: requires Hud Framework)
-New glass visors have been implemented.
-Added a holotape to control several options
-Removed the need to download optional compatibility patches for armor files.
-Added crafting for filters. Crafting is in the chem station and requires resources and expired dirty filters in order to craft new ones.
-Thanks to DogtoothCG, we have a new M1A211 gas mask that has been added to drop tables.
-Animations by MaxG3D have been added. As of now, replacing filters has animations and the Gas Mask with Goggles, M1A211 and the Raider Gas Mask have animations for equipping and unequipping. We plan to make our way through all masks and add animations.

Work In Progress:

-Mods for gas masks
-Destructible Gas Masks (including those of your enemies)
-Additional options for holotapes including Drop Rates.
-Inclusion of more armor mods,
-Additional Animated Gas Masks by MaxG3D.
-Game Mechanic for wiping your gas mask clean.



1. Premise


Inspired by Metro 2033, this mod implements a new resource, gas mask filters. Human NPC's and the player are required to wear a gas mask while wandering in exterior wasteland areas.While equipped, Gas masks consume filters that keep out harmful radiation attached to dust particles in the air. Filters prevent heavy radiation exposure in conjunction with a functioning gas mask. Power armor acts as a gas mask and does not consume filters but instead drains fusion cores.

2. Features

-Humans wear gas masks while in exterior areas (normal version) OR equip them if precipitation starts (precipitation version)

There are a few Factions that are exempt: Children of Atom (cause they love radiation), Ghouls (heal from radiation), Children (because they won't equip gas masks, I tried asking nicely), Synths (Gen 3 or otherwise UNLESS they are undercover), A few Unique NPC's whom I deemed too "superior" for Gas Masks,

-Humans receive scaling radiation damage per second if they do not have a gas mask equipped OR they have no filters while in World Regions (Commonwealth, Goodneighbor, Diamond City, etc...),

-NPC humans remove gas masks on location change if they enter interior areas (normal version) or they remove them in pleasant weather (Precipitation version).

-Filters on NPC's/containers,.

-Power armor act as gas masks.

-Visual/Sound effects play when the player: Does not have a gas mask on, equips a gas mask, replaces a gas mask filter

-Audio sliders for: filter change SFX, breathing, gasping/choking, Sprinting.


3. Required Mods

-Hud Framework If you would like to have the hud element, this is required


4. Recommend Mods

-Geiger Counter
-ArmorKeywords


5. Compatibility


-Mods that modify leveled lists may have compatability issues.


6. Installation

-If you have a previous version: Uninstall the main and all Optional files.
-We have an installer for NMM users.

Manual
-Core files go into "(...)Steam\SteamApps\common\Fallout 4\Data"

-Data files include optional esp files that go into "(...)Steam\SteamApps\common\Fallout 4\Data"

-Data\Meshes files include the Glass Overlay files. Choose one of the FOV's and copy the lowest overlay folder into "(...)Data\Meshes\FO2287\"

7. Suggested Mod Load Order (in order):

Main:Gas Masks of the Wasteland
Optional Files/Weather Mods


8. Tips


-In Vault 111 (at the entrance) and at the Red Rocket station (in garage) I have placed "Survival" Containers that have a supply of Filters and a Gas Mask to get you started.

-While indoors, filters will not be consumed.

-If the breathing, filter changing, or other sounds appear too loud, there are sliders in the Audio Menu that to change their volume.


9. Known Issues


-Gas mask glass overlay will disappear occasionally.
-Getting into power armor with a mask on plays the unequip animation
-Children won't wear gas masks,


11. Help Needed


-We are looking for 3D Artist capable of modelling a higher quality versions of vanilla gas mask models for the first person animation purposes and a sound designer
-General/Bug testing (performance, stability, consistency)
-Identifying new Gas Mask candidates (Find a cool armor that seems like it could be a functional gas mask? Let me know)
-Modeling (Want to make a new gas mask? Let me know and I can add it and give you credit. Already have a mod with gas masks? I can add it to the Database)
-Videos


12. PSA For Modders

Weather mods should be compatible but if you would like it to be consistent, open a weather in the Creation Kit go to the Precipitation and change the Weather Classification flag to an appropriate setting (snow is rad storms).


13. Credits/Team

-Team 2287-
D1v1ne122 - Leader, Programmer
Scrivener07 - Programmer
The Shiny Haxorus/Robersonb1 - Animator, Compiler
MaxG3D - Animator
HugeBoomer- Gas Mask Expert, Sound

- Contributors -
Goldenscale001- Sound
DogtoothCG- Modeling
payl0ad- Compatibility Patches