Skip to content

Commit

Permalink
recompile in release mode
Browse files Browse the repository at this point in the history
update version file, forum post, readme
add build script
  • Loading branch information
shadowmage45 committed Mar 7, 2020
1 parent 5403e58 commit 9592345
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 20 deletions.
Binary file modified GameData/TUFX/Plugins/TUFX.dll
Binary file not shown.
Binary file modified GameData/TUFX/Plugins/TUFX.pdb
Binary file not shown.
6 changes: 3 additions & 3 deletions GameData/TUFX/TexturesUnlimitedFX.version
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"NAME":"TexturesUnlimitedFX",
"URL":"http://ksp-avc.cybutek.net/version.php?id=532",
"DOWNLOAD":"https://github.com/shadowmage45/TexturesUnlimited/releases/tag/1.5.10.25",
"CHANGE_LOG_URL":"https://github.com/shadowmage45/TexturesUnlimited/releases/tag/1.5.10.25",
"URL":"https://raw.githubusercontent.com/shadowmage45/TUFX/master/GameData/TUFX/TexturesUnlimitedFX.version",
"DOWNLOAD":"https://github.com/shadowmage45/TUFX/releases/tag/1.0.0.1",
"CHANGE_LOG_URL":"https://github.com/shadowmage45/TUFX/releases/tag/1.0.0.1",
"VERSION":
{
"MAJOR":1,
Expand Down
Binary file added SSTUBuildTools.exe
Binary file not shown.
1 change: 1 addition & 0 deletions build_instructions.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
run build_start_here.bat -- it will do the rest
12 changes: 12 additions & 0 deletions build_script.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
//TexturesUnlimitedFX build script
//read by SSTUBuildTools.exe
//currently only supported options are MS-DOS Command-Line options (CMD:) and Zip operations (ZIP:{})
versionFile = GameData/TUFX/TexturesUnlimitedFX.version
//simply zip it up and export it to the parent directory
ZIP:TUFX-%version%.zip
{
+d GameData/TUFX:GameData/TUFX
+f readme.md:GameData/TUFX/readme.md
+f LICENSE.txt:GameData/TUFX/LICENSE.txt
}
CMD:move /y *.zip ..
2 changes: 2 additions & 0 deletions build_start_here.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SSTUBuildTools.exe build build_script.txt
pause
53 changes: 42 additions & 11 deletions forumPost.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,30 @@ through specially configured profiles.
TUFX allows for users to select a specific 'profile' to be used for each game scene. These profiles specify which effects
will be enabled for the scene, and specify the values for each of the parameters for the effects.

Before:
**TODO - Add before and after images**

After:
**TODO - Add before and after images**

|Before|After|
|----|----|
| ![](https://i.imgur.com/vx7oYeS.png) | ![](https://i.imgur.com/rmz5dL3.png) |
| ![](https://i.imgur.com/bV0sQQp.png) | ![](https://i.imgur.com/4DFwZoi.png) |
| ![](https://i.imgur.com/5FoqysR.png) | ![](https://i.imgur.com/cF9Bx22.png) |
| ![](https://i.imgur.com/OQPLwFi.png) | ![](https://i.imgur.com/glUZris.png) |
| ![](https://i.imgur.com/OIiq8aC.png) | ![](https://i.imgur.com/XqeHw0n.png) |

---
## Requirements:
* **Windows / DirectX11**, required for single-camera setup in KSP
* ShaderModel 3.5 or later graphics hardware support (5.0+ recommended)
* KSP 1.9.0 or later, required for single-camera setup
* No exceptions. No OpenGL. No DirectX12. Definitely not DirectX9.
* Any other requirements of the Unity Post Process package (look them up if interested)
* KS3P will cause conflicts. Choose one or the other.
* Scatterer currently unsupported (it is not yet available for KSP 1.9+)
* EVE currently unsupported (it is not yet available for KSP 1.9+)

## Installation
Releases of the mod will be available from GitHub: https://github.com/shadowmage45/TUFX/releases

Download the most recent release for your version of KSP, open the .zip file, and extract the contents of the GameData/
subfolder from the package into your KSP installations' GameData/ folder (e.g. YourKSPPath/GameData/TUFX). Make sure to
subfolder from the package into your KSP installations' GameData/ folder (e.g. Your/KSP/Path/GameData/TUFX). Make sure to
include any other dependencies and folders (e.g. ModuleManager) that were included in the release package.


Expand All @@ -41,8 +53,6 @@ is not supported).
From within the configuration UI, select a profile for the current scene/to be edited (**only the active profile can be
edited**). Once a profile has been selected, press the 'Change to Edit Mode' button on the top of the configuration UI.
This will prompt the UI to display the current configuration of the profile.

**TODO: Add marked-up example of editing UI**

Press the 'Enable'/'Disable' toggle by an effect title to toggle that effect on or off.

Expand All @@ -59,19 +69,40 @@ into the KSP.log file. From there, you can copy the profile out of the log and
data to overwrite the contents of an existing profile config file. **TUFX does not support direct-to-file exporting, as no
'Save File Dialog' has been provided by either Unity or KSP, and I have no desire to create one myself, nor deal with the
security issues that would arise from its use.**

**See the included readme.md document for information on config file syntax, and how to manually edit/create profiles.**

---
## Performance Comparison
Comparison data gathered on the following hardware (your results may differ):
* Intel i5-2500k @ 4.5ghz
* 24g DDR3
* GTX970

|Scene|KS3P|TUFX|TUFX-Disabled|Stock|
|----|----|----|----|----|
|KSC|NA|142|170|180|
|Kerbin-Ground|NA|105|118|128|
|Kerbin-Orbit|NA|125|150|165|

KS3P was unavailabe at the time the testing was performed, so no data was gathered.

## Dependencies
* **ModuleManager** - TUFX depends directly on ModuleManager for its 'Database Reloaded' callback, and will not function unless ModuleManager is
installed. ModuleManager has been included in the release packages, and is redistributed under the terms of its own license.
Further information on Module Manager can be found on the KSP Forums at: ( https://forum.kerbalspaceprogram.com/index.php?/topic/50533-18x-19x-module-manager-413-november-30th-2019-right-to-ludicrous-speed/ ), and the license and source-code may be found
on the ModuleManager GitHub repository: ( https://github.com/sarbian/ModuleManager ).

## Licensing/Legal
## Known Issues and Bug Reports
See the github issues repository: https://github.com/shadowmage45/TUFX/issues

## Licensing/Legal
* Full source code for the TUFX assembly is available on github: https://github.com/shadowmage45/TUFX
* Source code for Unity post processing shaders are available on github: https://github.com/Unity-Technologies/PostProcessing
* Custom code and classes (everything outside of the PostProcessing source folder) is under GPL3.0 or later license, the
full text of this license may be found included in the release packages and on the GitHub repository:
https://github.com/shadowmage45/TUFX/blob/master/LICENSE.txt
* Unity developed classes are provided under Unity companion license, with source and license references available
* Unity developed classes, shaders, and textures are provided under Unity companion license, with source and license references available
from:
https://github.com/Unity-Technologies/PostProcessing
* Modifications to Unity classes (adding ConfigNode load/save methods) are released under public domain or as close as possible under US law.
Expand Down
15 changes: 9 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Brings the Unity Post Process Package (v2) into KSP, un-touched and as provided
developers (exception: minor helper methods added).

## Requirements:
* **Windows / DirectX11** (sorry OSX and Linux users, complain to Unity; the effects **require** compute shader support)
* **Windows / DirectX11**, required for single-camera setup in KSP
* ShaderModel 3.5 or later graphics hardware support (5.0+ recommended)
* KSP 1.9.0 or later
* KSP 1.9.0 or later, required for single-camera setup
* No exceptions. No OpenGL. No DirectX12. Definitely not DirectX9.
* Any other requirements of the Unity Post Process package (look them up if interested)
* KS3P will cause conflicts. Choose one or the other.
Expand Down Expand Up @@ -42,6 +42,7 @@ Changes made through the UI are not permanent, and are only persistent until the
To make the changes permanent, use the 'Export' buttons at the top of the UI; pressing these will
export the profile(s) to the KSP.log file, where they can then be copied into a new CFG file.

---
## Profile Config Syntax:

The structure of the profile configuration files is as below:
Expand Down Expand Up @@ -93,9 +94,11 @@ TUFX_PROFILE
//the name of the parameter
name = MasterCurve
//the 'zero point' (no clue)
ZeroPoint = 0.5
zero = 0.5
//the 'range' (no clue)
Range = 1
range = 1
//unknown
loop = True
//animation curve/float curve key layout with six floating point elements
// time, value, in-tangent, out-tangent, in-weight, out-weight
key = 0.0, 1.0, 0.0, 0.0, 0.0, 0.0
Expand All @@ -104,7 +107,7 @@ TUFX_PROFILE
}
}
````

---
## Effects and Parameters
Listed below will be each effect included in TUFX, the name it uses within the configuration files,
and the name of the parameters for the effects as used in both the profiles and texture
Expand Down Expand Up @@ -235,7 +238,7 @@ Listed as 'Vignette' in configuration files. Has the following fields:
* Mask
* Opacity


---
## Licensing:
* Custom code and classes (everything outside of the PostProcessing source folder) is under GPL3.0 or later license.
* Modifications to Unity classes are released under public domain or as close as possible under US law.
Expand Down

0 comments on commit 9592345

Please sign in to comment.