smalltime

KO | EN

gitlite — search

#python #deep-learning #swift #ios #cli #game #c-sharp #css #javascript #android #wordpress-plugin #crawler

★ 35 Open GitHub ↗

A small FoundryVTT module for displaying and controlling the current time of day.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SmallTime

_A small module for displaying and controlling the current time of day._

## Quick Summary

- Drag the sun/moon or click the forward/back buttons to change the time.
- Shift-click the buttons to double the amount. Alt for half.
- Bottom of the window is a repositioning drag handle.
- Button steps and various other things are changeable in the settings.
- Shift-click the moon to cycle the moon's phase (if it's not already being synced from a calendar source).
- Toggle show/hide button is in the Journal Notes tool group.
- Darkness link toggle and Player visibility controls are in Scene Config.
- Date display uses the core Foundry calendar API (and will pick up calendar data automatically from your game system or module calendar).
- Click the time to hide/show the date.
- Click the date to open an available calendar UI (Calendaria or PF2e World Clock).
- Shift-click the time to toggle the realtime clock, if provided and enabled by a module.

Video overview: (somewhat out of date now, but it covers the main bits :) [https://www.youtube.com/watch?v=XShiobMvatE](https://www.youtube.com/watch?v=XShiobMvatE)

### How to Use

There's a show/hide toggle in the Journal Notes tool group:

![Toggle Control](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Toggle_Control.png)

Use the forward/back buttons to change the time, or drag the sun/moon icon (non-GM users will not have these controls):

![Basic Operation](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Basic_Operation.gif)

You can position the window anywhere you like with the drag handle at the bottom, or pin it just above the Players list:

![Placement](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Placement.gif)

For each scene, you can choose how much of the display can be seen by Players, and whether or not to link the time to the scene's Darkness Level:

![Scene_Config](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Scene_Config.webp)
![Darkness_Link](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Darkness_Link.gif)

SmallTime uses Foundry's core calendar API for date display, and can pick up additional date/time/calendar data supplied by game systems or modules. Clicking the time toggles the date tray. Clicking the date opens the most relevant available calendar UI (for example, Calendaria's calendar view, or PF2e's World Clock).

![About_Time_Integration](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/About_Time_Integration.gif)

If a game system or module provides sunrise/sunset values through the core calendar ecosystem, SmallTime can sync to those values (with a setting to disable syncing and use manual rise/set positions instead). While synced, the rise/set controls remain available for darkness shape tuning (vertical movement), but their time positions are locked to the provider.

### Settings

There are a number of settings you can change:

![Settings](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Settings.webp)

...including custom sunrise/sunset times, and global maximum & minimum darkness levels:

![Darkness Config](https://raw.githubusercontent.com/unsoluble/smalltime/main/doc/Darkness_Config.gif)

### Languages

Full support for:

- English
- Japanese (thanks @BrotherSharp!)
- German (thanks @kdomke!)
- Spanish (thanks @masr!)
- Korean (thanks @jbblily!)
- French (thanks @DarKDinDoN!)
- Portuguese (Brazil) (thanks @Castanho!)
- Chinese (thanks @LiyuNodream!)
- Chinese/Taiwan (thanks @zeteticl!)
- Italian (thanks @bertolinimarco!)
- Polish (thanks @Lioheart!)
- Czech (thanks... someone who DM'd it to me and I've forgotten, sorry!)

I'm happy to accept and implement more translations!

### Need Help?

If something's not working right, or you've got other questions or comments, feel free to hit me up on the [Discord](https://discord.gg/foundryvtt) (@unsoluble#5084), or file a [ticket](https://github.com/unsoluble/smalltime/issues).

smalltime

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README