Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmagic1/capcom
A KSP addon that allows for reviewing and accepting contracts away from the Mission Control Building
https://github.com/dmagic1/capcom
kerbal-space-program
Last synced: 2 months ago
JSON representation
A KSP addon that allows for reviewing and accepting contracts away from the Mission Control Building
- Host: GitHub
- URL: https://github.com/dmagic1/capcom
- Owner: DMagic1
- License: mit
- Created: 2015-04-19T22:53:02.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T03:25:18.000Z (about 5 years ago)
- Last Synced: 2023-08-10T18:08:41.403Z (over 1 year ago)
- Topics: kerbal-space-program
- Language: C#
- Size: 352 KB
- Stars: 8
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### **CapCom - Mission Control On The Go**
[![][shield:support-ksp]][KSP:developers]
[![][shield:ckan]][CKAN:org]
[![][shield:license-mit]][CCLicense]
[![][shield:license-cc-by-sa]][CCLicense]
![][CC:header]
[![][shield:support-toolbar]][toolbar:release]
[![][shield:support-cwp]][cwp:release]
### People, and Info
-------------------------------------------
#### Authors and Contributors
[DMagic][DMagic]: Author and maintainer
[TriggerAu][TriggerAu]: CapCom uses a modified version of TriggerAu's KSP Plugin Framework
#### License
The code is released under the [MIT license][CCLicense]; all art assets are released under the [CC-BY-SA
license][CCLicense]
#### FAQ
* What is CapCom?
* CapCom is a user interface that allows for reviewing, accepting, declining or canceling contracts outside of the Mission Control Center building
* It provides a number of features not found in the Mission Control Center; these are described below
* How do the keyboard shortcuts work?
* When the window is selected keyboard shortcuts are available for several functions
* The **Up/Down arrows** are used to cycle through contracts in the currently selected list
* The **Right/Left arrows** are used to switch lists
* The **Enter** key is used to accept an offered contract
* The **Del** key is used to decline or cancel a contract
* The **Left Ctrl** key is used to select multiple contracts when held down
* All keys can be reassigned in the settings window
* Is CapCom designed to replace the in-flight contract list app?
* CapCom can be used to monitor active contracts, but it is not designed as a replacement for the Contracts App
* For an addon designed specifically for doing that try the [Contracts Window +][cwp:release]
* Something has gone wrong; where can I get help?
* If you run into errors, contracts not visible in a list, contracts not being accepted, window not being displayed properly, etc... report problems either to the [GitHub Issues][CC:issues] section or the [KSP Forum Thread][CC:release]
###
-------------------------------
#### Sort Bar
![][CC:sort-bar]
##### Controls contract sorting options and order
* Contracts can be sorted based on a variety of criteria in either ascending or descending order
* **Contract difficulty**, as noted by the number of stars
* **Contract reward** amounts; **Funds**, **Science**, or **Reputation**
* **Contract agency**, sorted alphabetically
* **Target Planet**, not all contracts have target planets associated with them; addon contracts rely on the planet being in the contract title
* **Time Remaining**, sorted by expiration date for offered contracts, deadline for active contracts, and completion date for finished contracts
* Current active contract count and max contract limit are shown above
##### Selecting the rewards sorting option will open a drop-down menu; select the desired reward type here
![][CC:sort-rewards]
#### Contract List
![][CC:contract-list]
##### Separate contract lists are available based on contract status
* Review, accept, and decline **offered contracts**
* Dependent upon the maximum contracts allowed by the current Mission Control Center building level
* Review **active contracts**
* Mission status is updated for each contract
* Cancel active contracts if allowed
* Review **completed contracts**
* Review **progress nodes**
##### Currently selected contracts are indicated by the green bar on the left
* By holding the **multi-select key** (left Ctrl by default; can be edited) multiple contracts can be selected or de-selected
* Multiple contracts can be accepted, declined, or canceled if allowed
#### Contract Header
![][CC:contract-header]
##### The title and agency of the currently selected contract is shown here, along with the primary contract controls
* The **accept**, **decline**, and **cancel** buttons are shown on the right, depending on the contract's status
* The **agency flag** is a button, pressing it opens the agency info screen
* The **settings menu** can be opened with the gear icon in the upper-right
* The *X* icon will close the window
* The controls are not available while in the editor
##### By default a **warning popup** is displayed when you decline or cancel a contract; both options can be adjusted in the settings menu.
![][CC:contract-warn]
#### Basic Contract Info
![][CC:contract-info]
##### The nonsense **mission briefing** and short mission synopsis are shown at the top of this area
* An option to hide the **mission briefing** text is available in the settings menu
* **Mission duration** and **deadline** times are updated in real-time
#### Contract Objectives
![][CC:objectives]
##### Each **contract parameter**, its status and any rewards are displayed next
* The **status** of each parameter is indicated by an icon on the left
* Parameter and mission **notes** can be hidden by default using an option in the settings menu; if selected they can then be displayed by clicking a blue **note icon**
* **Reward values** also incorporate any strategy modifiers
#### Contract Rewards
![][CC:rewards]
##### The overall **mission rewards** are displayed at the bottom of the window
* These also reflect any changes made by **strategy modifiers**
* Contract **decline penalties** are shown for offered contracts
#### Progress Nodes
![][CC:progress-list]
##### Progress Nodes Lists for all completed Worlds First Progress Nodes are shown when the globe icon is selected
![][CC:progress-rewards]
##### Rewards and information about each progress node are shown for the selected list
#### Agency Info
![][CC:agency]
##### When the agency flag is selected a separate text area will appear
* Basic information about the current agency is displayed
* Each agency mentality is shown, along with a description if available
* Other contracts offered or already accepted by the same agency are displayed
------------------------------
### Settings Window
![][CC:settings-full]
#### Config Options
![][CC:settings-options]
##### At the top of the **settings window** are several toggle options
* **Hide Mission Briefing Text** will prevent the nonsense mission briefing from being shown at all
* **Hide Mission Notes** will cause mission and parameter notes to be hidden by default, they can be displayed by clicking on the blue **+** icon next to each note
* **Warn on Decline** causes a warning window with a confirmation button to appear when declining an offered contract
* **Warn on Cancel** causes a warning window with a confirmation button to appear when canceling an active contract
* **Tooltips** are available for several of the icon buttons
* **Use Stock App Launcher** is available only if [Blizzy78's Toolbar][toolbar:release] is installed; turning this option off will cause the CapCom button to use that toolbar
#### Keyboard Shortcuts
![][CC:settings-keys]
##### All of the keyboard shortcut keys can be reassigned here
* Select the key to be reassigned using the buttons on the right
* With the **reassign** window open push any key (don't take screenshots with the window open...); push accept to save the new setting
* Use the **Save** button at the bottom to accept any changes; the **Cancel** button will revert any changes made
[DMagic]: http://forum.kerbalspaceprogram.com/members/59127
[TriggerAu]: http://forum.kerbalspaceprogram.com/members/59550
[KSP:developers]: https://kerbalspaceprogram.com/index.php
[CKAN:org]: http://ksp-ckan.org/
[CCLicense]: https://github.com/DMagic1/CapCom/blob/master/LICENSE
[CC:header]: http://i.imgur.com/Gs8BJJa.png
[CC:settings-full]: http://i.imgur.com/KVvXHoZ.png
[CC:sort-bar]: http://i.imgur.com/KKkif1g.png
[CC:sort-rewards]: http://i.imgur.com/p1NNhwy.png
[CC:contract-list]: http://i.imgur.com/uBw8GHE.png
[CC:contract-header]: http://i.imgur.com/HQh88N1.png
[CC:contract-info]: http://i.imgur.com/FSbIHBq.png
[CC:contract-warn]: http://i.imgur.com/MYFREr2.png
[CC:progress-list]: http://i.imgur.com/5NbkWe5.png
[CC:progress-rewards]: http://i.imgur.com/WyzE6eD.png
[CC:rewards]: http://i.imgur.com/rSTlPpQ.png
[CC:objectives]: http://i.imgur.com/vheC0BB.png
[CC:agency]: http://i.imgur.com/taMAEqY.png
[CC:settings-options]: http://i.imgur.com/EAvmNlI.png
[CC:settings-keys]: http://i.imgur.com/zKNYILc.png
[CC:issues]: https://github.com/DMagic1/CapCom/issues
[CC:release]: http://forum.kerbalspaceprogram.com/threads/119701
[toolbar:release]: http://forum.kerbalspaceprogram.com/threads/60863
[cwp:release]: http://forum.kerbalspaceprogram.com/threads/91034
[shield:license-mit]: http://img.shields.io/badge/license-mit-a31f34.svg
[shield:license-cc-by-sa]: http://img.shields.io/badge/license-CC%20BY--SA-green.svg
[shield:support-ksp]: http://img.shields.io/badge/for%20KSP-v1.4-bad455.svg
[shield:ckan]: https://img.shields.io/badge/CKAN-Indexed-brightgreen.svg
[shield:support-toolbar]: http://img.shields.io/badge/works%20with%20Blizzy's%20Toolbar-1.7.x-7c69c0.svg
[shield:support-cwp]: https://img.shields.io/badge/works%20with%20Contracts%20Window%20%2B-6.3-orange.svg