115 |
KSP Add-on Version Checker
116 |
117 |
118 | Developer
119 | CYBUTEK
120 |
121 |
122 |
123 | KSP-AVC Ready
124 |
125 | KSP Add-on Version Checker is a standardised system for versioning mods. You can get more information on the
126 | forum thread.
127 |
128 |
129 |
130 |
131 | Description
132 |
133 | On starting KSP this plugin will search your game directory for '.version' files. It will then proceed to check each one for version related issues. If any issues are found, an issue monitor will be displayed notifying you of what they are. There are two main types of version issues, with the first being related to the add-on's version and the second being its compatibility with your version of KSP. Some add-ons will also support a download option in their version check. If you require an update of an add-on and it has a download location set, you will be given a button which will open up your default browser and take you there. This could link directly to the .zip file or to a page with details on how to update. Note that you will need to close down KSP, install the updates and then restart KSP for them to work.
134 |
135 |
136 |
137 |
138 | Installation
139 |
140 | - Copy the 'KSP-AVC' folder into the 'GameData' folder located within your Kerbal Space Program installation directory.
141 |
142 |
143 |
144 |
145 | Version File Breakdown
146 |
147 |
148 | - NAME - Required
149 | The display name for the add-on.
150 |
151 | - URL - Optional
152 | Location of a remote version file for update checking.
153 |
154 | - DOWNLOAD - Optional
155 | Web address where the latest version can be downloaded.
156 | This is only used from the remote version file.
157 |
158 | - CHANGE_LOG - Optional
159 | The complete or incremental change log for the add-on.
160 | This is only used from the remote version file.
161 |
162 | - CHANGE_LOG_URL - Optional
163 | Populates the CHANGE_LOG field using the file at this url.
164 | This is only used from the remote version file.
165 |
166 | - GITHUB - Optional
167 | Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified.
168 | If the latest release version is not equal to the version in the file, an update notification will not appear.
169 | This is only used from the remote version file.
170 |
171 | - USERNAME - Required
172 | Your GitHub username.
173 |
174 | - REPOSITORY - Required
175 | The name of the source repository.
176 |
177 | - ALLOW_PRE_RELEASE - Optional
178 | Include pre-releases in the latest release search.
179 | The default value is false.
180 |
181 |
182 |
183 | - VERSION - Required
184 | The version of the add-on.
185 |
186 | - KSP_VERSION - Optional, Required for MIN/MAX
187 | Version of KSP that the add-on was made to support.
188 |
189 | - KSP_VERSION_MIN - Optional
190 | Minimum version of KSP that the add-on supports.
191 | Requires KSP_VERSION field to work.
192 |
193 | - KSP_VERSION_MAX - Optional
194 | Maximum version of KSP that the add-on supports.
195 | Requires KSP_VERSION field to work.
196 |
197 |
198 |
199 | For simple management of your version files you can use the KSP-AVC Online website at: ksp-avc.cybutek.net.
200 |
201 |
202 |
203 |
204 | Version File Example
205 |
206 | {
207 | "NAME":"KSP-AVC",
208 | "URL":"http://ksp-avc.cybutek.net/version.php?id=2",
209 | "DOWNLOAD":"http://kerbal.curseforge.com/ksp-mods/220462-ksp-avc-add-on-version-checker",
210 | "GITHUB":
211 | {
212 | "USERNAME":"YourGitHubUserName",
213 | "REPOSITORY":"YourGitHubRepository",
214 | "ALLOW_PRE_RELEASE":false,
215 | },
216 | "VERSION":
217 | {
218 | "MAJOR":1,
219 | "MINOR":1,
220 | "PATCH":0,
221 | "BUILD":0
222 | },
223 | "KSP_VERSION":
224 | {
225 | "MAJOR":0,
226 | "MINOR":24,
227 | "PATCH":2
228 | },
229 | "KSP_VERSION_MIN":
230 | {
231 | "MAJOR":0,
232 | "MINOR":24,
233 | "PATCH":0
234 | },
235 | "KSP_VERSION_MAX":
236 | {
237 | "MAJOR":0,
238 | "MINOR":24,
239 | "PATCH":2
240 | }
241 | }
242 |
243 |
244 |
245 |
246 | Change Log
247 |
248 |
249 |
250 |
256 |
257 |
258 |
259 |
260 |
263 |
264 |
--------------------------------------------------------------------------------
/Documents/MiniAVC/CHANGES.txt:
--------------------------------------------------------------------------------
1 | 1.0.3.3
2 | Build on KSP 1.2.0.1586
3 | Fixed: URLs are escaped before being processed.
4 |
5 | 1.0.3.2
6 | Built on KSP 1.1.0.1230
7 |
8 | 1.0.3.1
9 | Built on KSP Experimental 1.1.0.1171
10 |
11 | 1.0.3.0
12 | Added: Remote version files take priority when local/remote add-on versions are the same.
13 | Added: 'Any' type versions are now fully supported.
14 | Added: Wildcards for version fields with '-1'.
15 |
16 | 1.0.2.4
17 | Updated for KSP v0.25.0
18 | Fixed: Typo in AddonInfo.ToString()
19 | Fixed: Bug with empty version files.
20 |
21 | 1.0.2.3
22 | Changed: Done a lot of under the hood refactoring.
23 | Fixed: Bug that would freeze the computer when checking many add-ons.
24 |
25 | 1.0.2.2
26 | Changed: Versions will always have the minimum formatting of 'x.x'.
27 | Fixed: Issue with non-RAW GitHub version file hosting, extending the url formatter.
28 |
29 | 1.0.2.1
30 | Added: Some extra exception handling and cleaned up some of the code.
31 |
32 | 1.0.2.0
33 | Added: GitHub latest release checking.
34 | Added: Version file reading is now case insensitive.
35 | Fixed: Bug in version equality checking. (Now using a custom VersionInfo object).
36 |
37 | 1.0.1.1
38 | Fixed: Bug where it did not do the allow check.
39 |
40 | 1.0.1.0
41 | Added: Tooltip when hovering over the download button showing the destination URL.
42 | Added: File not found handling.
43 |
44 | 1.0.0.0
45 | Initial release of MiniAVC based on the core KSP-AVC Plugin v1.1.1 system.
--------------------------------------------------------------------------------
/Documents/MiniAVC/README.htm:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
115 |
MiniAVC Add-on Version Checker
116 |
117 |
118 | Developer
119 | CYBUTEK
120 |
121 |
122 |
123 | KSP-AVC Ready
124 |
125 | KSP Add-on Version Checker is a standardised system for versioning mods. You can get more information on the
126 | forum thread.
127 |
128 |
129 |
130 |
131 | Description
132 |
133 | This plugin checks inside its current directory and all contained directories for version files. It's use is for mods to make use of the KSP-AVC system without requiring the player to have the full KSP-AVC Plugin installed. The MiniAVC.dll plugin is safe to be bundled with mods and will negotiate between all other instances of MiniAVC to run the latest version. If an installation of KSP-AVC Plugin is found, the MiniAVC system will be disabled to let KSP-AVC take over. MiniAVC can check for both updates and game version compatibility, the same way as KSP-AVC Plugin does. The biggest difference is that because MiniAVC is a bundleable plugin, it will ask the player on the first run whether to allow update checking. If the user does not wish your add-on to check for updates, the remote checking functionality will be disabled. This will not completely turn off MiniAVC as it can still run in local mode to notify the player of any game version compatibility issues.
134 |
135 |
136 |
137 |
138 | Installation
139 |
140 | - Bundle the MiniAVC.dll file into your packaged add-on directory along with your version file.
141 | - If your add-on contains multiple version files, place it at the lowest directory level which will cover all the version files, but do not place it in GameData.
142 |
143 |
144 |
145 |
146 | Community Add-on Rule 5.5
147 |
148 | The rule states that, "Add-ons that contact another network or computer system must tell users exactly what it's sending or receiving in a clear and obvious way in all locations it is offered for download." This means that if you bundle MiniAVC with your add-on, you must clearly notify players before downloading that it contains MiniAVC and how it works.
149 |
150 |
BB Code
151 | This mod includes version checking using [URL=http://forum.kerbalspaceprogram.com/threads/79745]MiniAVC[/URL]. If you opt-in, it will use the internet to check whether there is a new version available. Data is only read from the internet and no personal information is sent. For a more comprehensive version checking experience, please download the [URL=http://forum.kerbalspaceprogram.com/threads/79745]KSP-AVC Plugin[/URL].
152 |
153 | HTML
154 | This mod includes version checking using <a href="http://forum.kerbalspaceprogram.com/threads/79745">MiniAVC</a>. If you opt-in, it will use the internet to check whether there is a new version available. Data is only read from the internet and no personal information is sent. For a more comprehensive version checking experience, please download the <a href="http://forum.kerbalspaceprogram.com/threads/79745">KSP-AVC Plugin</a>.
155 |
156 |
157 |
158 |
159 |
160 | Version File Breakdown
161 |
162 |
163 | - NAME - Required
164 | The display name for the add-on.
165 |
166 | - URL - Optional
167 | Location of a remote version file for update checking.
168 |
169 | - DOWNLOAD - Optional
170 | Web address where the latest version can be downloaded.
171 | This is only used from the remote version file.
172 |
173 | - CHANGE_LOG - Optional
174 | The complete or incremental change log for the add-on.
175 | This is only used from the remote version file.
176 |
177 | - CHANGE_LOG_URL - Optional
178 | Populates the CHANGE_LOG field using the file at this url.
179 | This is only used from the remote version file.
180 |
181 | - GITHUB - Optional
182 | Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified.
183 | If the latest release version is not equal to the version in the file, an update notification will not appear.
184 | This is only used from the remote version file.
185 |
186 | - USERNAME - Required
187 | Your GitHub username.
188 |
189 | - REPOSITORY - Required
190 | The name of the source repository.
191 |
192 | - ALLOW_PRE_RELEASE - Optional
193 | Include pre-releases in the latest release search.
194 | The default value is false.
195 |
196 |
197 |
198 | - VERSION - Required
199 | The version of the add-on.
200 |
201 | - KSP_VERSION - Optional, Required for MIN/MAX
202 | Version of KSP that the add-on was made to support.
203 |
204 | - KSP_VERSION_MIN - Optional
205 | Minimum version of KSP that the add-on supports.
206 | Requires KSP_VERSION field to work.
207 |
208 | - KSP_VERSION_MAX - Optional
209 | Maximum version of KSP that the add-on supports.
210 | Requires KSP_VERSION field to work.
211 |
212 |
213 |
214 | For simple management of your version files you can use the KSP-AVC Online website at: ksp-avc.cybutek.net.
215 |
216 |
217 |
218 |
219 | Version File Example
220 |
221 | {
222 | "NAME":"KSP-AVC",
223 | "URL":"http://ksp-avc.cybutek.net/version.php?id=2",
224 | "DOWNLOAD":"http://kerbal.curseforge.com/ksp-mods/220462-ksp-avc-add-on-version-checker",
225 | "GITHUB":
226 | {
227 | "USERNAME":"YourGitHubUserName",
228 | "REPOSITORY":"YourGitHubRepository",
229 | "ALLOW_PRE_RELEASE":false,
230 | },
231 | "VERSION":
232 | {
233 | "MAJOR":1,
234 | "MINOR":1,
235 | "PATCH":0,
236 | "BUILD":0
237 | },
238 | "KSP_VERSION":
239 | {
240 | "MAJOR":0,
241 | "MINOR":24,
242 | "PATCH":2
243 | },
244 | "KSP_VERSION_MIN":
245 | {
246 | "MAJOR":0,
247 | "MINOR":24,
248 | "PATCH":0
249 | },
250 | "KSP_VERSION_MAX":
251 | {
252 | "MAJOR":0,
253 | "MINOR":24,
254 | "PATCH":2
255 | }
256 | }
257 |
258 |
259 |
260 |
261 | Change Log
262 |
263 |
264 |
265 |
271 |
272 |
273 |
274 |
275 |
278 |
279 |
--------------------------------------------------------------------------------
/Documents/MiniAVC/README.md:
--------------------------------------------------------------------------------
1 | # MiniAVC Add-on Version Checker
2 |
3 | ## Developer
4 |
5 | Cybutek
6 |
7 |
8 | ## KSP-AVC Ready
9 |
10 | KSP Add-on Version Checker is a standardised system for versioning mods. You can get more information on the
11 | [forum thread](http://forum.kerbalspaceprogram.com/threads/79745)
12 |
13 |
14 | ## Description
15 |
16 | This plugin checks inside its current directory and all contained directories for version files. It's use is for mods to make use of the KSP-AVC system without requiring the player to have the full KSP-AVC Plugin installed. The MiniAVC.dll plugin is safe to be bundled with mods and will negotiate between all other instances of MiniAVC to run the latest version. If an installation of KSP-AVC Plugin is found, the MiniAVC system will be disabled to let KSP-AVC take over. MiniAVC can check for both updates and game version compatibility, the same way as KSP-AVC Plugin does. The biggest difference is that because MiniAVC is a bundleable plugin, it will ask the player on the first run whether to allow update checking. If the user does not wish your add-on to check for updates, the remote checking functionality will be disabled. This will not completely turn off MiniAVC as it can still run in local mode to notify the player of any game version compatibility issues.
17 |
18 |
19 | ## Installation
20 |
21 | - Bundle the MiniAVC.dll file into your packaged add-on directory along with your version file.
22 | - If your add-on contains multiple version files, place it at the lowest directory level which will cover all the version files, but do not place it in GameData.
23 |
24 |
25 | ## Community Add-on Rule 5.5
26 |
27 | The rule states that, "Add-ons that contact another network or computer system must tell users exactly what it's sending or receiving in a clear and obvious way in all locations it is offered for download." This means that if you bundle MiniAVC with your add-on, you must clearly notify players before downloading that it contains MiniAVC and how it works.
28 |
29 | ### BB Code
30 | ```
31 | This mod includes version checking using [URL=http://forum.kerbalspaceprogram.com/threads/79745]MiniAVC[/URL]. If you opt-in, it will use the internet to check whether there is a new version available. Data is only read from the internet and no personal information is sent. For a more comprehensive version checking experience, please download the [URL=http://forum.kerbalspaceprogram.com/threads/79745]KSP-AVC Plugin[/URL].
32 | ```
33 | ### HTML
34 | ```html
35 | This mod includes version checking using