Waterfall configs for Realism Overhaul mods (WIP)

Work-in-progress Waterfall configs for Realism Overhaul mods.

As it currently stands, Waterfall is a moving target that is still itself in heavy development. We always target the latest release of Waterfall, so if something does not work, your first step should be to verify that you have updated ALL relevant mods.

Support requests and bug reports should be directed here, NOT to Waterfall, Realism Overhaul, or any other mods.

INSTALLATION INSTRUCTIONS

Please note that the latest version (as of 2021-03-31) moved several files. Delete the GameData/ROEngines/Waterfall and GameData/RealismOverhaul/Waterfall_Configs folders before updating.

1. If you have not done so, update to the latest versions of RealismOverhaul (>= 13.0) and ROEngines (>= 1.7).
2. Install the latest version of Waterfall.
   • ROE-Waterfall and Waterfall are two separate things. ROE-Waterfall provides configurations for Realism Overhaul engines, Waterfall provides the effects themselves. ROE-Waterfall is to Waterfall as RealPlume-Stock is to RealPlume. You need both.
3. Download this package: Press the green button "Code" and click on "Download ZIP".
4. Unpack into GameData and agree to overwrite.
5. Launch the game.

If you prefer engine lights from Engine Lighting Relit instead of Waterfall, create an empty folder named ROWaterfallNoEngineLight under GameData.

The eventual goal is to merge this patchset into the relevant RO mods; this unconventional installation process is only temporary.

Currently Configured Parts

