Skip to content

chore: rename weather editor to CS editor #2449

Merged
SkrubbySkrubInAShrub merged 4 commits into
community-shaders:devfrom
Dlizzio:cs-editor
Jun 1, 2026
Merged

chore: rename weather editor to CS editor #2449
SkrubbySkrubInAShrub merged 4 commits into
community-shaders:devfrom
Dlizzio:cs-editor

Conversation

@Dlizzio
Copy link
Copy Markdown
Contributor

@Dlizzio Dlizzio commented Jun 1, 2026

Summary by CodeRabbit

  • Refactor
    • Rebranded the Weather Editor to "CS Editor" across the UI, menus, hotkeys, and editor-related labels.
  • Documentation
    • Updated weather variable registration docs to reference the CS Editor UI toggle and corrected the example settings filename to WeatherFormEditorID_FormID.json.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 1, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4f914923-2da6-4078-bec9-ceb0e319f7bf

📥 Commits

Reviewing files that changed from the base of the PR and between c43ee3c and 30fa341.

📒 Files selected for processing (1)
  • features/CS Editor/Shaders/Features/CSEditor.ini
✅ Files skipped from review due to trivial changes (1)
  • features/CS Editor/Shaders/Features/CSEditor.ini

📝 Walkthrough

Walkthrough

This PR renames WeatherEditor to CSEditor across code, menus, blur control, global registration, editor window wiring, dependent features, and documentation while preserving existing behavior.

Changes

CSEditor Feature Branding Migration

Layer / File(s) Summary
CSEditor Feature Definition and Core Logic
src/Features/CSEditor.h, src/Features/CSEditor.cpp, src/CSEditor/InteriorOnlyPanel.h
Feature struct renamed from WeatherEditor to CSEditor, singleton and ID strings updated; all weather-selection, interpolation, UI rendering (time controls, picker, status), data-loading, and info-display helpers moved/re-homed to CSEditor.
Global Feature Registration and Wiring
src/Globals.h, src/Globals.cpp, src/Feature.cpp, src/Deferred.cpp, src/State.cpp
Forward declarations, global extern/instance and feature list updated to register csEditor instead of weatherEditor; state gating and includes switched to the new type.
Menu System Hotkey and Settings Integration
src/Menu.h, src/Menu.cpp, src/Menu/SettingsTabRenderer.h, src/Menu/SettingsTabRenderer.cpp, src/Menu/HomePageRenderer.cpp
Hotkey/config migration from WeatherEditorToggleKeyCSEditorToggleKey, hotkey capture/serialization/migration updated, input swallowing and toggle action wired to CSEditor::ToggleEditorWindow(), and weather-details window delegated to csEditor.
Background Blur Active State Control
src/Menu/BackgroundBlur.h, src/Menu/BackgroundBlur.cpp
Public API changed from SetWeatherEditorActive/IsWeatherEditorActive to SetCSEditorActive/IsCSEditorActive; module-local flag and shader/window constants updated, blur fast-path guarded by csEditorActive.
Editor Window UI and Blur Integration
src/CSEditor/EditorWindow.cpp
EditorWindow include and calls updated to CSEditor; browser title, category labels, help menu, preview hotkey derivation, and close tooltip changed to CS Editor; background blur calls switched to new API.
Supporting Feature and UI Integrations
src/Features/InverseSquareLighting.cpp, src/Features/WetnessEffects.cpp, src/Menu/OverlayRenderer.cpp, src/Utils/UI.cpp
Includes updated to CSEditor headers; WetnessEffects wired to csEditor; overlay and weather-override tooltips updated to reference CS Editor.
Documentation
docs/weather-system-docs/WeatherVariableRegistration.md
Docs updated to indicate variable toggle UI appears in CS Editor and example filename corrected to WeatherFormEditorID_FormID.json.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • alandtse
  • davo0411

Poem

🐇 I hopped through code to change a name,
From Weather to CS — the editor's fame.
Hotkeys, blur, and docs align,
Shader keys and menus shine.
Hooray — the rabbit stamps the commit with a game!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 11.84% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main objective: systematically renaming the Weather Editor feature to CS Editor across documentation, headers, implementations, and UI components.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 1, 2026

Actionable Suggestions

  • Weather Editor (Dlizzio): Needs version bump to 2-0-2

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/Menu.cpp (1)

345-366: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Preserve existing WeatherEditorToggleKey configs during the rename.

This load path only reads CSEditorToggleKey, so upgraded installs with a saved WeatherEditorToggleKey will silently fall back to the default binding and lose their custom editor hotkey.

Proposed fix
 	migrateKey(o_json, "ToggleKey", settings.ToggleKey);
 	migrateKey(o_json, "SkipCompilationKey", settings.SkipCompilationKey);
 	migrateKey(o_json, "EffectToggleKey", settings.EffectToggleKey);
 	migrateKey(o_json, "OverlayToggleKey", settings.OverlayToggleKey);
 	migrateKey(o_json, "ShaderBlockPrevKey", settings.ShaderBlockPrevKey);
 	migrateKey(o_json, "ShaderBlockNextKey", settings.ShaderBlockNextKey);
