diff --git a/i3s_converter/i3s_converter.exe b/i3s_converter/i3s_converter.exe index 2750ab26..a8904482 100644 Binary files a/i3s_converter/i3s_converter.exe and b/i3s_converter/i3s_converter.exe differ diff --git a/i3s_converter/i3s_converter_ReadMe.md b/i3s_converter/i3s_converter_ReadMe.md index d524206c..4cdb7cfd 100644 --- a/i3s_converter/i3s_converter_ReadMe.md +++ b/i3s_converter/i3s_converter_ReadMe.md @@ -99,31 +99,20 @@ is the equivalent to
| -s \[key] | --secret-key \[key] | AWS S3/Alibaba OSS secret key or Azure account key | | -t \[num threads] | --thread-count \[num threads] | [Number of threads](#threadsDesc) to use when converting, default is 1 | | -x | --drop-dxt | Don't write DXT textures | +| | --endpoint-url | Endpoint url for S3 compatible services | +| | --aws-profile | AWS Profile in ```%USERPROFILE%\.aws\credentials``` | -## Examples -Examples can be found [here](i3s_converter_examples.md), which show various uses of the i3s_converter. - -## Conversion and Extraction -#### Filesystem -To convert an slpk to filesystem (*.eslpk) -- ```i3s_converter.exe --convert -d -t ``` - -To extract an slpk to filesystem (*.eslpk) -- ```i3s_converter.exe --extract -d ``` -#### Cloud -To convert an slpk to cloud (*.i3srest) - - ``` i3s_converter.exe --convert -d :// -a -s -r -t ``` -Usage for converting an slpk to cloud -- ```i3s_converter.exe --extract -d :// -a -s -r ``` - -Supported schemes: +### Supported cloud schemes: - AWS S3: s3 - Azure Blob: az - Alibaba OSS: oss +## Examples +Examples can be found [here](i3s_converter_examples.md), which show various uses of the i3s_converter. + ## Notes - Only the first 10 warnings/errors are output to the command line. diff --git a/i3s_converter/i3s_converter_examples.md b/i3s_converter/i3s_converter_examples.md index cef6f801..f16aafa1 100644 --- a/i3s_converter/i3s_converter_examples.md +++ b/i3s_converter/i3s_converter_examples.md @@ -14,9 +14,12 @@ In all the of following examples, we will assume a working directory of ```C:\Us [Create ETC2 textures](#createETC2)
[Drop DXT textures](#dropDXT)
[Drop normals](#dropNormals)
+[Convert slpk to filesystem (eslpk)](#convertFilesystem)
+[Extract slpk to filesystem (eslpk)](#extractFilesystem)
[Convert to cloud format (i3srest)](#convertCloud)
[Extract to cloud (i3srest)](#extractCloud)
-[Convert and extract to cloud](#convertAndExtract) +[Convert and extract to cloud](#convertAndExtract)
+[Validate using AWS profile](#validateWithAws) ------------------------------------- @@ -61,14 +64,34 @@ present. ```i3s_converter.exe -u myFile.slpk -n```
This command performs a conversion and drops all normals. Client will recreate these normals. +### Convert to filesystem (eslpk) +```i3s_converter.exe -u myFile.slpk -d C:\Users\johndoe\Desktop\MyFolder -t 2```
+This command performs a conversion to the filesystem format (eslpk) for ready to serve files. +In this example, the destination folder is changed, and number of threads is set to 2. + +### Extract to filesystem (eslpk) +```i3s_converter.exe -e myFile.slpk -d C:\Users\johndoe\Desktop\MyFolder```
+This command extracts an slpk to the filesystem format (eslpk) for ready to serve files. +In this example, the destination folder is changed. + ### Convert to cloud format (i3srest) ```i3s_converter.exe -u myFile.slpk -d s3://mySlpkBucket -a AKIAIOSFODNN7EXAMPLE -s wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -r us-east-1a```
This command performs a conversion to the i3srest format for cloud storage. This example uses AWS S3. ### Extract to cloud (i3srest) -```i3s_converter.exe -e myFile.slpk -d oss://mySlpkBucket -a AKIAIOSFODNN7EXAMPLE -s wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -r us-west-1```
+```i3s_converter.exe -e myFile.slpk -d oss://mySlpkBucket -a AKIAIOSFODNN7EXAMPLE -s wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -r oss-us-west-1```
This command will extract the slpk to the cloud. This example uses Alibaba OSS. ### Convert and extract ```i3s_converter.exe --convert-and-extract myFile.slpk -d az://mySlpkContainer -a AKIAIOSFODNN7EXAMPLE -s wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY ```
This command will convert and extract the slpk to the cloud. This example uses Azure. + +### Validate slpk on cloud service +```i3s_converter.exe --validate az://mySlpkContainer/mySlpk.i3srest -a AKIAIOSFODNN7EXAMPLE -s wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY```
+This command will validate that an SLPK on a cloud store (i3srest) can be used and is compatible as 1.7 consumption. This example uses Azure. + +### Validate with AWS profile +```i3s_converter.exe --validate oss://mySlpkBucket/mySlpk.i3srest --aws-profile alibaba -r oss-us-west-1 ```
+This command will validate using AWS profiles, rather than entering credentials into the program. This example uses Alibaba OSS. +Note that this command will only work with AWS and OSS. +