docs: improve compilation instructions#85
Merged
Conversation
Rework of Readme's instructions to help clarify installation and configuration of requirements to compile Community Shaders.
Collaborator
|
"environment" is spelt wrong, please correct any grammatical mistakes |
Contributor
Author
|
That's what I get for writing this in Notepad without my spellchecker... Spelling mistake corrected, and added suggested re-wording to communicate that any preferred terminal is usable. |
Removed explicit install instructions for Vcpkg in the event changes are made upstream to its installation process.
alandtse
reviewed
Sep 10, 2023
Contributor
Author
|
Thanks for the catch, alan. Fixed! |
alandtse
approved these changes
Sep 10, 2023
alandtse
left a comment
alandtse
left a comment
Contributor
There was a problem hiding this comment.
Seems fine to me. Thanks.
doodlum
added a commit
that referenced
this pull request
Sep 13, 2023
* chore: polish Feature menus (#82) * Some polishing of the Feature menus * style: 🎨 apply clang-format changes --------- Co-authored-by: TheRiverwoodModder <TheRiverwoodModder@users.noreply.github.com> * docs: improve compilation instructions (#85) * Update README.md Rework of Readme's instructions to help clarify installation and configuration of requirements to compile Community Shaders. * Update README.md * Update README.md * Update README.md * Update README.md Removed explicit install instructions for Vcpkg in the event changes are made upstream to its installation process. * Update README.md * feat: add NPC grass collision (#79) * fix: fix bug where collisionCount always 0 It now will remember the last value from the prior frame. * feat: add npc grass collision Allows NPCs to cause grass collisions. This is more costly than the player only version. However, additional settings have been added to tune quality over performance. We should ask testers for good defaults. The commit currently enables NPC collisions by default. We can disable with maxDistance set to 0. * style: 🎨 apply clang-format changes * Some polishing of the Feature menus * style: 🎨 apply clang-format changes * chore: convert to popups in menu --------- Co-authored-by: TheRiverwoodModder <125157333+TheRiverwoodModder@users.noreply.github.com> Co-authored-by: TheRiverwoodModder <TheRiverwoodModder@users.noreply.github.com> * feat: improve ShaderCache (#86) * feat: improve ShaderCache * Add error message when compiler failure detected. Error may be hidden but menu will be in red font to indicate failure state. * Add statistics to compilation message and advanced options, including estimated completion time and data on failures and cache hits. * Add setting to change the Compiler Thread count. This may allow users to avoid crashes and unresponsiveness. * Fix logic to detect failed shaders appropriately and avoid infinite compilation bug. * Fix bug where Shader Defines would not load if loglevel was malformed. closes #71 * fix: fix hashkey to avoid hashing on descriptor Remove descriptor from string generated for hashkeys. On 1.5.97, I see 3.8K worth of hits which may be the permutations discussed here (# 72). * fix: set bLandSpecular to support Terrain Parallax (#88) * refactor: remove redundant state load * fix: set bLandSpecular to support Terrain Parallax bLandSpecular may be disabled by certain mod lists and is necessary for terrain parallax. This will force the setting to true when Terrain Parallax is enabled. * docs: simplify build commands * build: fix subsurface directory structure Auto deploy scripts were broken due to missing Shaders subdirectory in /Features * build: list features for auto deployment * feat: enable VR building for SSS * style: clang format --------- Co-authored-by: doodlum <15017472+doodlum@users.noreply.github.com> Co-authored-by: TheRiverwoodModder <125157333+TheRiverwoodModder@users.noreply.github.com> Co-authored-by: TheRiverwoodModder <TheRiverwoodModder@users.noreply.github.com> Co-authored-by: AceAmir <73254124+AceAmir@users.noreply.github.com> Co-authored-by: Pentalimbed <76898260+Pentalimbed@users.noreply.github.com>
alandtse
referenced
this pull request
in alandtse/open-shaders
Sep 15, 2023
* chore: polish Feature menus (#82) * Some polishing of the Feature menus * style: 🎨 apply clang-format changes --------- Co-authored-by: TheRiverwoodModder <TheRiverwoodModder@users.noreply.github.com> * docs: improve compilation instructions (#85) * Update README.md Rework of Readme's instructions to help clarify installation and configuration of requirements to compile Community Shaders. * Update README.md * Update README.md * Update README.md * Update README.md Removed explicit install instructions for Vcpkg in the event changes are made upstream to its installation process. * Update README.md * feat: add NPC grass collision (#79) * fix: fix bug where collisionCount always 0 It now will remember the last value from the prior frame. * feat: add npc grass collision Allows NPCs to cause grass collisions. This is more costly than the player only version. However, additional settings have been added to tune quality over performance. We should ask testers for good defaults. The commit currently enables NPC collisions by default. We can disable with maxDistance set to 0. * style: 🎨 apply clang-format changes * Some polishing of the Feature menus * style: 🎨 apply clang-format changes * chore: convert to popups in menu --------- Co-authored-by: TheRiverwoodModder <125157333+TheRiverwoodModder@users.noreply.github.com> Co-authored-by: TheRiverwoodModder <TheRiverwoodModder@users.noreply.github.com> * feat: improve ShaderCache (#86) * feat: improve ShaderCache * Add error message when compiler failure detected. Error may be hidden but menu will be in red font to indicate failure state. * Add statistics to compilation message and advanced options, including estimated completion time and data on failures and cache hits. * Add setting to change the Compiler Thread count. This may allow users to avoid crashes and unresponsiveness. * Fix logic to detect failed shaders appropriately and avoid infinite compilation bug. * Fix bug where Shader Defines would not load if loglevel was malformed. closes #71 * fix: fix hashkey to avoid hashing on descriptor Remove descriptor from string generated for hashkeys. On 1.5.97, I see 3.8K worth of hits which may be the permutations discussed here (# 72). * fix: set bLandSpecular to support Terrain Parallax (#88) * refactor: remove redundant state load * fix: set bLandSpecular to support Terrain Parallax bLandSpecular may be disabled by certain mod lists and is necessary for terrain parallax. This will force the setting to true when Terrain Parallax is enabled. * docs: simplify build commands * build: fix subsurface directory structure Auto deploy scripts were broken due to missing Shaders subdirectory in /Features * build: list features for auto deployment * feat: enable VR building for SSS * style: clang format --------- Co-authored-by: doodlum <15017472+doodlum@users.noreply.github.com> Co-authored-by: TheRiverwoodModder <125157333+TheRiverwoodModder@users.noreply.github.com> Co-authored-by: TheRiverwoodModder <TheRiverwoodModder@users.noreply.github.com> Co-authored-by: AceAmir <73254124+AceAmir@users.noreply.github.com> Co-authored-by: Pentalimbed <76898260+Pentalimbed@users.noreply.github.com>
alandtse
referenced
this pull request
in alandtse/open-shaders
Jul 20, 2025
* Update README.md Rework of Readme's instructions to help clarify installation and configuration of requirements to compile Community Shaders. * Update README.md * Update README.md * Update README.md * Update README.md Removed explicit install instructions for Vcpkg in the event changes are made upstream to its installation process. * Update README.md
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Rework of Readme's instructions to help clarify installation and configuration of requirements to compile Community Shaders.