From e73431cd38948657fcceeb90c699fc44bb39ce8f Mon Sep 17 00:00:00 2001 From: Drew Kerman Date: Wed, 23 Dec 2015 01:31:16 -0500 Subject: [PATCH] v4,0 --- README.md | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 00f7322..5460ec1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ ##Installation -Copy out the program .ks files to your KSP/Ships/Script folder once you have installed kOS v0.16.0 or later. If the folder is not there, create it or run KSP once first. +Copy out the program .ks file to your KSP/Ships/Script folder once you have installed [kOS v0.18.2](https://github.com/KSP-KOS/KOS/releases/tag/v0.18.2) or later. If the folder is not there, create it or run KSP once first. -##Usage (with [Tweakable Everything](http://forum.kerbalspaceprogram.com/threads/64711-0-23-5-TweakableEverything-1-1-For-all-your-part-tweaking-needs)) +##Usage For basic kOS usage (such as loading the program onto your craft) see the [kOS Docs](http://ksp-kos.github.io/KOS_DOC/tutorials/quickstart.html). @@ -16,9 +16,9 @@ You can now run the program `run rcstc.` -Once the program runs, it will first check whether the craft is under remote or local control. If control is remote, then it will confirm a link is established with KSC before allowing the program to continue. If control is local this step is skipped. If RemoteTech is not installed, this feature will be disabled. +If you are under warp running the program will drop you out of warp time before it initializes. Once the program begins, it will first check whether the craft is under remote or local control. If control is remote, then it will confirm a link is established with KSC before allowing the program to continue. If control is local this step is skipped. If RemoteTech is not installed, this feature will be disabled. -Next it will automatically detect all active RCS ports and perform a *very* short and low-thrust test burst of your RCS thruster ports to determine their ISP. **All ports in use should be using the same ISP**. It will then tell you on the HUD what it has found so you can confirm number, ISP and throttle setting. +Next it will automatically detect all active RCS ports and determine their ISP. **All ports in use should be using the same ISP**. It will then tell you on the HUD what it has found so you can confirm number, ISP and throttle setting. It will also highlight all RCS parts found and their enabled/disabled state to help you visually confirm the craft is configured the way you want. Next the program will look for a maneuver node. If it doesn't detect a maneuver node it will wait until you create one. When a node is detected, it will first check to make sure your craft has the amount of Δv required to perform the maneuver. If you don't have enough Δv a warning message will inform you (and continue to inform you until you adjust or execute your maneuver) but the program will not cancel the node. It will next inform you of the amount of time needed to complete the maneuver and start counting down. This countdown marks the beginning of RCS thrust, not the time of the maneuver node itself. It is directly tied to the game time so any physics lag will not affect its accuracy. @@ -26,37 +26,26 @@ At any time before the node executes you can alter the thrust limiter of your RC **do not delete the maneuver node created by the program. Doing so while no other node is present will create a run-time kOS error.** -If the time to thrust is a ways off, you can time warp as much as you please - the program will detect this and make sure to drop you out of warp 10 seconds prior to node execution. *note it will only monitor time accelleration if a user-made maneuver node is present*. +If the time to thrust is a ways off, you can time warp as much as you please - the program will detect this and make sure to drop you out of warp 5 seconds prior to node execution. *note it will only monitor time accelleration if a user-made maneuver node is present*. This program will **not** orient your craft. To do this, you must manually orient it or, if you are dealing with signal delay or future planned lack of connection, use the RemoteTech flight computer. -Once the thrust is complete the program will terminate and remove the maneuver node (but not any future ones you may have created). If you had SAS set to target the node during the maneuver, the program's removal of the node will cause KSP to disable your SAS, but the program will make sure to toggle it back on if this was the case. +Once the thrust is complete the program will terminate and remove the maneuver node it created (but not any future ones you may have created). If you had SAS set to target the node during the maneuver, the program's removal of the node will cause KSP to disable your SAS, but the program will make sure to toggle it back on if this was the case. You can cancel the program at any time by pressing the Abort button. If you do not have RemoteTech enabled, the abort will be instant. If you do have RemoteTech enabled, the abort command will obey the current signal delay, unless control is local in which case the abort will be immediate. If you forget to disable the abort toggle before re-running the program the program will toggle it off. -##Usage (without Tweakable Everything) - -If you do not have Tweakeable Everything installed to use the RCS thrust limiter, you can instead use the RCSTC(no TE) script file (rename it to RCSTC and delete the other version). Everything about the program stays the same except you must specify the throttle setting when the program is run and you can't change it without aborting & restarting the program. Example: - -`run RCSTC(76).` - -This will load the thrust controller at 76% throttle. - -In both cases, if you are under warp running the program will drop you out of warp time before it initializes. - ##Future Additions - **Thruster kN Detection** - Will allow the option to not have to set the `kN` variable manually - **Multiple ISP Thrusters** - Allow for thrusters that don't all have the same ISP - **Multiple kN Thrusters** - Allow for thrusters that don't all have the same kN -- **Optional Throttle Setting** - Allow for one file that can let the user choose to either set the throttle at the start or adjust via Tweakable Everything ##Known Issues - The future node created by the script is there to avoid a run-time error that needs to be patched within kOS - The future node initially has a radial out value to push it off the current orbit so that it can be selected by the user to place a node before it - Regardless of whether you are using an actual kOS part or are using Module Manager to insert kOS functionality into another part (like a probe core) it **must not be a root part** of the craft. This is a known kOS issue -- Tweakable Everything will only let you set the thrust as low as 5 before going straight to 0 (which RCSTC will reset to 1). +- RCS tweakable will only let you set the thrust as low as 5 before going straight to 0 (which RCSTC will reset to 1). ##Credits