SCANsat: Real Scanning, Real Science, Warp Speed!
- 0. People, Facts, and FAQs
- 1. Installation and Interoperability
- 2. Types of Scans
- 3. Basic Usage
- 4. Big Map
- 5. Parts and Sensors Types
- 6. (Career Mode) Research and Development
- 7. Color Management
- 8. Instrument Window
- 9. Background Scanning
- 10. Time Warp
- 11. Settings Menu
- 12. Note: Data Sources
WARNING:
This add-on is a work-in-progress.
This means you should expect that it may not work, and you should be unsurprised if it does not progress.
Disclaimer aside, this add-on is widely used and it usually works just fine.
🔝 0. People, Facts, and FAQs
The current maintainer is:
Maintainers are the people who you should complain to if there is something wrong.
Complaints in various forms are prioritized as follows:
- Pull Requests are given the highest priority possible. ~ 24 hour response
- Issues are given higher priority than other complaints. ~ 2 day response
- E-Mails will be answered as soon as possible (it's a forwarded list) ~ 3 day response
- Forum Posts are given a medium priority. ~ 1 week response
- Forum Private Messages are given a low priority. We might forget!
- Reddit Posts and PMs are the lowest priority. We often lurk and don't login!
If you submit a well-reasoned pull request, you may even trigger a new release!
The current authors include:
Past authors include:
As of August 2014, the vast majority of code is damny's and DMagic's; and technogeeky and is slowly helping out here and there.
In addition to the authors, the following people have contributed:
-
(Models, Graphics, Textures) Milkshakefiend
-
(Science results text) madsailor
For licensing information, please see the included LICENSE.txt file.
Source Code is available, as some licenses may require.
🔝 0a. FAQs
- What does SCANsat do?
- It allows you to scan planetary bodies for terrain, biome, and resource information and generate various kinds of maps.
- How does SCANsat affect gameplay?
- It allows you to see surface details from orbit from an interactive, zoom-able map. This will help you plan your missions (for example, landing near a divider between two or three biomes) and provide critical information you need to attempt a safe landing (for instance, the slope map will help you avoid treacherous hills)
- Will this version break my existing scans from older versions of SCANsat?
- No! This version is completely backwards compatible, and you current scanning state (which is stored in persistent.sfs) will be safe and sound. Nevertheless, you should make a backup copy of your game before upgading any mod.
- Do I need to attach a part to my vessel to use SCANsat?
- No, but.... You can view existing maps from any vessel, but you need to attach a scanner to add new data to the maps.
- [Career Mode] Does SCANsat give us science points?
- Yes! For each type of map, if you scan at least 30% of the surface, you can yse Data for partial science points; up until the maximum value at 95% map coverage.
- [Career Mode] Is it integrated into the tech tree?
- Yes! This link tells you which nodes unlock which parts in the tech tree.
- [Contracts] Does SCANsat offer contracts to complete?
- Yes/No. Contracts are currently only supported through third-party addons.
- Can you add to SCANsat?
- Probably! First, check the issues page to see if it's already been requested. If not, add a new issue. Even better, attempt to add the feature yourself and submit a pull request. We'll catch the bugs for you!
🔝 0b. Video Overview
SCANsat overview and review by: TinyPirate
- Watch this quick video on the features and functions of SCANsat
🔝 1. Installation and Interoperability
🔝 1a. Installation
- Download the latest SCANsat package from the releases section of this GitHub Repo
- Extract the included package and put the SCANsat folder in your KSP installation's GameData folder.
🔝 1b. GameData Layout
🔝 1c. Other Add-Ons
S.C.A.N. is proud to collaborate with other KSP mods and modding teams. Following is a table of all of the mods, add-ons, or software that we interoperate with.
| Built Using | Supported By |
|---|---|
 |
 |
| Regolith |  |
| RasterPropMonitor |  |
| Blizzy78's Toolbar |  |
| ModuleManager | Extraplanetary Launchpads |
MM, RPM, Toolbar, and Resource Addons are all soft dependencies. This means your experience with SCANsat will be enhanced if you are using these mods, but they are not necessary.
SCANsat is built against the following mods:
SCANsat also supports resource scanning with the following mods:
-
- via (Regolith) <-
- via (Regolith) <-
-
- via (Kethane) <-
🔝 2. Types of Scans
SCANsat supports several different kinds of scans (as opposed to scanning modules or parts).
- RadarLo: Basic, Low-Resolution RADAR Altimetry (b&w, limited zoom)
- RadarHi: Advanced, High-Resolution RADAR Altimetry (in color, unlimited zoom)
- Slope: Slope Data converted from RADAR data
- Biome: Biome Detection and Classification (in color, unlimited zoom)
- Anomaly: Anomaly Detection and Labeling
- Resource: Scan for chemical or mineral resource on the surface.
Other parts and add-ons are free to include one or more of these kinds of scans. In general, we would request that similar (same order of magnitude) scanning parameters and limitations are used on custom parts, but this is not a requirement.
🔝 2a. SCANsat Scans
Without any resource scanning mods installed, SCANsat can scan for a few basic types of data. All of these (non-resource) scans are shown as indicators on the Small Map.
| Data Type | Scan Type | Scan Indicator |
|---|---|---|
| Altimetry | RADAR | LO |
| Altimetry | SAR | HI |
| Biome | Biome | MULTI |
| Anomaly | Anomaly | MULTI |
| Anomaly | Been There, Done That(tm) | BTDT |
- The Slope map is generated from either HI or LO data.
- The Biome scan only works for bodies that have biomes. For vanilla KSP, this means all planets except the sun and Jool.
- Anomalies are things the builds of KSC, hidden easter eggs, etc...
- The Anomaly data scans for anomalies from orbit, while
- BTDT shows a camera view of an anomaly once you are near it
- The Biome and Anomaly scans are combined into the multi-spectral scanner; indicated by MULTI
🔝 2b. Resource Scans
SCANsat will scan planetoids for resources, assuming you have the relevant mods installed. All support for resource scanning is handled through one of two plugins. Regolith supports many resources, and Kethane supports a few.
Resource scans are initiated in the same way as any other scan. In this case they must use custom scanner parts included with the resource addon.
Resource scanning proceeds the same way as standard SCANsat scanning instruments do. The grey scale color option generally works best when viewing resource overlays.
Each of the two resource systems can be enabled through the SCANsat Big Map:
🔝 2c. Regolith
Regolith support is built internal to SCANsat. If you have a Regolith DLL loaded anywhere SCANsat will only target the newest version.
Check for the Regolith Biome Lock toggle in the SCANsat settings menu to enable or disable biome-based restrictions on resource scanning accuracy. With the biome lock active resource scanning will be of only limited accuracy until you have explored the surface of the planet and/or the specific biomes.
With any Regolith-using mod installed, you can select their resources in the drop down menu from the Big Map or KSC Map, and enable their overlay with the resource icon. For instance the Karbonite mod's resources can be viewed:
🔝 2d. Kethane
Kethane support is built using an included extra DLL file.
This file will only be loaded if you have a Kethane installed in its usual location. If Kethane is not installed, this DLL will simply unloaded from memory. Kethane also checks to see if you have multiple versions of it installed, and warns you.
Once it is installed correctly, you will be able to enable Kethane resources in the settings menu:
Both of the two resource systems will work in IVA, too:
🔝 3. Basic Usage
Put scanner part on rocket, aim rocket at sky, launch. If your rocket is not pointing at the sky, you are probably not going to map today, because most sensors only work above 5 km.
You can start scanning by selecting a SCANsat part's context menu, enabling the part. Here, you will find a small map.
🔝 3a. FAQ: Finding a Good Altitude
Watch the data indicators on the small map to determine how well your scanners are performing. The right-click context menus also contain indicators for the proper scanning altitude.
Solid ORANGE means you're too high (and therefore no data is being recorded):
Flashing ORANGE/GREEN means you're too low (and therefore you have a FOV penalty):
Solid GREEN means you're in an ideal orbit. Notice the larger swath width on the right:
🔝 3b. Mismatched Scanners
In these examples, the SAR and Multi sensors are not very well matched. Because the SAR sensors is ideal above 750km, and becuase it has a large field of view penalty if it's down near the ideal for Multi (250km), these sensors probably should not be used on the same scanner.
| BIO and ANOM are ideal, but HI is not! | HI is ideal, but BIO and ANOM are off! |
|---|---|
 |
 |
| SAR (HI) has thin swaths due to low alt. | Multi and RADAR have similar ideal swaths |
|---|---|
 |
 |
The mapping interface consists of a small-ish map of the planet, as far as it has been scanned in your current game. It scans and updates quickly and shows positions of the active vessel, as well as other scanning vessels in orbit around the same planet. Orbital information is also provided. For a slower but more detailed view, see the big map.
Note that the indicators flash blue when the gray-scale color option is selected on the big map.
Be sure to remember to pack enough batteries, radioisotope generators, and solar panels. If you forget, you'll run out of electricity, you'll stop recording data, and you'll see useless static:
🔝 4. Big Map
A bigger map can be rendered on demand. Rendered maps are automatically saved to GameData/SCANsat/PluginData. Note that position indicators for vessels or anomalies are not visible on exported images (but they may be a future release).
You can mouse over the big map to see what sensors have data for the location, as well as terrain elevation, and other details.
Right-clicking on the big map shows a magnified view around the position where you clicked. Mouse operations work inside this magnified view just like they work outside, meaning the data displayed at the bottom window applies to your position inside the magnified view, and right-clicking inside it will increase magnification. This can be useful to find landing spots which won't kill your kerbals.
🔝 4a. Big Map Options
There are four drop-down menus along the top of the big map. These control, from left to right:
- The map projection type - Rectangular, KavrayskiyVII:, or Polar
- The map type - Altimetry, Slope, or Biome
- The resource to overlay on the map
- The planet to display
The icon in the center of the upper row regenerates the map.
The toggle icons along the left side of the map control the various overlays and the color mode.
The four buttons in the bottom-left open and close the other SCANsat windows.
The camera icon in the lower-right exports a copy of the map.
The re-size icon in the lower-right corner can be dragged to re-size the map.
🔝 5. Parts and Sensor Types
| Part | Scan Type | FOV | Altitude (Min) | (Ideal) | (Max) |
|---|---|---|---|---|---|
| RADAR Altimetry Sensor | RadarLo / Slope | 5 | 5000 m | 5000 m | 500 km |
| SAR Altimetry Sensor | RadarHi | 2 | 5000 m | 750 km | 800 km |
| Multispectral Sensor | Biome ANOM | 4 | 5000 m | 250 km | 500 km |
| Been There Done That® | Anomaly | 1 | 0 m | 0 m | 2 km |
| MapTraq® (deprecated) | None | N/A | N/A | N/A | N/A |
🔝 5a. The RADAR Altimetry Sensor
🔝 5b. The SAR Altimetry Sensor
🔝 5c. The Multispectral Sensor
🔝 5d. Been There Done That
🔝 5e. MapTraq (deprecated)
🔝 6. (Career Mode) Research and Development
The RADAR Altimetry sensor can be unlocked in Science Tech.
The SAR Altimetry sensor can be unlocked in Experimental Science.
The Multispectral sensor can be unlocked in Advanced Exploration.
The BTDT sensor can be unlocked in Field Science.
🔝 6a. Community Tech Tree Support
When the Community Tech Tree and TechManager addons are installed SCANsat parts will default to different tech tree nodes.
The RADAR Altimetry sensor can be unlocked in Orbital Surveys.
The SAR Altimetry sensor can be unlocked in Specialized Science Tech.
The Multispectral sensor can be unlocked in Advanced Surveys.
The BTDT sensor can be unlocked in Field Science.
🔝 6b. Minimum Scan for Science
Once you scan at least 30% of a particular map, you can use Analyze Data to get delicious science:
🔝 6c. Getting Maximum Science
Between 30% and 100%, you will get a number of science points proportional to the percentage. Really, the upper cutoff is 95% in case you didn't scan the whole map.
🔝 6d. Contract Support
Career mode contracts are supported through third party addons.
🔝 7. Color Management
SCANsat provides multiple options for map color configurations and terrain level changes.
The color management window can be accessed from the big or small map with the color palette icon, or from the toolbar menu.
On the left are the various color palettes available; there are four different styles that can be selected from the drop down menu. Palettes can be customized by changing the number of colors in the palette, reversing the order, or making the palette use discrete color transitions, rather than the smooth gradient used by default.
Changes to the color palette are reflected after selecting Apply, the big and small maps will automatically refresh using the newly selected color palette.
Note that only the altimetry map is affected by color palette selection.
There are several terrain height options available as well.
- The Min and Max height sliders can be used to set the lower and upper cutoff values for the terrain height-to-color algorithm.
- The Clamp option can be used to set a cutoff below which only the first two colors in the selected
palette will be used for the terrain height-to-color algorithm. This is especially useful on planets where there is an ocean, as it makes the transition
from ocean to solid terrain more pronounced.
All stock KSP planets have default color palette and terrain height values appropriate for the planet's terrain. Standard default values are used for any addon planets.
🔝 8. Instrument Window
The instruments window provides a readout of several types of data based on current scanning coverage.
- Biome Shows the biome that the current vessel is in or over
- Altitude Shows the vessel's current altitude above the terrain
- Slope Shows a highly localized slope based on a 3X3 grid centered 5m around the vessel
- Anomaly Shows the nearest anomaly and its distance from the vessel
- BTDT Anomaly Shows detailed information and a crude image about the nearest anomaly; scroll the mouse wheel when positioned over the anomaly window to switch between different structures if more than one is found
🔝 9. Background Scanning
Unlike some other KSP scanning systems, SCANsat allows scanning with multiple vessels. All online scanners scan at the same time during any scene where time progresses; no active SCANsat parts are necessary.
🔝 10. Time Warp
SCANsat does not interpolate satellite paths during time warp; nevertheless, due to the relatively large field of view of each sensor, it's still possible to acquire data faster by time warping. The maximum recommended time warp speed is currently 10,000x. Scanning at this warp factor should allow identical scanning performance (in terms of swath width) as scanning at 1x.
As an example of speed, here is a BigMap rendering of a scan at 100x:
And this is a BigMap rendering of the same orbit, but later in the scan.
It starts at 1000x and then speeds up to 10,000x:
Notice that the only gaps in coverage are those at the poles (ie, the selected inclination was not high enough to capture the poles).
🔝 11. Settings Menu
The settings menu has a various general options
- The marker used for Anomalies can be specified
- Background scanning can be controlled for each planet
- Background scanning resolution can be lowered for better performance (watch for short pauses when several scanners are active at very high timewarp; reducing the scanning resolution can help with this)
- Toggles control the availability of the Stock App Launcher button, the Tooltips for various icons on other windows, and the Regolith Biome Lock if available
- If the windows are ever dragged off screen there is an option to Reset All Windows to their default positions
- Scanning Data can be deleted for any or all planets; a confirmation box will appear when these options are selected
- The numbers under the Time Warp Resolution indicate the following
- Vessels: The number of vessels with any active SCANsat sensors present
- Sensors: The total number of SCANsat sensors on all vessels; note that all combination sensors are separated into their invidual components, i.e. the Multi-Spectral scanner consists of two sensors, Biomes and Anomalies.
- Passes: The number of scanning passes recorded per second, this number can easily be in the tens of thousands at high time warp with multiple vessels and sensors active.
🔝 12. Note Concerning Data Sources
All data this mod shows you is pulled from your game as you play. This includes:
- terrain elevation
- biomes
- anomalies
SCANsat can't guarantee that all anomalies will be found; in particular, some are so close to others that they don't show up on their own, and if the developers want to be sneaky then they can of course be sneaky.