Wingworks

<h1>Wingworks</h1> <p>Wingworks is a flight mechanics library that introduces flapping mechanics for players who possess the trait "ww_can_fly" and "canGlide" as well as animation support for flight actions. Gliding and flying will consume additional hunger as a way to balance the mod somewhat.</p> <p>The model featured in the video is from the mod <a title="KC's Dragon Player" href="https://mods.vintagestory.at/kcsdragons" target="_blank" rel="noopener">KCs Dragon Player</a></p> <p>If you are a developer looking to add wingworks support for your mod see <a title="Wingworks Tutorial" href="https://github.com/Drathonix/wingworks-vs/wiki/How-To-Add-Wingworks-Support-for-a-Model" target="_blank" rel="noopener">this tutorial</a></p> <h2>Dependencies</h2> <p>This mod depends on <a title="Glider Revamp Fork" href="https://mods.vintagestory.at/gliderrevampdrathon" target="_blank" rel="noopener">Glider Revamp (Drathon's Fork)</a> and has optional <a title="ConfigLib" href="https://mods.vintagestory.at/configlib" target="_blank" rel="noopener">ConfigLib</a> support (you cannot configure the mod without configlib as of now, yes I am aware of the controversy and am considering solutions)</p> <h3>Mods With Wingworks Integration:</h3> <ul> <li><a title="KC's Dragon Player" href="https://mods.vintagestory.at/kcsdragons" target="_blank" rel="noopener">KCs Dragon Player</a></li> <li><a title="KCs Synth Player" href="https://mods.vintagestory.at/kcssynths" target="_blank" rel="noopener">KCs Synth Player</a></li> <li><a title="Animalica Compatibility Pack 1" href="https://mods.vintagestory.at/show/mod/56778">Animalica Compatibility Pack 1</a>&nbsp;<a href="https://mods.vintagestory.at/show/mod/48465">(Only with critter pack so far)</a></li> </ul> <h2>Controls</h2> <p><strong>Flapping:&nbsp;</strong>press the jump button while gliding to flap wings and gain speed at the cost of hunger.</p> <p><strong>Diving:</strong> aim down at the ground to enter a dive animation and gain speed.</p> <p><strong>Braking: </strong>press the backwards button to slow down.</p> <h2>Traits</h2> <p>The mod provides "ww-flight" as a trait with the default settings for anyone who doesn't want to customize the player's flight stats.</p> <h3>Commands</h3> <p>Server Admin:</p> <pre>"/wingworks modifyflightability &lt;player&gt; &lt;optional number value&gt;" - forcefully disables or enables wingworks flight for a specific player regardless of model restrictions. Use -1000 to disable and 1000 to enable or 0 to use default behavior.<br /><br />## Stats<br /><br />Most of these stats override some value within the mod config, use them to buff or debuff traits for fliers. <br />

1. "ww_can_fly" (0 or 1): Grants the ability to flap wings. This is
2. "ww_flap_hunger" [-1-infinity]: The hunger drained per flap. -1 to disable
3. "ww_flight_hunger" [-1-infinity]: The hunger drained per second flying. -1 to disable.
4. "ww_flap_vertical_acceleration" [0-infinity]: Vertical acceleration per flap. Applied over 21 animation frames. Default: 4
5. "ww_flap_forward_acceleration" [0-infinity]: Forward acceleration. Applied over 21 animation frames. Default 4/19
6. "ww_pitch_hunger_multiplier" [0.0-infinity]: Multiplies the hunger consumed when the player flaps while aiming up. <br /><span style="text-decoration: line-through;">7. "ww_pitch_vertical_multiplier" [0.0-infinity]: Multiplies the vertical acceleration granted when the player flaps while aiming up. (these help you gain fight gravity at a significant cost)</span> <strong>Removed for the time being</strong><br /><span style="text-decoration: line-through;">8. "ww_pitch_forward_multiplier" [0.0-infinity]: Multiplies forward acceleration granted when the player flaps while aiming up.</span> <strong>Removed for the time being</strong><br />9. "ww_top_speed" [0.0-infinity]: The top speed the player can reach while flying in any direction.
7. "ww_start_speed" [-2-infinity]: The minimum required speed to start flight. Keep above stall speed. Set to -2 to disable. (Higher speeds require falling further distances to start, lower allows lift off without a falling start)
8. "ww_stall_speed" [-2-infinity]: The minimum required speed to maintain flight. Set to -2 to disable. (Mechanic introduced by glider revamp that doesn't really fit in for natural fliers honestly)
9. "ww_climb_coefficient" [0.0-infinity]: The amount of speed lost per meter of height gained.
10. "ww_turn_rate" [0.0-infinity]: The degrees per second you can turn.
11. "ww_drag_coefficient" [0.0-1.0]: %Speed lost to drag.<br />15. "ww_flap_min_speed" [0-infinity]: Minimum speed where a multiplier should be applied to increase initial flight speed.<br /><span class="cm-m-markdown cm-variable-2">16. "ww_wetness_debuff" </span><span class="cm-m-markdown cm-link cm-variable-2">[0.0-1.0]</span><span class="cm-m-markdown cm-variable-2">: How much the player's wetness level should debuff flight. For reference the player's wetness ranges between 0-1. If this trait was set to 0.5 and their wetness was 1 they would find flapping to be half as effective as normal. This also causes a small amount of additional drag</span><br /><br />### Animations<br /><br />I'm listing unimplemented code animations in case someone wants to add them in the future, it will definitely incentivise me to add these animations codewise if someone handles the actual animating part.

1. ww_flap: called when the player is gliding and presses the jump button off cooldown.
2. ww_dive: called when the player aims towards the direction of gravity.
3. ww_dive_flap (NOT YET IMPLEMENTED CODEWISE): called while in a dive and the jump button.
4. ww_ascend (NOT YET IMPLEMENTED CODEWISE): called while the player aims against from the direction of gravity.
5. ww_ascend_flap (NOT YET IMPLEMENTED CODEWISE): called while ascending and the jump button is pressed.
6. ww_brake: called when the player presses the backwards key in flight.

Plans

There are plans to improve this mod in the