Hammy - Window Shadows

じ☆ve冰风

Hammy - Window Shadows v1.04
Add depth and visual polish to your game's UI with customizable window shadows​

---

Introduction

This script provides a customizable shadow system for all windows in RPG Maker VX Ace. It automatically adds shadows behind windows to create depth and visual polish in your game's user interface.

AI Disclaimer: Generative AI was used to refine the documentation and presentation of this script, as I am not a native English speaker. Additionally, AI was used to optimize the explicit z-index initialization part of the code, for naming conventions in some places and for general beautification of the script.

---

Features

Core Shadow Features

• Automatic shadow creation for all windows
  
• Runtime shadow enable/disable via Game_System integration
  
• Window exclusion system for selective shadow application
  
• Explicit z-index management for proper shadow layering
  

Customization System

• Per-window-class shadow configuration with custom graphics and settings
  
• Per-window-type shadow configuration via FF9 Windowskin System integration
  
• Configurable shadow offsets (horizontal and vertical positioning)
  
• Shadow opacity scaling based on parent window transparency
  

Technical Features

• Automatic shadow property updates (position, size, openness, visibility)
  
• Dynamic shadow recreation when system is re-enabled
  
• Proper shadow disposal and cleanup on window termination
  

---

Screenshots

---

Script Calls

The following script calls are available for use in events and other scripts.

Shadow System Control

$game_system.window_shadows = true
Enables the window shadow system globally. All windows will display their configured shadows.

$game_system.window_shadows = false
Disables the window shadow system globally. All window shadows will be hidden and disposed.

Examples
                Ruby:       

1. # Enable window shadows globally
2. $game_system.window_shadows = true
4. # Disable window shadows globally
5. $game_system.window_shadows = false

复制代码

---

Usage

This section explains how to prepare windowskin graphics for use as shadows.

Shadow Windowskin Preparation
Shadow windowskins are modified versions of standard RPG Maker VX Ace windowskin files. Windowskins are 128x128 pixels in size.

• Step 1: Start with your standard windowskin file (128x128 pixels)
  
• Step 2: Keep only the upper-right quadrant (x: 64-128, y: 0-64)
  
• This section contains the window border graphics. Everything else should be removed or made transparent.
  
• Step 3: Remove the top and left border segments
  
• Delete the upper portion of the window frame. Delete the left portion of the window frame. Delete the scroll arrows. Keep only the bottom and right border segments.
  
• Step 4: The result should show only the lower-right corner and edges
  
• This creates the shadow effect when offset behind the main window.
  
• Step 5: Place your prepared shadow windowskin files in the Graphics/System
  
• Ensure they are referenced properly in the configuration settings.
  

---

Configuration

Edit the constants in the Hammy::WindowShadows module to configure the shadow windowskins, offsets, opacities, exclusions, and custom window mappings.

Default Shadow Settings
Configure the default shadow appearance for all windows in the game. These settings control the shadow windowskin, offsets, and opacity. Set windowskin to nil to disable shadows globally across the game.

DEFAULT_SETTINGS
Hash containing default shadow configuration.

- windowskin: Shadow windowskin filename in Graphics/System folder.
- offset_x: Horizontal shadow offset in pixels (positive = right).
- offset_y: Vertical shadow offset in pixels (positive = down).
- opacity: Shadow opacity value (0-255, where 255 is fully opaque).

- Valid values: Hash with Symbol keys and specific value types
- Default:{ :windowskin => "Window_Shadow", :offset_x => 3, ... }

Example
                Ruby:       

1. DEFAULT_SETTINGS = {
2.   :windowskin => "Window_Shadow",
3.   :offset_x => 3,
4.   :offset_y => 3,
5.   :offset_width => 0,
6.   :offset_height => 0,
7.   :opacity => 120
8. }

复制代码

Excluded Windows
Configure window classes that should not display shadows. Add window class constants to exclude specific windows from the shadow system entirely.

EXCLUDED_WINDOWS
Array of window class constants to exclude.
- Valid values: Array containing Window Class constants
- Default:[Window_BattleLog]

Example
                Ruby:       

1. EXCLUDED_WINDOWS = [Window_BattleLog]

复制代码

Explicit Z-Index Windows
Configure window classes requiring explicit z-index assignment during initialization. Windows without explicit z-values can cause shadows to appear above other parent windows when shadows are re-enabled.

EXPLICIT_Z_WINDOWS
Array of window classes requiring explicit z.

These windows will be assigned z = 200 during initialization.

