-
Notifications
You must be signed in to change notification settings - Fork 91
SML Docs: Add detailed Panini Projection guide for first-person equipment (cleaned) #402
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
budak7273
merged 7 commits into
satisfactorymodding:Dev
from
Rovetown:panini-projection-tutorial-clean
Dec 7, 2025
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
67e0431
SML Docs: Added Panini Projection section with detailed explanation, …
Rovetown 3553412
Replace non-standard characters
budak7273 9272056
Move all images to subfolder
budak7273 41975d9
Rework to focus on what actions a mod dev needs to take to set up the…
budak7273 dfb778c
Fix wording/typos
budak7273 7e44ad0
Updated based on feedback from @DavidHGillen
budak7273 cf2b6d8
Update custom material screenshots, use StaticSwitchParameter and Col…
budak7273 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -88,6 +88,7 @@ | |
| "paintable", | ||
| "Paks", | ||
| "Panakotta", | ||
| "Panini", | ||
| "passaround", | ||
| "Photoshop", | ||
| "Quixel", | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
modules/ROOT/pages/Development/Modeling/PaniniProjection.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| = First Person Rendering with Panini Projection | ||
|
|
||
| Satisfactory's rendering pipeline utilizes a post processing effect to render the pioneer's arms and equipment correctly. | ||
| Applying this same effect to your modded first person materials (equipment, trinkets, player models) is essential | ||
| to ensure they line up correctly with the player model as end user Field Of View (FOV) settings vary. | ||
| The effect should not be applied modded building and item materials because the game's existing world rendering pipeline already handles it. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The most convenient ways to apply the effect to your mod's content are: | ||
|
|
||
| - Making a material instance from a base-game material that already has supports it | ||
| - Using the relevant material node in your own materials | ||
|
|
||
| == Behind the Scenes | ||
|
|
||
| In Satisfactory, first-person equipment is drawn in a separate render pass | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| to ensure the pioneer's arms and tools don't clip into the environment when you get really close to things. | ||
|
|
||
| To limit visual distortions when the user is playing with a large FOV, | ||
| a post-processing effect called a **Panini Projection** is applied to the world and the player's first person models. | ||
| To learn more, see | ||
| https://dev.epicgames.com/documentation/en-us/unreal-engine/panini-projection-in-unreal-engine?application_version=5.3[the Unreal Engine documentation and its linked resources]. | ||
|
|
||
| The projection's implementation looks the best with an FOV of 90°, | ||
| so Satisfactory always renders the player's first person viewmodels with a fixed 90° FOV. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Note that in game option "First Person FOV Modifier" adjusts the model's scale, not its FOV. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| == In-Game Appearance | ||
|
|
||
| You can tell a material is not set up properly if its position changes noticeably | ||
| when the user adjusts their FOV. | ||
|
|
||
| The below screenshots showcase the appearance of ExampleMod's example trinket at different "Field of View" game option values. | ||
| The left side has the projection enabled, while the right side has it disabled. | ||
|
|
||
| Note that the model does not connect correctly when the projection is disabled at FOVs other than 90°. | ||
|
|
||
| [cols="a,a"] | ||
| |=== | ||
| |✔️ Panini Enabled |❌ Panini Disabled | ||
|
|
||
| | image::Development/3DModeling/Panini/Correct_70.png[title=Enabled (70° FOV)] | ||
| | image::Development/3DModeling/Panini/Incorrect_70.png[title=Disabled (70° FOV)] | ||
|
|
||
| | image::Development/3DModeling/Panini/Correct_90.png[title=Enabled (90° FOV)] | ||
| | image::Development/3DModeling/Panini/Incorrect_90.png[title=Disabled (90° FOV)] | ||
|
|
||
| | image::Development/3DModeling/Panini/Correct_120.png[title=Enabled (120° FOV)] | ||
| | image::Development/3DModeling/Panini/Incorrect_120.png[title=Disabled (120° FOV)] | ||
|
|
||
| | image::Development/3DModeling/Panini/Panini_on.png[title=Modded equipment Enabled (90° FOV)] | ||
| | image::Development/3DModeling/Panini/Panini_off.png[title=Modded equipment Disabled (90° FOV)] | ||
|
|
||
| |=== | ||
|
|
||
| == Reusing Base Game Materials | ||
|
|
||
| A number of base game materials already have Panini Projection support built in. | ||
| You can create material instances from them to easily enable the effect on your modded content | ||
| assuming the materials' other behaviors suit your needs. | ||
| It can be enabled via their material parameters, usually called something like "UsePaniniProjection". | ||
| This is the approach taken by Example Mod's Example Trinket, Desc_Trinket_TvOfKnowledge. | ||
|
|
||
| Examples of base game materials that support Panini Projection include equipment and trinket materials, as well as MM_FactoryBaked. | ||
| For example, trinkets can use the `Asset_Master` material with the "UsePaniniProjection" option enabled. | ||
|
|
||
| == Enabling Panini Projection on Custom Materials | ||
|
|
||
| Panini can be integrated into custom materials in two main ways, depending on whether your material uses Material Attributes. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [id="MF_ApplyPaniniProjection"] | ||
| === 1. Using `MF_ApplyPaniniProjection` (Material Attributes workflow) | ||
|
|
||
| . In your Material settings, enable *Use Material Attributes*. | ||
| . Use `MakeMaterialAttributes` to gather outputs. | ||
| . Add a new `MF_ApplyPaniniProjection` node to the material graph. | ||
| . Feed the result into Apply Panini Projection. | ||
| . Add a `Static Switch` to toggle Panini on/off. | ||
| . Connect the Panini Projection node to the *Static Switch True* input. | ||
| . Connect the result of Make Material Attributes to the *Static Switch False* input. | ||
| . Connect the result to the Material's *Material Attributes* output. | ||
|
|
||
| Use Material Instances to enable toggling the effect per-instance without recompiling the shader. | ||
| This is particularly useful because the models of other players, and 3rd person view models) should not have the effect applied. | ||
|
|
||
| image::Development/3DModeling/Panini/Apply_Panini.png[Apply Panini, title=Apply Panini] | ||
|
|
||
| [id="MF_PaniniProjection"] | ||
| === 2. Using `Panini Projection` directly (non-attributes workflow) | ||
|
|
||
| . Add a new `MF_PaniniProjection` node to the material graph. | ||
| . Connect the parameters: *d* (distance), *s* (squeeze), *Screen Space Scale*, and *WPO*. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| . Add a `Static Switch` to toggle Panini on/off. | ||
| . Feed the result of the Panini Projection into the *Static Switch True* input. | ||
| . Plug a `Texture Coordinate` Node into the *Static Switch False* input. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| . Plug the result into the respective `Texture Sample` *UV* input. | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| . Route the output to your material logic (e.g., Emissive/Color/Roughness, CustomUV). | ||
budak7273 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| image::Development/3DModeling/Panini/Direct_Panini.png[Direct Panini, title=Direct Panini] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.