Note: Due to technical limitations (see #1), only one plume can be provided at the moment for engines with switchable fuel configurations (ex. hypergolic and kerolox).

• Realism Overhaul
  • 1.1/1.78 kN Thruster (white hypergolic plume only)
  • 2.2/3.6 kN Thruster (white hypergolic plume only)
  • NERVA I (ReStock model only)
  • Bornholio Nuclear (ReStock models only)
    • KIWI A24
    • KIWI B48
    • NERVA NRX 50
    • NERVA XE 100
    • Pewee 100
    • Phoebus One 50
    • Phoebus Two 100
    • RD-0410 NTR
    • SNTP-PFE 100
  • NSTAR ion engine (ReStock model only)
  • RCS quads (ReStock model only)
• ROCapsules
  • Apollo
    • Command Module
    • RCS block
  • Apollo LEM
    • Ascent Module (LMAE + RCS)
    • LMDE
  • Apollo (Eyes Turned Skyward)
    • Block III+ Command Module
    • Block III Engine
    • Block V Engine
  • CST-100 Starliner
    • Command Module
    • Service Module
    • RS-88
  • Dynasoar
    • Aft Bay (RCS only)
    • Fuselage
    • Wings
  • Gemini (BDB models)
    • Equipment Module
    • Orbital Attitude and Maneuvering System
    • Reentry Control System
    • Retro Module
  • Mercury
    • Command Module
    • Landing and Control Module
  • Orion
    • Command Module
    • European Service Module
    • RCS block
  • Vostok
    • Support Module
• ROEngines
  • Alcolox
    • A4
    • A-7 (alcolox plume only)
    • RD-100 (early Soviet missiles)
    • XLR-11
    • XLR-25
    • XLR-41, XLR-43 (alcolox plume only)
  • Ammonialox
    • XLR-99
  • Hydrolox
    • BE-3 (New Shepard)
    • J-2 (Saturn V)
    • J-2X
    • HG-3
    • LR-87-LH2, sea-level and vacuum variants
    • M-1, sea-level and vacuum variants
    • RD-57
    • RD-0146
    • RD-0120 (Energiya)
    • RL-10 family (various American upper stages)
    • RS-25 (Space Shuttle)
    • RS-68 (Delta IV)
    • RZ.20
  • Hypergolic
    • Aerobee
    • Agena family (Agena upper stage)
    • Early and Mid-period AJ10 (Able and Delta upper stages)
    • AJ10-137 (Apollo spacecraft)
    • AJ10-190 (Space Shuttle)
    • AJ10 Transtar (hypergolic plume only)
    • Juno 6k
    • Juno 45k
    • KTDU-35 (Soyuz)
    • KTDU-425A (4MV and 5MV)
    • Leros 1b (white hypergolic plume only)
    • Leros 4 (white hypergolic plume only)
    • LMAE (Apollo spacecraft)
    • LMDE (Apollo spacecraft)
    • LR-87, LR-87-AJ-11 (Titan) (AZ50/NTO plume only)
    • LR-91 (Titan) (AZ50/NTO plume only)
    • R-4D (white hypergolic plume only)
    • R-40 (white hypergolic plume only)
    • R-42 (white hypergolic plume only)
    • RD-0210, RD-0211 (Proton)
    • RD-119 (Kosmos-2)
    • RD-215 (Kosmos-3, Cyclone)
    • RD-253 (Proton)
    • S400 (white hypergolic plume only)
    • S5.92 (Fregat)
    • S5.98M (Briz)
    • S-155 (E-50)
    • SuperDraco, single and twin variants (Dragon spacecraft)
    • TD-339 (white hypergolic plume only)
    • Viking family (Ariane-1 to 4)
  • Kerolox
    • E-1
    • F-1 (Saturn V)
    • F-1B
    • H-1 family (Saturn IB)
    • LR-79 (Thor)
    • LR-89, LR-101, LR-105 (Atlas)
    • Merlin 1 family (Falcon 9)
    • NK family (N-1)
    • RD-0105 (Luna and Vostok rockets)
    • RD-0110 and its vernier (Block I)
    • RD-0124 (Angara)
    • RD-58 (Blok-D upper stage)
    • RD-107, RD-108 (R-7 family)
    • RD-120 and RD-8 (Zenit)
    • RD-170 family (Energiya, Zenit, Atlas V, Antares)
    • Rutherford, sea-level and vacuum variants (Electron)
    • RZ (Blue Streak, Europa)
    • X-405 (Vanguard)
    • X-405H (Vega upper stage)
  • Kerosene + HTP
    • Gamma family
    • Stentor
  • Kerosene + Nitric Acid
    • ORM65
    • RD-200
    • RD-211 (R-12 and Kosmos-2)
    • S2.253 (Scud)
    • Veronique (Veronique sounding rocket)
  • Methalox
    • BE-4 (Vulcan and New Glenn)
    • Raptor, sea-level and vacuum variants (Starship)
  • Monopropellant
    • MR-80 TDE
    • MR-80B (MDE)
    • MR-104
    • MR-107 (0.592 kN Dual Radial Engine)
  • Nuclear Thermal Rocket
    • Bimodal NTR
• Mandatory RCS Parts Pack
• Internal RCS
• ReStock Plus
  • RCS blocks
• Ven's New Parts
  • RCS blocks
• Real Scale Sea Dragon
  • First and second stage engines
  • TVC engine

If you find something bad here, please open an issue or a PR. Or write in the Realism Overhaul discord.

ROWaterfall Technical Documentation

ROWaterfall is a set of ModuleManager patches used to easily apply Waterfall and audio effects to engines.

Basic Usage

The minimal configuration for adding a Waterfall plume and sound effect is as follows:

@PART[PartName]:BEFORE[ROWaterfall]:NEEDS[Waterfall]
{
    ROWaterfall
    {
        template = waterfall-kerolox-lower-4
        audio = pump-fed-medium-1
    }
}

Note that the patch should be applied in the :BEFORE[ROWaterfall] pass.

ROWaterfall will transform this patch into a Module[ModuleWaterfallFX] node and an EFFECTS node, removing existing effects (stock, RealPlume) as necessary. However, it is still possible to use RealPlume (or stock) effects in conjunction with ROWaterfall – see below.

Only one ROWaterfall node will be processed for a single part. If more complex plumes are needed, extra ModuleWaterfallFXes can be added manually as usual; they can coexists with ROWaterfall.

Configuration Options

An ROWaterfall node can contain the following keys and nodes:

Key or node name	Required	Default value	Description
template	Yes	N/A	The desired Waterfall template name. Default Waterfall templates can be found in Waterfall/Templates, and RO provides supplemental templates under RealismOverhaul/Waterfall_Configs/_Templates.
audio	No	None	The audio template to use, a selection of which are available in RealismOverhaul/Waterfall_Configs/_Audio. While not strictly required, omitting this key will result in a silent engine.
moduleID	No	Part's name	Override the moduleID of the generated ModuleWaterfallFX.
engineID	No	basicEngine	Set the engineID used for the throttle controller, if one is present.
transform	No	thrustTransform	Set the value of overrideParentTransform on the main template. If the template is an RCS template, then the thrusterTransformName key of the RCS controller will also be set to this value.
position	No	0,0,0	Set the position of the main template.
rotation	No	0,0,0	Set the rotation of the main template.
scale	No	1,1,1	Set the scale of the main template.
glow	No	None	Add a nozzle glow that appears at the same position and has the same size as the base of the main template. This can be used to cover up the prominent "holes" in the plumes of engines that lack emissive textures. The value can be of two forms: _<color>, referencing one of the waterfall-nozzle-glow-<color>-1 templates; or ro-<name>, referencing one of the rowaterfall-glow-<name> templates. Setting this key to any other value will result in undefined behavior. By default, the length of the generated glow will be twice the average of the x and y scales of the main template. Glows that require more complicated configuration (ex. custom positioning) should be added manually using an ExtraTemplate node.
glowStretch	No	1	This key applies a multiplier to the length of the generated glow. It is useful for very short nozzles, where the default length might result in unsightly clipping.
ExtraTemplate {}	No	None	This node can be used to add extra templates (ex. for verniers) to the generated ModuleWaterfallFX. The template key is required. The transform, position, rotation, and scale keys are optional and will inherit from the parent ROWaterfall node if not specified. Multiple ExtraTemplate nodes may be used in an ROWaterfall node.

Here is an example using some of the optional configuration options:

@PART[ROE-RD107]:BEFORE[ROWaterfall]:NEEDS[Waterfall]
{
    ROWaterfall
    {
        template = waterfall-kerolox-lower-1
        audio = pump-fed-heavy-1
        transform = RD-107A-MainFXTransform
        position = 0,0,0.48
        rotation = 0,0,0
        scale = 1.3,1.3,1.3
        glow = _yellow  // Expanding to `waterfall-nozzle-glow-yellow-1`.

        ExtraTemplate
        {
            template = waterfall-kerolox-vernier-2
            transform = RD-107A-VernierFXTransform
            position = 0,0,0.29
            rotation = 0,0,0
            scale = 2.5,2.5,2
        }
    }
}

Plume Templates

In addition to the templates provided by Waterfall, ROWaterfall also ships a number of supplemental templates.

The rowaterfall-glow- family

These effects are recolors of the glows shipped with Waterfall.

Currently provided colors:

• hydrolox-blue: Less brightly cyan blue glow for upper-stage hydrolox engines.
• hydrolox-red-blue: Transitions from red at sea-level to blue in vacuum, for sea-level hydrolox plumes.
• hypergolic-az50: Yellow-orangish, for use specifically with aerozine50-NTO plumes.
• hypergolic-white: White, without a yellow tinge, for use with generic hypergolic/monopropellant plumes.
• methalox-blue
• methalox-purple
• ntr

From left to right: hydrolox-blue, hydrolox-red-blue at sea level, hydrolox-red-blue in vacuum, hypergolic-az50, hypergolic-white, methalox-blue, methalox-purple, ntr.

rowaterfall-hypergolic-superdraco

Orange hypergolic plume with prominent shock diamonds, inspired by SpaceX SuperDraco thrusters.

Templates from Bluedog Design Bureau

• BDB_HTP_vernier
• BDB_HTP_vernierVac
• BDB_nuclear_PBR_vac

Audio Templates

ROWaterfall will generate audio effects using the default node names: running, engage, disengage, and flameout.

The following generic templates are available:

• pressure-fed-1
• pump-fed-very-light-1
• pump-fed-light-1
• pump-fed-medium-1
• pump-fed-heavy-1
• pump-fed-very-heavy-1
• rcs-jet-1

The series of pump-fed effects are increasingly crackly, based on sound effects from Rocket Sound Enhancement (shipped as part of Waterfall).

There are also the following specialized effects for use:

• pump-fed-f1-1, which is extra crackly and energetic.
• pump-fed-gamma-1
• pump-fed-lr87-1, with the real "whoop" startup sound.
• pump-fed-raptor-1, with real sound effects from SpaceX test footage.
• pump-fed-stentor-1

Using RealPlume or stock effects in conjunction with Waterfall

RealPlume effects can be added in the :AFTER[ROWaterfall] pass if they need to coexist with ROWaterfall. If they are added any earlier, they will be deleted by ROWaterfall in :FOR[ROWaterfall].

Stock (including audio) effects can be added in :AFTER[ROWaterfall] as long as they have a different name than the ones used by ROWaterfall. Otherwise, see modifying effects generated by ROWaterfall.

Modifying effects generated by ROWaterfall

Warning: This is inherently fragile; do so at your own risk.

Modifications to effects (ModuleWaterfallFX or EFFECTS) generated by ROWaterfall can be done in :AFTER[zROWaterfall_99_Finalize] or a later pass. Patches should not be added in passes between zROWaterfall_00 and zROWaterfall_99. These are used internally by ROWaterfall and their behavior could change at any time.

Adding templates to ROWaterfall

By convention, templates provided by ROWaterfall should have names beginning with rowaterfall.

All nozzle glows should have the same default position and size (that is, the visual size and position when position, rotation, and scale are all their default values) as the glows shipped with Waterfall. This is required for glow rescaling to work.

Credit

This mod only applies templates to parts.

• Thanks to Nertea, Zorg, and the rest of the Waterfall team for providing plume templates and sound.
• The files BDB_HTP_vernier.cfg, BDB_HTP_vernierVac.cfg, BDB_nuclear_PBR_vac.cfg, and GeminiWhoop.ogg (thanks to damonvv) are from the Bluedog Design Bureau mod. They are shipped as part of this mod without modification.
• The various rowaterfall-glow- templates are modified from the waterfall-nozzle-glow-*-1 templates shipped with Waterfall, originally made by Zorg.
• The rowaterfall-hypergolic-superdraco template is modified from the waterfall-alcolox-lower-1 template shipped with Waterfall, originally made by Zorg.