+	if (!o_json.contains("CSEditorToggleKey") && o_json.contains("WeatherEditorToggleKey")) {
+		o_json["CSEditorToggleKey"] = o_json["WeatherEditorToggleKey"];
+	}
 	migrateKey(o_json, "CSEditorToggleKey", settings.CSEditorToggleKey);
 	migrateKey(o_json, "ScreenshotKey", settings.ScreenshotKey);
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/Menu.cpp` around lines 345 - 366, The code only loads "CSEditorToggleKey"
into settings.CSEditorToggleKey, so existing installs that still have
"WeatherEditorToggleKey" will be ignored; update the load path (e.g. inside or
alongside loadComboList usage for "CSEditorToggleKey") to also check for
"WeatherEditorToggleKey" and, if present, deserialize it into the same target
(settings.CSEditorToggleKey) or call migrateKey("WeatherEditorToggleKey",
settings.CSEditorToggleKey) before/if loading "CSEditorToggleKey" so
user-configured WeatherEditorToggleKey bindings are preserved when renaming;
keep existing try/catch logging behavior from loadComboList.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@src/Menu.cpp`:
- Around line 345-366: The code only loads "CSEditorToggleKey" into
settings.CSEditorToggleKey, so existing installs that still have
"WeatherEditorToggleKey" will be ignored; update the load path (e.g. inside or
alongside loadComboList usage for "CSEditorToggleKey") to also check for
"WeatherEditorToggleKey" and, if present, deserialize it into the same target
(settings.CSEditorToggleKey) or call migrateKey("WeatherEditorToggleKey",
settings.CSEditorToggleKey) before/if loading "CSEditorToggleKey" so
user-configured WeatherEditorToggleKey bindings are preserved when renaming;
keep existing try/catch logging behavior from loadComboList.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: bcc644ec-292f-48ba-9eeb-9d61748d5af3

📥 Commits

Reviewing files that changed from the base of the PR and between 6d4d8ad and c43ee3c.

📒 Files selected for processing (50)
  • docs/weather-system-docs/WeatherVariableRegistration.md
  • features/CS Editor/CORE
  • features/CS Editor/Shaders/Features/CSEditor.ini
  • src/CSEditor/EditorWindow.cpp
  • src/CSEditor/EditorWindow.h
  • src/CSEditor/InteriorOnlyPanel.cpp
  • src/CSEditor/InteriorOnlyPanel.h
  • src/CSEditor/LightEditor.cpp
  • src/CSEditor/LightEditor.h
  • src/CSEditor/PaletteWindow.cpp
  • src/CSEditor/PaletteWindow.h
  • src/CSEditor/Weather/CellLightingWidget.cpp
  • src/CSEditor/Weather/CellLightingWidget.h
  • src/CSEditor/Weather/ImageSpaceWidget.cpp
  • src/CSEditor/Weather/ImageSpaceWidget.h
  • src/CSEditor/Weather/LensFlareWidget.cpp
  • src/CSEditor/Weather/LensFlareWidget.h
  • src/CSEditor/Weather/LightingTemplateWidget.cpp
  • src/CSEditor/Weather/LightingTemplateWidget.h
  • src/CSEditor/Weather/PrecipitationWidget.cpp
  • src/CSEditor/Weather/PrecipitationWidget.h
  • src/CSEditor/Weather/ReferenceEffectWidget.cpp
  • src/CSEditor/Weather/ReferenceEffectWidget.h
  • src/CSEditor/Weather/SimpleFormWidget.h
  • src/CSEditor/Weather/VolumetricLightingWidget.cpp
  • src/CSEditor/Weather/VolumetricLightingWidget.h
  • src/CSEditor/Weather/WeatherWidget.cpp
  • src/CSEditor/Weather/WeatherWidget.h
  • src/CSEditor/WeatherUtils.cpp
  • src/CSEditor/WeatherUtils.h
  • src/CSEditor/Widget.cpp
  • src/CSEditor/Widget.h
  • src/Deferred.cpp
  • src/Feature.cpp
  • src/Features/CSEditor.cpp
  • src/Features/CSEditor.h
  • src/Features/InverseSquareLighting.cpp
  • src/Features/WetnessEffects.cpp
  • src/Globals.cpp
  • src/Globals.h
  • src/Menu.cpp
  • src/Menu.h
  • src/Menu/BackgroundBlur.cpp
  • src/Menu/BackgroundBlur.h
  • src/Menu/HomePageRenderer.cpp
  • src/Menu/OverlayRenderer.cpp
  • src/Menu/SettingsTabRenderer.cpp
  • src/Menu/SettingsTabRenderer.h
  • src/State.cpp
  • src/Utils/UI.cpp

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 1, 2026

✅ A pre-release build is available for this PR:
Download

@SkrubbySkrubInAShrub SkrubbySkrubInAShrub merged commit 2e57080 into community-shaders:dev Jun 1, 2026
12 of 13 checks passed
@Dlizzio Dlizzio deleted the cs-editor branch June 3, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants