TweakScale

Last Updated: Oct 27, 2018 Game Version: 1.5.1

419,697

May 16, 2014

Owner: lisiast

TweakScale lets you change the size of a part. Not just that, but it will figure out how much fuel is in the resized part. And if it's an engine, it will become more powerful by scaling it bigger, or weaker by scaling it smaller.



This plugin was initially made by Gaius Goodspeed, and I heartily recommend you also take a look at his parts.

TweakScale is already used by Gaius' parts above, and ZodiusInfuser's Infernal Robotics model rework, which I also recommend to anyone who likes having fun.

TweakScale uses Swamp-Ig's KSPAPIExtensions.

TweakScale is made available under the terms of the Creative Commons Attribution-NonCommercial-ShareAlike license.

Forum page

Source on GitHub

Current Version: 1.20 (2014-06-12 22:15 UTC)

From Version 1.5.0.1, KSPAPIExtensions.dll should no longer reside in GameData, but in Gamedata/TweakScale/Plugins. If you have a KSPAPIExtensions.dll in your Gamedata/ folder, please delete it.

Please add TweakScale to your mod!
If you are a mod author and you want to bundle TweakScale with your mod, please do! A few notes:

  • Please place your TweakScale .cfgs in your mod's folder, not in the TweakScale folder. This way users can delete TweakScale and install a new version without breaking your mod.
  • If your mod is already on the list of supported mods, please post here or PM me, and I will remove support, giving you full control over the .cfgs.



Anyways, features:

Scaling Control
You as the author of a part or addon get complete control over which parts you want to offer in which sizes. Should that fuel tank only be available in size 2.5m and 3.75m? Make it so! That RCS thruster on the other hand, could be scalable freely between half regular scale and double regular scale.

Mass Control
For heavy, solid parts, mass increases with the cube of the scale - you scale it in three dimensions, after all. For parts that are a thin layer of aluminium plates over a rigid skeleton - like fairings, crew compartments, empty fuel tanks - mass probably scales closer to the square of the scale.

Rescales Stock parts
Engines, RCS thrusters, fuel tanks, boosters, reaction wheels, air intakes, control surfaces and solar panels are supported, and have their physical properties updated to sensible values when rescaled.

Integration with Modular Fuel Tanks, Real Fuels and KSP Interstellar
TweakScale correctly changes fuel volumes on tanks using Modular Fuel Tanks and Real Fuels. It correctly adjusts power output, waste heat, microwave transmission and other stuff for KSP Interstellar parts. Thus far, the following are supported:

  • Solar Sails
  • Microwave Receivers
  • Atmospheric Scoops
  • Atmospheric Intakes
  • Heat Radiators
  • Alcubierre Drives
  • Engines (Except the Vista Engine)
  • Antimatter Storage Tanks
  • Generators
  • Fusion Reactors


Fission reactors, antimatter reactors and antimatter-initiated reactors are not yet supported. (Awaiting better formulae for those and the Vista engine)

How to Use
First add a part that's the wrong size:



Right click:



See how it says 3.75m? Well, the command capsule is 2.5m, so let's change it. You do this by pressing the << >> buttons or dragging the slider.



See how well it fits?



Examples
For a part that should be available in 62.5cm, 1.25m, 2.5m, 3.75m and 5m configurations, and by default is 1.25m, use the following definition:

Code:
MODULE
{
    name = TweakScale
    defaultScale = 1.25
    type = stack
}

If the part should instead be freely rescalable, use this:

Code:
MODULE
{
    name = TweakScale
    type = free
}

And for a part that should be available in 25%, 50%, 100% and 200% scales, use:

Code:
MODULE
{
    name = TweakScale
    type = surface
}

But I said you had full control of scales, didn't I? If you want your parts to be available only in 2.5m and 3.75m versions, use this definition:

Code:
MODULE
{
    name = TweakScale
    type = stack
    scaleFactors = 2.5, 3.75
    scaleNames = 2.5m, 3.75m
}

If your mod has a collection of parts that will all be available in the same set of sizes, you might want to make your own scale type:

Code:
SCALETYPE
{
    name = MyMod
    freeScale = false
    massFactors = 0.0, 0.0, 1.0
    scaleFactors = 0.5, 1.0, 2.0
    scalenames = Small, Medium, Large
    defaultScale = 1.0
}

After defining this once, you can then start using it for your parts:

Code:
MODULE
{
    name = TweakScale
    type = MyMod
}

As you can see the scale type uses the same names as the module definition, and they can even inherit from other scale types (if you want to change just a small detail).

Adding module support
You can now add support for your own modules! For a simple module that's happy with having its values changed when OnLoad is called, this is how:

