Skip to content

Latest commit

 

History

History
96 lines (55 loc) · 2.25 KB

README.md

File metadata and controls

96 lines (55 loc) · 2.25 KB

SC MAP MERGE

This CLI utility is designed to merging stalcraft map into single image.

You can use compiled executable from Releases page.

💻 Usage

Merge Map

  1. Copy encrypted map files.

    Move map files with .ol or .mic extension to /workspace/1-encrypted directory.

    Directory /workspace must be in same location as scmapmerge.exe.

    Map files located in /pda directory of game assets.

  2. Run scmapmerge.exe.

Tip

You can use --fromassets flag to select map without manual copying.

Workspace

Create

  • Run scmapmerge.exe. Workspace directories will be created automatically.

Clear

  • Delete /workspace directory.

    or

  • Run scmapmerge.exe with --clear flag.

    This will delete all files in /workspace directory, including /workspace/3-output.

Options

  • --help Show help message.

  • -F, --filename - Output Filename. Accepts datetime formatting. Defaults to "Map %Y.%m.%d".

  • -S, --suffix - Output Format. (jpg, png, webp, tiff, bmp, dds). Defaults to jpg.

  • -P, --preset - Output Preset. (zone, newsever, underpd, ...). Defaults to None.

  • -L, --limit - Output Resolution Limit. Prevents memory overflow. Specify 0 to ignore.

  • --compress - PNG Compression Level. (0 - 9). Defaults to 6.

  • --quality - JPG/WEBP Quality %. (0 - 100). Defaults to 90.

Flags

  • -D, --clear - Clear workspace directory. Deletes all files.

  • -A, --fromassets - Select map from game assets. No need to manually copy files.

  • -N, --nopause - Removes pause before program exit.

  • --overwrite - Overwrites an existing output image.

Example

scmapmerge -N -F "Map" -S jpg -P zone --quality 100 --overwrite

🛠️ Build

Important

You will need poetry to compile. Install it from here.

Tip

Before proceeding, it's recommended to create virtual environment

poetry shell

Then install dependencies:

poetry install

And run script to compile:

poetry run build

Executable file will be created in /dist directory.