- Valid values: Array containing Window Class constants
- Default:[Window_ChoiceList]

Example
                Ruby:       

1. EXPLICIT_Z_WINDOWS = [Window_ChoiceList]

复制代码

Window Class Shadow Configuration
Configure custom shadow settings for specific window classes. This allows you to override default shadow appearances for individual window types with per-class customization of graphics and offsets.

WINDOWSKIN_MAP
Hash mapping window class names to custom settings.

- Format: "ClassName" => { :windowskin => "Name", :offset_x => x, :offset_y => y, :opacity => o }

- Valid values: Hash with String keys and Hash values
- Default:{ "Window_MenuCommand" => {...}, "Window_Gold" => {...} }

Example
                Ruby:       

1. WINDOWSKIN_MAP = {
2.    "Window_MenuCommand" => {
3.      :windowskin => "Window_Shadow_Red",
4.      :offset_x => 3,
5.      :offset_y => 3,
6.      :offset_width => 0,
7.      :offset_height => 0,
8.      :opacity => 80
9.    },
10.   "Window_Gold" => {
11.     :windowskin => "Window_Shadow",
12.     :offset_x => 0,
13.     :offset_y => 0,
14.     :offset_width => 3,
15.     :offset_height => 3,
16.     :opacity => 80
17.   },
18. }

复制代码

Window Type Shadow Map
Configure custom shadow settings for window types when using the Hammy FF9 Windowskin System. This allows shadows to automatically match the visual style of window types defined in the system.

WINDOW_TYPE_MAP
Hash mapping window types to custom shadow settings.

- Format: :window_type => { :windowskin => "Name", :offset_x => x, :offset_y => y, :opacity => o }
- Available types: :default, :frame, :topbar, :help

- Valid values: Hash with Symbol keys and Hash values
- Default:{ :default => { ... }, :frame => { ... }, ... }

Example
                Ruby:       

1. WINDOW_TYPE_MAP = {
2.   :default => {
3.     :windowskin => "Window_Shadow_Default",
4.     :offset_x => 2,
5.     :offset_y => 2,
6.     :offset_width => 0,
7.     :offset_height => 0,
8.     :opacity => 120
9.   },
10.   :frame => {
11.     :windowskin => "Window_Shadow_Frame",
12.     :offset_x => 2,
13.     :offset_y => 2,
14.     :offset_width => 0,
15.     :offset_height => 0,
16.     :opacity => 120
17.   },
18.   :topbar => {
19.     :windowskin => "Window_Shadow_Topbar",
20.     :offset_x => 2,
21.     :offset_y => 2,
22.     :offset_width => 0,
23.     :offset_height => 0,
24.     :opacity => 120
25.   },
26.   :help => {
27.     :windowskin => "Window_Shadow_Default",
28.     :offset_x => 2,
29.     :offset_y => 2,
30.     :offset_width => 0,
31.     :offset_height => 0,
32.     :opacity => 120
33.   },
34. }

复制代码

---

Installation

• Copy the script to an open slot below ▼ Materials but above ▼ Main
  
• If using Hammy FF9 Windowskin System, place this script BELOW the Windowskin System script
  
• Ensure your shadow windowskin graphics are saved in Graphics/System with the names defined in the configuration
  

---

Compatibility

This script is made strictly for RPG Maker VX Ace. It is highly unlikely that it will run with RPG Maker VX without adjusting.

---

License

MIT License - Free for commercial and non-commercial use.

---

Credits

No credits are required.

---

Why VX Ace?

You might wonder why I'm still making scripts for VX Ace instead of MV/MZ. The answer is simple: Ruby is pure beauty, while JavaScript is a terrible language. Ruby's elegant syntax, intuitive design, and expressive power make scripting a joy. JavaScript, on the other hand, is a chaotic mess of inconsistencies and quirks that I simply despise.

I work with RPG Maker VX Ace for my own game project, and I share the scripts I create with the community. If you're still using VX Ace, you're in good company!

---

Download

Script:Download from GitHub
Demo:Download from GitHub

---

YEA System Options Addon

This addon extends Yanfly's System Options script to include window shadow enable/disable functionality directly in the system options menu. Players can toggle window shadows on and off without using script calls.

Features:

• Window shadows toggle command in System Options menu
  
• Automatic detection of Global System Option script presence
  
• Configurable command insertion position via anchor system
  

Requirements:

• Hammy Window Shadows v1.00 or higher
  
• Yanfly System Options v1.00
  
• Optional: Theolized Global System Option v1.00
  