Code:
TWEAKSCALEEXPONENTS
{
    name = MyPartModule
    
    flooberRate = 2
}

When a user rescales a part with a MyPartModule module, TweakScale will automatically update the flooberRate of the part with the square of the scale (so if it's a 2.5m part and it's scaled to 3.75m, the flooberRate will be 2.25 times its usual value [3.75/2.5 = 1.5; 1.5^2 = 2.25]).

New in 1.10 is the ability to change fields of fields - that is, myPartModule.someStruct.value or myPartModule.someList[x]:

Code:
TWEAKSCALEEXPONENTS
{
    name = ModuleGenerator
    outputList
    {
	   rate = 3
    }
}

The above config will scale all members of the list outputList on ModuleGenerator, to the cube of the current scale.

Note that this system works for any depth:

Code:
TWEAKSCALEEXPONENTS
{
    name = ModuleMyModule
    foo
    {
           bar
           {
               quxRate = 3
           }
    }
}

The above would scale ModuleMyModule.foo[x].bar.quxRate.

New in 1.19 is tech requirements:

Code:
MODULE
{
    name = TweakScale
    type = stack
    techRequired = basicRocketry, start, generalRocketry, advRocketry, heavyRocketry
}

Here, each option in the stack SCALETYPE will be unlocked by a corresponding tech. If there are fewer techRequired than scaleNames/scaleFactors, the unmatched scales will be unlocked by default.


It might be that your module would benefit more from using a list of values than an exponent. In that case, you may specify the list in the tweakscale module statement in the .cfg:

Code:
MODULE
{
    name = TweakScale
    type = stack
    defaultScale = 3.75
    
    MODULE
    {
        name = ModuleEngines
        maxThrust = 1, 2, 3, 4, 5
    }
}

Here, a 62.5cm version would have a maxThrust of 1, 1.25m would be 2, and so on until the 5m version has a maxThrust of 5.

If more advanced logic is required, TweakScale offers an IRescalable interface. Its definition is as follows:

Code:
public interface IRescalable
{
    void OnRescale(ScalingFactor factor);
}

ScalingFactor has the properties 'absolute' and 'relative'. Most likely, you want to use absolute. relative is the change in scale since last time OnRescale was called, while absolute is the change in scale in relation to defaultScale. absolute and relative have properties linear, quadratic, cubic and squareRoot, which are shorthands for different scaling factors.

IRescalable can be used in conjunction with .cfg exponents. In that case, TweakScale will first call IRescalable's OnRescale, followed by updates from .cfgs. (this may be changed in the future, as I'm not sure it's the best solution)

Due to limitations in .NET, an IRescalable either has to be implemented in an assembly of its own, or the entire assembly will be made dependent on TweakScale.

An example implementation of an IRescalable may be:

Code:
class MyModuleUpdater : TweakScale.IRescalable
{
    MyPartModule _module;

    public MyModuleUpdater(MyPartModule module)
    {
        _module = module;
    }

    public void OnRescale(TweakScale.ScalingFactor factor)
    {
        _module.flooberRate = _module.flooberRate * factor.relative.quadratic;
        _module.ReactToFlooberRate(13);
    }
}

and the new updater may be registered with TweakScale thusly:


Code:
[KSPAddon(KSPAddon.Startup.EditorAny, false)]
internal class MyEditorRegistrationAddon : TweakScale.RescalableRegistratorAddon
{
    public override void OnStart()
    {
        TweakScale.TweakScaleUpdater.RegisterUpdater((MyPartModule mod) => new MyModuleUpdater(mod));
    }
}

[KSPAddon(KSPAddon.Startup.Flight, false)]
internal class MyFlightRegistrationAddon : TweakScale.RescalableRegistratorAddon
{
    public override void OnStart()
    {
        TweakScale.TweakScaleUpdater.RegisterUpdater((MyPartModule mod) => new MyModuleUpdater(mod));
    }
}

For an example implementation, check out how Real Fuels support is implemented.

In case someone's confused:

  • MODULE { name = TweakScale ... } goes in the PART you want scalable. (or a ModuleManager .cfg, of course)
  • TWEAKSCALEEXPONENTS and SCALETYPE go top-level in some .cfg. It doesn't matter which, it doesn't matter where. As long as it's called .cfg and is somewhere in gamedata, it'll be correctly registered. The suggested location is Gamedata/MyMod/MyMod_TweakScale.cfg

Version History:

Version 1.20 (2014-06-12 22:15 UTC)


1.19 (2014-06-06 10:56 UTC)

  • Added support for tech requirements for non-freeScale parts.



1.18 (2014-06-04 00:58 UTC)

  • Factored out Real Fuels and Modular Fuel Tanks support to separate dlls.



