This script adds day and night palette transitions. There's already a couple other scripts by Emily that do this, but they each have different methods, one using warps and the other using tint. This one uses 2.55's ability to change DMap palettes and write to palette data, so it won't affect UI and sprites and doesn't require setting up multiple DMaps. Unlike the previous version there is minimal palette setup needed.

In addition there's a couple other utility features included:

• A script to change warps based on the time of day
• A script to trigger secrets based on the time of day
• A script to set the time of day to a desired value
• The time of day can be synced to the system clock for the complete gimmicky Nintendo experience

Update 7/18/23: Fixed a bug where auto tinting was affecting level sprite csets by default.
Update 2/24/26: Fixed compatibility with 3.0 when drawing the timer, fixed a weird palette issue when scrolling, and added new dmap scripts to improve the setup experience.

In addition to the FFC scripts, this script uses a generic script to function, so be sure to assign that to a slot and edit its properties under Quest->Init Data under the GenScript tab. Check Run From Start so it'll run.

Constants:
Set up the following constants as needed:

• DAYNIGHT_USE_SYSTEM_CLOCK: Set to 1 if you want to sync the in-game timer with the system clock.
• DMF_TIME_CAN_ADVANCE: Set to a DMap flag you want to use for DMaps where time can advance. Use the DMF_ constants in std.zh for this.
• DAYNIGHT_STARTING_HOUR: The hour (1-24) the clock starts on.
• PALETTE_UPDATE_FREQ: This controls how frequently the script updates palettes for the current DMap. Lower numbers will mean smoother transitions, but doing this too frequently hurts uncapped framerate.

Time Increment Constants:
These control how fast time advances on the clock. These are unused if you're using the system clock.

• DAYNIGHT_TIME_INCREMENT_FRAMES: How many in-game frames between every clock update
• DAYNIGHT_TIME_INCREMENT_SECONDS: How many seconds to add to the clock on each update
• DAYNIGHT_TIME_INCREMENT_MINUTES: How many minutes to add to the clock on each update
• DAYNIGHT_TIME_INCREMENT_HOURS: How many hours to add to the clock on each update

Subscreen Clock Constants:
These control the digital clock that's drawn to the subscreen.

• DAYNIGHT_DRAW_CLOCK: Set to 1 to draw the clock, 0 to hide it.
• DAYNIGHT_CLOCK_LAYER: What layer to draw the clock to. With modern rulesets, this should be 7.
• DAYNIGHT_CLOCK_X: X position to draw the clock to.
• DAYNIGHT_CLOCK_Y: Y position to draw the clock to. The subscreen is 56 pixels tall, so start from -56.
• DAYNIGHT_CLOCK_PLACES: How many places to show. 0 for hours only, 1 for hours and minutes, 2 for hours, minutes, and seconds.
• DAYNIGHT_CLOCK_HIDE_AM_PM: Whether or not to show AM and PM on the clock. If 0, they'll be shown, if 1 they'll be hidden, and if 2 the display will show as Military Time.
• FONT_DAYNIGHT_CLOCK: The font to draw the clock in. Use FONT_ constants from std.zh.
• C_DAYNIGHT_CLOCK: The color to draw the clock in.
• C_DAYNIGHT_CLOCK_SHADOW: The color for the clock's shadow, if applicable.
• SHD_DAYNIGHT_CLOCK_SHADOWTYPE: The type of shadow, if applicable. Use the SHD_ constants from std.zh.

Setting up time of day palettes:
There's two ways to set up time of day palettes. The first is to edit the DayNightGeneric_UserInit() function in the script. There's a set of functions in the comments that you can call to assign palettes to each of your DMaps. If you're not comfortable editing ZScript, you can use the DayNight_ConfigureDMap or DayNight_ConfigureDMapAutoColor scripts. Place these on a screen the player is guaranteed to cross through. In order for time to advance on a DMap, the DMap flag set by DMF_TIME_CAN_ADVANCE must be checked.

All FFC scripts have metadata so they'll be documented in the editor.

This script only requires std.zh.