Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mixa3607/jiggiehelios
https://jiggie.fun ToolKit
https://github.com/mixa3607/jiggiehelios
Last synced: 2 days ago
JSON representation
https://jiggie.fun ToolKit
- Host: GitHub
- URL: https://github.com/mixa3607/jiggiehelios
- Owner: mixa3607
- License: gpl-3.0
- Created: 2023-12-03T20:11:52.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2023-12-12T17:38:19.000Z (11 months ago)
- Last Synced: 2023-12-12T19:39:27.284Z (11 months ago)
- Language: C#
- Size: 46.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JiggieHelios
ToolBox for https://jiggie.fun puzzles
# Features
- Capture all traffic to jcap
- Convert jcap to json
- Render jcap to timelapse (ffmpeg+skiasharp)
- Render jcap to timelapse (ffmpeg+selenium)
- Bot (WIP)
- Easily extensible codebase
- Crossplatform
- Ready2run (release contains all dependencies)
# Download
Latest build in [Actions](../../actions) without selenium, ffmpeg, etc
Releases in [Releases](../../releases) with all deps
# HowTo
## Basic usage
Capture puzzle solving to ./jcaps directory and wait 30s after finish then convert to video with duration 1:30
Result sample see at [samples/ee8nLJ.skia](samples/ee8nLJ.skia) (jcap2video.skia) or [samples/Ol2Hdf.sel](samples/Ol2Hdf.sel) (jcap2video.sel)
```
./JiggieHelios.Cli capture -i ee8nLJ --post-delay 00:00:30 -o ./jcaps
./JiggieHelios.Cli jcap2video.skia --target-dur 00:01:30 -i ./jcaps/ee8nLJ_2023.12.02-12.36.39.jcap
```
```
./JiggieHelios.Cli capture -i Ol2Hdf --post-delay 00:00:30 -o ./jcaps
./JiggieHelios.Cli jcap2video.sel --target-dur 00:01:30-i ./jcaps/Ol2Hdf_2023.12.07-06.09.43.jcap
```
## Full help:
```console
$ ./JiggieHelios.Cli --help
Usage - -options
GlobalOption Description
Help (-?, -h, --help) Shows this help
Version (-v, --version) Show version info
Actions
Capture -options -
Option Description
WaitComplete* (--wait) Finish capturing after puzzle completed
PostCompleteDelay (--post-delay) Delay before complete capturing after puzzle completed
RoomId* (-i) Room id
OutDirectory (-o) Output directory [Default='./']
DownloadImages (-d) Download images [Default='True']
UserColor (--color) [Default='#ffa5a5']
UserLogin (--login) [Default='HELIOS-cap']
Jcap2Json -options -
Option Description
JcapFile* (-i) Jcap file
OutFile (-o) Output file. If - print to log stream
Jcap2VideoSkia -options -
Option Description
JcapFile* (-i) Jcap file
OutFile (-o) output file
Threads (-t) [Default='5']
ImagesDirectory (--img-dir)
FramesPerJob (--frames-per-job) [Default='300']
Fps (--fps) [Default='30']
SpeedMultiplier (--speedx)
TargetDuration (--target-dur) Dynamically calculate speedx. If set speedx will be ignored
CanvasSize (--canvas-size) [Default='1920x0']
CanvasFill (--canvas-fill) [Default='#FFFFFF']
FfmpegInArgs (--ffmpeg-in) [Default='']
FfmpegOutArgs (--ffmpeg-out) [Default='-c:v libx264 -vf scale=1920:-2,format=yuv420p']
Jcap2VideoSel -options -
Option Description
JcapFile* (-i) Jcap file
OutFile (-o) output file
ImagesDirectory (--img-dir)
Fps (--fps) [Default='30']
SpeedMultiplier (--speedx)
TargetDuration (--target-dur) Dynamically calculate speedx. If set speedx will be ignored
PostDelay (--post-delay)
CanvasSize (--canvas-size) [Default='1920x-2']
CanvasFill (--canvas-fill) [Default='#5f9ea0']
FfmpegInArgs (--ffmpeg-in) [Default='']
FfmpegOutArgs (--ffmpeg-out) [Default='-c:v libx264 -preset slower -b:v 2M -c:a libopus -b:a 64K -preset slow']
Bot -options -
Option Description
WaitComplete (--wait) Exit after puzzle completed
PostCompleteDelay (--post-delay) Delay before exit after puzzle completed
RoomId* (-i) Room id
Secret* (-s) Room secret
Admin* (-a) Room administrator
StateFile (--state) Bot state file [Default='bot.json']
UserColor (--color) [Default='#ffa5a5']
UserLogin (--login) [Default='HELIOS-bot']
```
## Limitations
- Selenium render not support headless mode
## `appsettings.json` and `appsettings.<>.json`
Default values and some settings can be configured with appsettings files. By default used `appsettings.json` and `appsettings.Production.json`. `Production` is value of `DOTNET_ENVIRONMENT` env variable.
```sh
> $env:DOTNET_ENVIRONMENT="AnyEnvName" #for windows
> export DOTNET_ENVIRONMENT=AnyEnvName #for NIX
```
FFmpeg bin can be set in appsettings if not in PATH. See `appsettings.Custom1.json` file.
```json
"ffmpeg": {
"BinaryFolder": "path/to/ffmpeg/bin",
"TemporaryFilesFolder":"path/to/tmp/files"
}
```
With appsettings default values for cli actions may be overriden.
```json
"Cli": {
"DefaultValues": {
"Jcap2VideoSkia": { //action name
"Threads": 36 //arg value
},
"Capture": { //action name
"WaitComplete": true, //arg value
"PostCompleteDelay": "00:00:30", //arg value
"OutDirectory": "./jcaps", //arg value
"DownloadImages": true, //arg value
"UserColor": "#13a10e" //arg value
}
}
}
```