1.17 (2014-06-03 22:21 UTC)

  • Fixed bug where attachment nodes were incorrectly scaled after reloading. This time with more fix!
  • Added support for Near Future Technologies.



1.16 (2014-06-03 21:31 UTC)

  • Fixed bug where attachment nodes were incorrectly scaled after reloading.



1.15 (2014-06-03 20:50 UTC)

  • Finally squished the bug where crafts wouldn't load correctly. This bug is present in 1.13 and 1.14, and affects certain parts from Spaceplane+, MechJeb, and KAX.



1.14 (2014-06-03 19:50 UTC)

  • Fixed a bug where nodes with the same name were moved to the same location regardless of correct location. (Only observed with KW fairing bases, but there could be others)



1.13 (2014-06-02 18:25 UTC)



1.12 (2014-06-02 11:10 UTC)

  • Added support for КОСМОС.
  • No longer scaling heatDissipation, which I was informed was a mistake.



1.11 (2014-06-01 20:24 UTC)

  • Removed silly requirement of 'name = *' for updating all elements of a list.
  • Added .cfg controlled scaling of Part fields.



1.10 (2014-06-01 14:53 UTC)

  • Added support for nested fields.



1.9 (2014-05-31 00:57 UTC)

  • Fixed a bug where rescaleFactor caused erroneous scaling.
  • Added (some) support for Kethane parts.



1.8.1 (2014-05-30 22:41 UTC)
Don't use 1.8.1, either. 

1.8
Don't use 1.8

1.7 (2014-05-22 21:09 UTC)

  • Removed spurious debug log printing.
  • You can now use a list of value instead of an exponent!
  • Exponents and value lists can be specified per part, not just per module type. (And per-part values take precedence)
  • Fixed erroneous scale for Rockomax 48-7S, and added missing scale for KW Rocketry 2.5m Nose Cone.



1.6 (2014-05-22 14:04 UTC)

  • Fixed a problem where parts were scaled back to their default scale after loading, duplicating and changing scenes.
  • Fixed defaultScale for Rockomax 48-7S (was 625, should be .625. Who'd guess someone'd notice that, eh?)



1.5.0.1 (2014-05-21 00:36 UTC)

  • Fixed a bug in 1.5 where scale was not correctly preserved.
  • Updated KSPAPIExtensions.dll - please delete the version in GameData/.
  • Added support for KSO.



1.5 (2014-05-20 22:23 UTC)

  • Changed from hardcoded updaters to a system using .cfgs.
  • Made registration of custom IRescalables possible.



1.4 (2014-05-20 17:53 UTC)

  • Fixes compatibility with GoodspeedTweakScale (but not old versions of TweakScale, but that should be a much, much smaller problem anyway).
  • Added scaling support for KW Rocketry, NovaPunch and KSP Interstellar.



1.3 (2014-05-19 22:49 UTC)

  • Fixed a bug where parts would get rescaled to stupid sizes after loading.
  • Breaks compatibility with old version of the plugin (pre-1.0) and GoodspeedTweakScale. 



1.2 (2014-05-18 22:00 UTC)

  • Fixed default scale for freeScale parts.
  • Fixed node sizes, which could get absolutely redonkulous. Probably not perfect now either.
  • B9 Aerospace, Talisar's Cargo Transportation Solutions, and NASA Module Manager configs.
  • Now does scaling at onload, removing the problem where the rockets gets embedded in the ground and forcibly eject at launch.
  • Fixed a silly bug in surface scale type.



1.1 (2014-05-17 23:30 UTC):



1.0 (2014-05-16 18:00 UTC):

  • Initial Release!



Known Issues/TODO:

  • More mods should be supported. I'm open to suggestions.
  • Enlarged engines burn too hot.
  • Exhaust trails are the wrong size. I think.
  • Support for more modules (addons)?
  • Tech tree support (unlock sizes).
  • Suboptimal interactions with Procedural Parts and Procedural Fairings - parts may intersect after loading.
  • I have no idea how FAR feels about the updating of drag and lift.
  • Apparently tweakable everything with TweakScale causes problems (ref post 200). More information needed.
  • Fairings may be erroneously scaled (ref post 22) Unable to replicate. I'd love to have a .craft file showing this problem.
  • Weird TWR in MechJeb. (ref post 22)
  • Camera can end up in weird positions. (ref post 22)
  • Add ModuleEngineConfig support.
  • Do what Taverius says about engines and possibly other stuff.
  • kolago (post 144) would like to see what the rescaled values are. Still on the fence about this.

Comments

Posts Quoted:
Reply
Clear All Quotes