Skip to content

Commit 39c8635

Browse files
paulswithersGitHub Enterprise
authored andcommitted
Updating for VSEs, updating download details (#1)
1 parent fc07793 commit 39c8635

20 files changed

Lines changed: 63 additions & 55 deletions

docs/howto/archipelago/atlas.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,7 @@ The `atlas.json` file is used to define a project's metadata as well as dependen
3030

3131
## VSE Extensions
3232

33-
In EA1 and EA2, it was only possible to download VSEs by using the numeric portions of the file download URL, e.g. **library** as "25265" and **module** as "25877/20841". The module changed for each version, because it corresponded to a specific file download. This required the Volt MX Marketplace repository URL to be **"https://community.demo-hclvoltmx.com/marketplace/asset"**.
34-
35-
From EA3, a different download URL from Volt MX Marketplace is supported. For this, the **library** is the asset title, e.g. "JsonVSE VoltScript Extension". The **module** is the asset filename when downloaded, minus the file suffix, e.g. "jsonvse". This requires the Volt MX Marketplace repository URL to be **"https://community.demo-hclvoltmx.com/marketplace"**. Note that unlike EA1 and EA2, this does not have "/asset" on the end.
36-
37-
If the VSE library and extension are numeric, you **must** have the repository URL as "https://community.demo-hclvoltmx.com/marketplace/asset". If it is the more human-readable format mapping to the VSE name, you **must** have the repository URL as "https://community.demo-hclvoltmx.com/marketplace". This format is the preferable option and there has been limited usage of EA1 and EA2, so the repository ID has not been changed. Documentation and the latest versions of all VoltScript Library Modules have been updated to use it.
38-
39-
!!! warning
40-
All affected VoltScript Library Modules have had new releases. These are:<br/>
41-
- VoltScript JSON Converter, version 1.0.4.<br/>
42-
- VoltScript Collections, version 1.0.4.<br/>
43-
- VoltScript VoltMX Middleware, version 1.0.4.<br/>
44-
Ensure you are using at least these versions, or there may be errors downloading downstream dependencies from "https://community.demo-hclvoltmx.com/marketplace".
33+
The **library** is the asset title, e.g. "JsonVSE VoltScript Extension". The **module** is the asset filename when downloaded, minus the file suffix, e.g. "jsonvse". The Volt MX Marketplace repository URL is **"https://community.demo-hclvoltmx.com/marketplace"**.
4534

4635
!!! info
4736
By default, VSE files for all platforms (Windows, Linux, MacOS) will be copied into the project. You can use `runtimePlatforms` property to restrict which platforms' VSEs are copied in. For more details, see [How to Structure an atlas.json](../../references/atlas.md).

docs/howto/extensions/buildingjson.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Incorporating JsonVSE is straightforward. You just need to add the following JSO
1313
```json
1414
"JsonVSE": {
1515
"library": "JsonVSE VoltScript Extension",
16-
"version": "1.0.3",
16+
"version": "1.0.4",
1717
"module": "jsonvse",
1818
"repository":"volt-mx-marketplace"
1919
}

docs/howto/extensions/encrypt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Incorporating HashVSE is straightforward. You just need to add the following JSO
1313
```json
1414
"HashVSE": {
1515
"library": "HashVSE VoltScript Extension",
16-
"version": "1.0.3",
16+
"version": "1.0.4",
1717
"module": "hashvse",
1818
"repository":"volt-mx-marketplace"
1919
}

docs/howto/extensions/env-vars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Incorporating OSUtilsVSE is straightforward. You just need to add the following
3737
```json
3838
"OSUtilsVSE": {
3939
"library": "OSUtilsVSE VoltScript Extension",
40-
"version": "1.0.3",
40+
"version": "1.0.4",
4141
"module": "osutilsvse",
4242
"repository":"volt-mx-marketplace"
4343
}

docs/howto/extensions/file-download.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Incorporating JsonVSE and WebVSE is straightforward. You just need to add the fo
1616
```json
1717
"WebVSE": {
1818
"library": "WebVSE VoltScript Extension",
19-
"version": "1.0.3",
19+
"version": "1.0.4",
2020
"module": "webvse",
2121
"repository":"volt-mx-marketplace"
2222
}

docs/howto/extensions/find-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Incorporating OSUtilsVSE is straightforward. You just need to add the following
1313
```json
1414
"OSUtilsVSE": {
1515
"library": "OSUtilsVSE VoltScript Extension",
16-
"version": "1.0.3",
16+
"version": "1.0.4",
1717
"module": "osutilsvse",
1818
"repository":"volt-mx-marketplace"
1919
}

docs/howto/extensions/hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Incorporating HashVSE is straightforward. You just need to add the following JSO
1313
```json
1414
"HashVSE": {
1515
"library": "hashVSE Voltscript Extension",
16-
"version": "1.0.3",
16+
"version": "1.0.4",
1717
"module": "hashvse",
1818
"repository":"volt-mx-marketplace"
1919
}

docs/howto/extensions/input.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Incorporating StreamVSE and ContextVSE is straightforward. You just need to add
1313
```json
1414
"StreamVSE": {
1515
"library": "StreamVSE VoltScript Extension",
16-
"version": "1.0.3",
16+
"version": "1.0.4",
1717
"module": "streamvse",
1818
"repository": "volt-mx-marketplace"
1919
},
2020
"ContextVSE": {
2121
"library": "ContextVSE VoltScript Extension",
22-
"version": "1.0.3",
22+
"version": "1.0.4",
2323
"module": "contextvse",
2424
"repository":"volt-mx-marketplace"
2525
}

docs/howto/extensions/json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Incorporating JsonVSE is straightforward. You just need to add the following JSO
1313
```json
1414
"JsonVSE": {
1515
"library": "JsonVSE VoltScript Extension",
16-
"version": "1.0.3",
16+
"version": "1.0.4",
1717
"module": "jsonvse",
1818
"repository":"volt-mx-marketplace"
1919
}

docs/howto/extensions/memory-stream.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
# In-memory streaming
22

3+
--8<-- "setup.md"
4+
5+
## Introduction
6+
37
Reading and writing to files is useful. But in-memory processing is typically quicker because it removes the disk I/O interaction. In-memory streams are designed as a more performant approach than string concatenation.
48

9+
## VoltScript dependencies
10+
11+
Incorporating StreamVSE and ContextVSE is straightforward. You just need to add the following JSON object to the `vsesDependencies` element in your `atlas.json`.
12+
13+
```json
14+
"StreamVSE": {
15+
"library": "StreamVSE VoltScript Extension",
16+
"version": "1.0.4",
17+
"module": "streamvse",
18+
"repository": "volt-mx-marketplace"
19+
}
20+
```
21+
22+
--8<-- "vse-repository.md"
23+
24+
## Processing streams in memory
25+
526
To create an in-memory stream, open the stream with either "MEMORY" or "BUFFER" as the character set.
627

728
``` voltscript

0 commit comments

Comments
 (0)