Installation: Place this addon script BELOW both YEA-SystemOptions and the Window Shadows System.

Download:Download from GitHub

Spoiler: Addon Code

                Ruby:       

1. # encoding: utf-8
2. #==============================================================================
3. # ▼ Hammy - Window Shadows - YEA System Options Addon v1.01
4. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
5. # -- Last Updated: 25.05.2026
6. # -- Requires: Hammy Window Shadows v1.01+,
7. #              YEA-SystemOptions v1.00
8. # -- Optional: Theolized - Global System Option v1.00
9. # -- Recommended: None
10. # -- Credits: Yanfly (YEA-SystemOptions),
11. #             Theo Allen (Global System Option)
12. # -- License: MIT License
13. #==============================================================================
15. $imported ||= {}
16. $imported[:hammy_window_shadows_system_options] = true
18. #==============================================================================
19. # ▼ Updates
20. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21. # 25.05.2026 - (v1.01) Applied new documentation conventions.
22. #              Migrated configuration modules to Hammy::PascalCase naming.
23. #
24. # 23.10.2025 - (v1.00) Initial release.
25. #
26. #==============================================================================
27. # ▼ Introduction
28. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
29. # This addon extends the Yanfly System Options script to include window shadow
30. # enable/disable functionality for the Hammy Window Shadows System. It
31. # provides seamless integration with the system options menu, allowing players
32. # to toggle window shadows directly from the game's options screen.
33. #
34. # The addon automatically detects whether Theo's Global System Option script is
35. # present and adapts its save behavior accordingly, supporting both standard
36. # save file storage and global options storage.
37. #
38. # -----------------------------------------------------------------------------
39. # ► Core Integration Features
40. # -----------------------------------------------------------------------------
41. # ★ Window shadows toggle command in System Options menu
42. # ★ Automatic detection of Global System Option script presence
43. # ★ Configurable command insertion position via anchor system
44. #
45. #==============================================================================
46. # ▼ Base Classes & Method Modifications
47. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
48. # This script modifies the following RGSS3 base classes:
49. #
50. # -----------------------------------------------------------------------------
51. # ► Game_System (Class)
52. # -----------------------------------------------------------------------------
53. # ★ Added Getters/Setters:
54. #   - window_shadows
55. #   - window_shadows=
56. #
57. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
58. # This script modifies the following 3rd party classes:
59. #
60. # -----------------------------------------------------------------------------
61. # ► OptionData (Class)
62. # -----------------------------------------------------------------------------
63. # ★ Public Instance Variables:
64. #   - window_shadows (attr_accessor)
65. #
66. # ★ Alias Methods:
67. #   - initialize → window_shadows_optiondata_initialize
68. #
69. # -----------------------------------------------------------------------------
70. # ► Window_SystemOptions (Class < Window_Command)
71. # -----------------------------------------------------------------------------
72. # ★ Alias Methods:
73. #   - draw_item → window_shadows_win_sysopt_draw_item
74. #   - cursor_change → window_shadows_win_sysopt_cursor_change
75. #   - make_command_list → window_shadows_win_sysopt_make_comm_list
76. #
77. #==============================================================================
78. # ▼ Instructions
79. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
80. # To install this script, open up your script editor and copy/paste this script
81. # to an open slot below ▼ Materials/素材 but above ▼ Main. Remember to save.
82. #
83. # ★ This script requires Yanfly - YEA-SystemOptions and Hammy - Window Shadows
84. #   and must be placed BELOW them.
85. #
86. # ★ If using Theolized Global System Option v1.0, window shadow preferences
87. #   will be saved globally across all save files.
88. #
89. #==============================================================================
90. # ▼ Compatibility
91. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
92. # This script is made strictly for RPG Maker VX Ace. It is highly unlikely that
93. # it will run with RPG Maker VX without adjusting.
94. #
95. #==============================================================================
97. #==============================================================================
98. # ** Window Shadows Configuration
99. #------------------------------------------------------------------------------
100. #  Configuration settings for the Window Shadows system.
101. #==============================================================================
103. module Hammy
104.   module WindowShadows
105.    
106.     #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
107.     # - System Options Anchor -
108.     #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
109.     # Configure the insertion position for the window shadows command in the
110.     # System Options menu. The command will be inserted after the specified
111.     # anchor command.
112.     #
113.     # WINDOW_SHADOWS_INSERT_ANCHOR: Symbol of the anchor command.
114.     #   - Valid values: Symbol representing a command in System Options
115.     #   - Default: :window_blu
116.     #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
117.     WINDOW_SHADOWS_INSERT_ANCHOR = :window_blu
118.    
119.     #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
120.     # - Command Vocabulary -
121.     #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
122.     # Configure the display text and help information for the window shadows
123.     # toggle command in the System Options menu.
124.     #
125.     # WINDOW_SHADOWS_VOCAB: Hash containing command text and help description.
126.     #   [0] = Command name, [1] = Off text, [2] = On text, [3] = Help text
127.     #   - Valid values: Hash with Symbol key and Array of Strings
128.     #   - Default: { :window_shadows => [...] }
129.     #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
130.     WINDOW_SHADOWS_VOCAB = {
131.       :window_shadows => ["Window Shadows", "Off", "On",
132.                           "Enable or disable window shadows.\n" \
133.                           "Shadows add visual depth to windows."
134.                          ]
135.     }
136.    
137.     #==========================================================================
138.     # ▼ End of Documentation
139.     #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
140.     # This marks the end of the documentation and configuration section.
141.     # Everything below this point is the actual script implementation code.
142.     #
143.     # WARNING: Modifying the code below requires advanced Ruby and RGSS3
144.     # knowledge. Improper changes may cause script errors, game crashes, or
145.     # data corruption. Only edit if you understand the consequences and have
146.     # backups of your project.
147.     #==========================================================================
148.    
149.     #--------------------------------------------------------------------------
150.     # * Merge Window Shadows Vocabulary                                [Custom]
151.     #--------------------------------------------------------------------------
152.     if $imported["YEA-SystemOptions"]
153.       YEA::SYSTEM::COMMAND_VOCAB.merge!(WINDOW_SHADOWS_VOCAB)
154.     end
155.    
156.   end # Hammy::WindowShadows
157. end # Hammy
159. #==============================================================================
160. # ▼ Script Dependencies Check
161. #-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
162. # This section checks for the presence of required companion scripts.
163. # If any required scripts are missing, it displays an error message and exits.
164. #==============================================================================
166. unless $imported["YEA-SystemOptions"]
167.   msgbox("YEA-SystemOptions v1.00 by Yanfly is required but not found!\n" \
168.          "Please install the required script before using " \
169.          "Window Shadows - System Options Addon.")
170.   exit
171. end
173. unless $imported[:hammy_window_shadows]
174.   msgbox("Hammy Window Shadows v1.00 is required but not found!\n" \
175.          "Please install the required script before using " \
176.          "Window Shadows - System Options Addon.")
177.   exit
178. end
180. #==============================================================================
181. # ** OptionData
182. #------------------------------------------------------------------------------
183. #  This class handles global system option data. It saves option preferences
184. # globally across all save files when using Theo's Global System Option.
185. #==============================================================================
187. if $imported[:Theo_GlobalOption]
188.   class OptionData
189.     #--------------------------------------------------------------------------
190.     # * Public Instance Variables                                      [Custom]
191.     #--------------------------------------------------------------------------
192.     attr_accessor :window_shadows
193.    
194.     #--------------------------------------------------------------------------
195.     # * Alias Method Definitions                                       [Custom]
196.     #--------------------------------------------------------------------------
197.     alias_method :window_shadows_optiondata_initialize, :initialize
198.    
199.     #--------------------------------------------------------------------------
200.     # * Object Initialization                                           [Alias]
201.     #--------------------------------------------------------------------------
202.     def initialize
203.       window_shadows_optiondata_initialize
204.       @window_shadows = true
205.     end
206.    
207.   end # OptionData
208. end # if $imported[:Theo_GlobalOption]
210. #==============================================================================
211. # ** Game_System
212. #------------------------------------------------------------------------------
213. #  This class handles system data. It saves the disable state of saving and
214. # menus. Instances of this class are referenced by $game_system.
215. #==============================================================================
217. class Game_System
218.   #--------------------------------------------------------------------------
219.   # * Get Window Shadows Setting                                     [Custom]
220.   #--------------------------------------------------------------------------
221.   def window_shadows
222.     if $imported[:Theo_GlobalOption]
223.       return $option_data.window_shadows
224.     else
225.       return @window_shadows
226.     end
227.   end
228.   
229.   #--------------------------------------------------------------------------
230.   # * Set Window Shadows Setting                                    [Custom]
231.   #--------------------------------------------------------------------------
232.   def window_shadows=(value)
233.     if $imported[:Theo_GlobalOption]
234.       $option_data.window_shadows = value
235.       OptionData.save
236.     else
237.       @window_shadows = value
238.     end
239.   end
240.   
241. end # Game_System
243. #==============================================================================
244. # ** Window_SystemOptions
245. #------------------------------------------------------------------------------
246. #  This window displays system options on the options screen.
247. #==============================================================================
249. class Window_SystemOptions < Window_Command
250.   #--------------------------------------------------------------------------
251.   # * Alias Method Definitions                                       [Custom]
252.   #--------------------------------------------------------------------------
253.   alias_method :window_shadows_win_sysopt_draw_item, :draw_item
254.   alias_method :window_shadows_win_sysopt_cursor_change, :cursor_change
255.   alias_method :window_shadows_win_sysopt_make_comm_list, :make_command_list
256.   
257.   #--------------------------------------------------------------------------
258.   # * Create Command List                                             [Alias]
259.   #--------------------------------------------------------------------------
260.   def make_command_list
261.     window_shadows_win_sysopt_make_comm_list
262.     inject_window_shadows_command
263.   end
264.   
265.   #--------------------------------------------------------------------------
266.   # * Inject Window Shadows Command                                  [Custom]
267.   #--------------------------------------------------------------------------
268.   def inject_window_shadows_command
269.     anchor_index = @list.find_index { |item|
270.       item[:symbol] == Hammy::WindowShadows::WINDOW_SHADOWS_INSERT_ANCHOR
271.     }
272.    
273.     if anchor_index
274.       insert_index = anchor_index + 1
275.     else
276.       insert_index = @list.size
277.     end
278.    
279.     vocab = YEA::SYSTEM::COMMAND_VOCAB
280.    
281.     window_shadows_command = {
282.       :name => vocab[:window_shadows][0],
283.       :symbol => :window_shadows,
284.       :enabled => true,
285.       :ext => nil
286.     }
287.    
288.     @list.insert(insert_index, window_shadows_command)
289.     @help_descriptions[:window_shadows] = vocab[:window_shadows][3]
290.   end
291.   
292.   #--------------------------------------------------------------------------
293.   # * Draw Item                                                       [Alias]
294.   #--------------------------------------------------------------------------
295.   def draw_item(index)
296.     if @list[index][:symbol] == :window_shadows
297.       reset_font_settings
298.       rect = item_rect(index)
299.       contents.clear_rect(rect)
300.       draw_window_shadows_toggle(rect, index, @list[index][:symbol])
301.     else
302.       window_shadows_win_sysopt_draw_item(index)
303.     end
304.   end
305.   
306.   #--------------------------------------------------------------------------
307.   # * Draw Window Shadows Toggle                                     [Custom]
308.   #--------------------------------------------------------------------------
309.   def draw_window_shadows_toggle(rect, index, symbol)
310.     name = @list[index][:name]
311.     draw_text(0, rect.y, contents.width / 2, line_height, name, 1)
312.    
313.     enabled = $game_system.window_shadows
314.    
315.     dx = contents.width / 2
316.     change_color(normal_color, !enabled)
317.     option1 = YEA::SYSTEM::COMMAND_VOCAB[symbol][1]
318.     draw_text(dx, rect.y, contents.width / 4, line_height, option1, 1)
319.    
320.     dx += contents.width / 4
321.     change_color(normal_color, enabled)
322.     option2 = YEA::SYSTEM::COMMAND_VOCAB[symbol][2]
323.     draw_text(dx, rect.y, contents.width / 4, line_height, option2, 1)
324.   end
325.   
326.   #--------------------------------------------------------------------------
327.   # * Process Cursor Move                                             [Alias]
328.   #--------------------------------------------------------------------------
329.   def cursor_change(direction)
330.     if current_symbol == :window_shadows
331.       change_window_shadows_toggle(direction)
332.     else
333.       window_shadows_win_sysopt_cursor_change(direction)
334.     end
335.   end
336.   
337.   #--------------------------------------------------------------------------
338.   # * Change Window Shadows Toggle                                   [Custom]
339.   #--------------------------------------------------------------------------
340.   def change_window_shadows_toggle(direction)
341.     value = direction == :left ? false : true
342.     current_case = $game_system.window_shadows
343.    
344.     $game_system.window_shadows = value
345.    
346.     Sound.play_cursor if value != current_case
347.     draw_item(index)
348.   end
349.   
350. end # Window_SystemOptions
352. #==============================================================================
353. #
354. # ▼ End of File
355. #
356. #==============================================================================

复制代码

---

本贴来自国际rpgmaker官方论坛作者:buddysievers处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/hammy-window-shadows.180665/