Main Window
Normal View
Time Warp is being affected by the alarm indicated
Minimized View showing only next alarm
The Command Bar
Across the top of the Main Window you will see the following:
- Orbital Node Recalculation Indicator: when this is on any Orbital Node Alarms that are setup will continually recalculate their alarm time based on the current flight plan;
- Transfer Recalculation Indicator: when this is on any Transfer Alarms that are setup will continually recalculate their alarm time based on the phase angle between the origin and target bodies. This is important as few bodies have exactly circular orbits, and the maths behind the formula driven transfer windows is based on circles – this is not the case for modelled data;
- Auto-Add SOI Indicator: When this is enabled the Alarm Clock will monitor the active vessels flight path to detect any SOI Changes, and create alarms automatically. If you adjust the flight path (and the SOI moves) then the Alarm Clock will adjust the alarm. The tooltip on this Indicator lets you know which parts of the SOI Auto alarms are enabled and what the alarm action will be;
- Minimize/Maxmize Button: Should be self-explanatory, when minimized it will display the next future alarm only;
- Settings Button: Toggles the Settings window, detailed documentation here;
- Add Button: Toggles the Add Alarm window, detailed documentation here. Each time you open the Add Alarm window it resets the values to defaults;
- Quick Add Button: Presents you a drop down menu of context aware alarms to add;
The Alarm List
This portion of the window displays a list of the alarms that have been configured (except in Minimal mode when it only shows the next future alarm).The window has a configured max number of alarms, once this is reached it will stop growing and a scroll bar will appear. Each alarm presents the same details on its row:
- Alarm name: the short text for the alarm. By hovering over this you will see a tooltip that shows the Alarm Message. Also by clicking on this you will open up the Alarm editing window;
- Edit icon: If you have an alarms edit window open you will see a small pencil icon to indicate which alarm is being edited;
- Alarm Action Icon: This displays an indicator for the action this alarm will take. A ‘W’ indicates the alarm will cancel any warp acceleration as you approach the alarm, a ‘P’ indicates the game will slow and then be paused at the time of the alarm. When the alarm is affecting the warp rate of the game the indicator will pulse so you can tell which alarm it is;
- Delete Button: This will delete the associated alarm;
The Footer
Normal Footer
Footer also showing Earth time
This displays the current date in the game universe. Clicking on the date will toggle between the three time formats - UT (raw seconds), KSP formatted dates and standard dates.
"Real World" Alarms
By clicking on the Current Time: text at the bottom you can toggle an extra line of display that will show the current time on your PC. From this line you can then also add an Alarm based on real world time - possibly to remind you its time to take a break :). These alarms will show up in the alarm list as per normal, but obviously will not be affected by time warp.
Note: When the game is paused the real world alarm will not fire until the game is unpaused
Quick Add Menu
Clicking the Plus next to add will give you the option to quickly add, and warp if you want, to a contextually related alarm to the situation you/your vessel are in. Below you can see more details:
Add Alarm Window
Common Elements
This window has some common elements, and then some specifics for each alarm type. The below annotated picture highlights what each is, and the text below describes them:
- Name: Short text – this is shown in the list;
- Action: What to do when the alarm fires;
- Margin: For alarms other than the raw time ones how long before the event (Maneuver Node, SOI Change, Transfer Window, etc) do you want to have the alarm fire;
- Details of Alarm: This section shows you the date of the event (if its event based - like a maneuver), the Time to the event and the tie to the larm after the margin has been applied;
- Show/Hide Detailed Messages: This button toggles the right hand window to display the detailed notes and attached vessel details. The detailed notes are updated on each change of alarm type/target and can then be edited as well;
- Attached Vessel: Exactly what it says :)
- Notes: Details of the alarm – these will show in the tooltips and full message;
- Add Button: Will create this alarm;
Repeating Alarms
For some types of alarms it is possible up to set a repeat value. This means that when the Alarm that is set fires another one will automagically be created like the one that just fired.
Current alarm types that support this are:
- Raw Alarms:Repeats based on a simple repeat period
- Crew Alarms:Repeats based on a simple repeat period
- Modelled Transfer Alarms:These will repeat based on when the next modelled data point for the transfer is to occur
Specific Alarm Types
You will find information on the specific alarm type further down the page
Display/Edit Alarm Window
If you click on the name of an alarm in the list it will open a window with some more details.
Display Alarm
If the alarm fired in the past then you will simply see some details including time, name and message
Edit Alarm
Will display fields to allow you to edit the name, message, alarm action and margin
Common Action Buttons
As well as the close window button you will get a button to Jump to Ship button if the active ship is not the ship the alarm has been attached to
Alarm Fired Window
- This window will display for you the name, message and time details of the alarm that was set up.
- You will also get action buttons where appropriate to jump to another ship, restore a maneuver node or similar where possible.
- Thirdly you have the ability to choose to delete the alarm on close.
Common Elements
This window has some common elements, and then some specifics for each alarm type. The below annotated picture highlights what each is, and you can get the details from the Common Elements section above
You can also find information about the repeat options in that section
Raw Alarms
Allows you to enter some raw time stuff to create an alarm, you can choose to create this as a Date (time from the beginning of the Kerbin Universe) or an Interval (time from now).
You can choose whether to associate this alarm with the active vessel or not.
Maneuver Node
Will look at the next Maneuver Node on the flight path and allow you to create an alarm at this point. When you create this alarm type it will store the Maneuver Node’s details and allow you to restore this back at a later time.
Flight Plan Nodes - Apoapsis/Periapsis
You can choose to add alarms for any of these nodes on the flight plan. Once created the Alarm Clock will monitor the flight path and adjust the alarm time if the Auto-Recalc switch is on (eg. You burn your engines)
Orbit Alignment Nodes - Ascending/Descending Nodes
You can choose to add alarms for orbit alignment points. When a target vessel is selected it will be for the AN/DN between your active vessel and the target vessel. If there is no selected target it will be the AN/DN of the equator of the body you are orbiting.
AN/DN for Target
Equatorial AN/DN
Launch Rendezvous
If the active vessel is landed and you select a target vessel the alarm will be for when the position of the landed vessel next passes under the orbit of the selected target. So you can try and launch into the right alignment
Closest Approach
This alarm will get you the time of Closest approach between the active vessel and the target vessel. You can use the slider to adjust how many orbits of the Active Vessel to look ahead to find this closest approach.
Target Distance or Altitude
You can also create alarms based on a target distance - not just closest approach. This alarm type will let you choose from a targetted vessel, the current body you are orbiting and the next body you will orbit (if there is one). The target distance is in meters
Target Distance
Target Altitude
Sphere of Influence Change
Similar to the Maneuver Node type this will detect the next SOI change on the flight path and create an alarm for that time. Once created the Alarm Clock will monitor the flight path and adjust the alarm time if the SOI point changes (eg. You burn your engines)
Transfer Window
This presents a list of possible interbody transfers around the same parent body and a “best” time to make that interbody burn. Below are some details on the screens and some extra information. For some excellent information on how to make a interplanetary transfer see this Tutorial by Voneiden.
- Calc Type: This gives you the choice to use one of two sets of data to determine the Alarm phase angle/time. You only get the two choices for bodies orbiting Kerbol as in the other cases the orbits are close to circular and the modelled data is not a s necessary. Anyways the two choices are:
- Formula Based - as seen in Olex's excellent calculator - this uses a series of formula that determine the phase angle based on circular orbits with radii oequal to the semi-major axis. The downside to this is obviously that not all planets have a circular orbit, and so sometimes you can attempt and still miss when the phase angle meets the forumla result;
- Modelled Data - This is a list of pre-generated transfer times (for the first 101 years of Kerbol's life) that has been calculated to include the affects of non-circular orbits. These calculations have been done by voneiden and you can see the raw data here, and there was a forum post about this, but I think it may have been lost.
- Xfer Parent: The body around which the origin and target are orbiting
- Xfer Origin: Body we are travelling from
- Target: Body we are travelling to
- Phase Angle: Details around the phase angle between the Origin and Target. This displays Current Angle (Target Angle)
- Time to Xfer: How long till the phase angles will match
Once created the Alarm Clock will monitor the Phase Angle values and adjust the alarm time if required. In formula mode the majority of these times will drift as the formula’s used are all circle based, while in reality few bodies orbit in a circle.
Transfer List View in Model Mode
Transfer List View in Formula Mode
Cycle Target View in Model Mode
Cycle Target View in Formula Mode
Crew Alarm
This alarm will let you choose one of the crew from the active vessel, and when you are ready you can jump back to the Kerbal, regardless of whether he is still in the same vessel.
The Store Man Node/Target option will store the existing vessels nodes with the kerbal alarm. Then you can restore these on another ship - this was requested due to setting/resetting them for docked vessels
Contract Alarm
This alarm will let you choose a contract to create an alarm for it. Active Contracts show up in green and if there is already an alarm for them they you wont be able to add another.
The attach to Active vessel option will let you jump back to this vessel for the alarm
The Settings Window
To access the settings for the plugin you click on the toolbar icon on the main window. Behind this there are a number of windows as described below.
General Settings
Plugin Styles
- Styling: The visual styling for the Alarm Clock Interface - KSP Stylem Unity Style or something in between
- App Button: Whether the Alarm Clock should display its icon via the App Launcher, Blizzy's Toolbar or a Basic Button
Plugin Preferences
- Max Alarms before scrolling window: how many alarms does the list grow to before turning on the scroll bar;
- Hide Alarm Clock when game is paused: when you open the Pause menu should the alarm windows be hidden – does not affect the F2 behaviour where all the interface is hidden;
- Show Tooltips on Mouse Hover
- Time Format: Toggle the displayed times/dates between UT (raw seconds), KSP formatted dates and standardised date format ("1,234s" or "2h, 10m, 35s" or "02:35:20"). Same as clicking the World Date/Time in the footer;
- Allow Ship Jump...: This toggles the visibility of the Jump to Ship buttons in alarms displayed on the Space Center and Tracking Station Screens. This option is here as the use of this function saves your game to a temp file then reloads it to start at the new ship. People who are uncomfortable with this functionlity should disable this option.
Save File Backups
This setting causes the KAC to backup the current saves prior to switching vessels, in all three game modes where jumping can be done. It copies the current persistent.sfs and quicksave.sfs files to KACBACKUPyyyyMMddHHmmss in the current save game, and if any of the backup code fails then the KAC will abort the ship switch.
You can configure how many saves to keep in the archive. And whether to fail the ship jump if the backup fails when in flight mode (in view mdes the backup is part of the jump so if it fails you can't jump)
Time Warp/Math Checks
This setting controls how often the alarm clock recalculates and checks for upcoming alarms in the background. You can choose from one of the presets of choose Custom. Custom reads the value from the settings.cfg file as per below (insert line if needed):
BehaviourChecksPerSec_Custom = 40
Alarm Specific Settings
Use the Alarm Type Dropdown to select which type of alarm you wish to affect
All Alarms
Set the Alarm Defaults for all newly created alarms as below:
- Alarm Position: where on the screen you want new alarms to be displayed initially;
- Alarm Action: When an alarm fires do you want the Alarm Clock to affect the Warp or Pause activities;
- Default Margin: Set a default for how long before an event an alarm will fire;
- Delete Alarm on Close: Set a default for this checkbox on each new alarm;
Maneuver Nodes
Manual and Auto Alarms
- Detect and Add Alarms for Maneuver Nodes: Will automatically add alarms for any future Man Nodes
- Remove Auto Alarms is Man Node Removed: Pretty self explanatory;
- Threshold: This setting dictates that if a new man node is discovered within this time period from the current time then it will not create a new alarm
- Alarm Action: Action for the Auto-Added Maneuver Node Alarms;
- Alarm Margin: Margin for the Auto-Added Maneuver Node Alarms;
Quick Add Alarms
- Quick Action: Action for the Quick Added Maneuver Node Alarms;
- Quick Margin: Margin for the Quick Added Maneuver Node Alarms;
SOI Changes
- Auto Recalc of Manual SOI Alarms: Updates the SOI alarms UT if it was added manually and the flight path changes;
- Detect and Add Alarms for SOI Change
- Exclude EVA Kerbals from Auto Alarms: Dont create alarms for EVA Kerbals that have an SOI change on their flight path;
- Exclude Debris from Auto Alarms: Dont create alarms for Debris that has an SOI change on their flight path;
- Alarm Action: Action for the Auto-Added SOI Alarms;
- Alarm Margin: Margin for the Auto-Added SOI Alarms;
Quick Add Alarms
- Quick Action: Action for the Quick Added SOI Alarms;
- Quick Margin: Margin for the Quick Added SOI Alarms;
Contracts
Two sections in here with the same settings for each - Active Contracts (Ones you have accepted) and Offered Contracts (Ones that are waiting for you)
- Alarm Action: Action for the Auto-Added SOI Alarms;
- Alarm Margin: Margin for the Auto-Added SOI Alarms;
-
Auto Create xxxxxxx Alarms: Two optione here - next and All;
- Next: Will create and maintain alarms for the next expiring/deadline contract
- All: Will create and maintain alarms for the all contracts of this type
- Dont Auto Create Alarms inside margin: If the contract event is in the future, but within the margin period dont create/maintain alarms;
- Delete contract on xxxxxxx passing: If there is a contract alarm, when the contract expires/passes delete the alarm;
Other Types
Crew Alarms
- Store Man Node/target with Crew Alarm: This sets the default behaviour for any new crew alarms;
Orbital Node Alarms
- Auto Recalc of Node Points: This setting causes the Kerbal Alarm Clock to monitor Node point alarms and recalculate the time of the alarm;
Quick Add Alarms
- Quick Action: Action for the Quick Added Node Alarms;
- Quick Margin: Margin for the Quick Added Node Alarms;
Transfer Alarms
- Auto Recalc of Transfer Points: This setting causes the Kerbal Alarm Clock to monitor Transfer alarms and recalculate the time of the target phase angle. This is required as the forumla's are all based on circular orbits, while most are elliptical. I do not recommend turning this off unless you are having issues with these alarms;
Icon Visibility
Minimal Mode
- Minimal Mode: Whether to display the next alarm to fire or the oldest existing alarm when the list is minimized;
Game Scenes
This tab lets you control on what screens the Alarm Clock will be visible and the location of the icon on each of these. The Window position and state is saved separately for each scene.
NOTE: If you turn off the visiblity in the Space Center or Tracking Station you can always access this tab via Flight mode to reenable the alarm
About and Version Checker
This tab displays the current version and current published versions. It will indicate if you are running a different version through a warning icon and some text. You can configure the Alarm Clock to check once daily, and manually trigger a check from here.
Also has assorted links to this documentation, Doanload page, forum, etc - which will open the browser, and links to other useful pages.
v2 Alarm Imports
On the About tab above you can see a section for importing alarms from a v2 Save file. You can find detailed instructions in the install page under the instructions below under Importing v2 Alarms