/windows-10-lock-screen-image-extractor

Extract the beautiful images from Windows 10's lock screen

Primary LanguageJavaScript

Startup LockScreen Extractor for Windows 10

build Codacy Badge

Introduction

A tiny cli app to extract gorgeous lock screen images on Windows 10.

Installation

As a node package

Required: Nodejs

Open terminal/cmd, run:

npm install -g windows-10-lock-screen-image-extractor

As windows binary

Download the latest version here

Features

  • Get lock screen images: Get all lock screen images then save them to a designated folder. You can choose to pick landscape or portrait images only. Or reformat images’s name by day, hash
  • Randomize desktop wallpaper: Randomly pick an image you saved before and set it as desktop wallpaper
  • Show image saved folder: Recall path to saved folder in case you forget

Usage

1. Get lock screen images

  1. Run command: get-lock-screen get-images
  2. Answer configuration questions
  3. Ctrl + click on the path to open images folder in explorer (supported by all popular terminal/console except Windows's Power Shell and cmd)

Settings

Passing one or multiple arguments to change the command’s behavior

Argument Required Default Description Example
--path, -p No C:\Users...\Pictures\W10_Spotlight\ Save images to a designated folder get-lock-screen get-image -p=”D:/images”
--orientation,
-o		 No all Filter landscape, portrait images only or get all of them
Possible values:
- landscape
- portrait
- all		 get-lock-screen get-image -o=landscape
--name-pattern,
-n		 No origin Save images name in different formats
Possible values:
- hash: file’s hash
- date: current date
- origin: original name		 get-lock-screen get-image -no=origin

2. Randomize desktop wallpaper

  • Run command: get-lock-screen randomize-desktop
  • The app may remind you to get the images in advance on the first run.

3. Show image saved folder

Run command: get-lock-screen show-settings

Support

If you have any problems running the apps, feel free to open an issue. We will tackle it right away.

Contributing

1. Opening an issue

  • Check Issues section to avoid duplication
  • Provide additional information following the template

2. Open pull request

1. Fork and clone repo

  • Fork repo
  • Clone forked repo to your machine

2. Install dependencies

Required: Node.js, yarn

  • Run yarn install

3. Update code and document

  • Update code
  • Check lint errors: yarn run lint:scripts
  • Update README.md about your changes

4. Update test

  • Write new test cases for your code.
  • All tests are located at folder tests/**
  • Run tests: yarn run test:unit

5. Submit pull request for review

  • Submit a PR from your forked repo to pass-team’s.
  • Provide PR’s information following the template