Skip to content

Commit

Permalink
document use of cicdec and mono for Clickteam extraction
Browse files Browse the repository at this point in the history
  • Loading branch information
memo33 committed Apr 14, 2024
1 parent 99ccefa commit 04435a7
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ target/
/cache/
/temp/
/plugins/
/cicdec/
sc4pac-plugins.json
sc4pac-plugins-lock.json
sc4pac-credentials.properties
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Changelog

## [Unreleased]
### Added
- support for extracting Clickteam exe-installers using the external program `cicdec.exe`.
On macOS and Linux, this requires [mono](https://www.mono-project.com/docs/getting-started/install/) to be installed on your system.
Assets containing Clickteam installers must include the new `archiveType` property in the metadata.

### Changed
- decreased caching period of channel table-of-contents file from 24 hours to 30 minutes to receive package updates sooner

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Currently, this program only comes with a command-line interface (CLI).
- Prerequisites:
- Java 8+ (https://adoptium.net/installation/)
- enough disk space
- Mono ([macOS](https://www.mono-project.com/docs/getting-started/install/)/[Linux](https://repology.org/project/mono/versions), not needed on Windows):
This is optional and only needed for a few packages that originally use an installer.
- [Download the latest release](https://github.com/memo33/sc4pac-tools/releases/latest)
and extract the contents to any location in your user directory (for example, your Desktop).
- Open a shell in the new directory (e.g. on Windows, open the folder and type `cmd` in the address bar of the explorer window)
Expand Down
4 changes: 4 additions & 0 deletions channel-testing/template-empty.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,7 @@ assetId: "<unique-id>"
version: "<version>"
lastModified: "<ISO-8601-timestamp>"
url: "<asset-url>"

# archiveType:
# format: Clickteam
# version: "40" # possible versions are 40, 35, 30, 24, 20
5 changes: 5 additions & 0 deletions channel-testing/yaml/templates/package-template-basic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ lastModified: "2023-07-29T21:33:57Z"
# The direct download link to the artifact (supports zip files, jar files, and jar, zip, 7z or NSIS exe files contained in zip files)
url: "http://localhost:8090/files/package-d.zip"

# Assets containing a Clickteam exe-installer need to include this `archiveType` section with the correct installer version number:
# archiveType:
# format: Clickteam
# version: "40" # possible versions are 40, 35, 30, 24, 20

---
# The following section describes a package.
# Packages are collections of files that can be installed on user request.
Expand Down
3 changes: 3 additions & 0 deletions src/scripts/dist.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ VERSION=$(sed build.sbt -ne 's/^ThisBuild \/ version := .\(.*\)./\1/p')
OUT="target/dist/sc4pac-${VERSION}.zip"
rm -f "$OUT"
zip --junk-paths "$OUT" target/scala-3.3.0/sc4pac-cli.jar src/scripts/sc4pac src/scripts/sc4pac.bat README.md

# cicdec was manually installed at ./cicdec/ and is bundled with our software
zip -r "$OUT" cicdec

0 comments on commit 04435a7

Please sign in to comment.