Skip to content

Latest commit

 

History

History
66 lines (57 loc) · 2.6 KB

README.md

File metadata and controls

66 lines (57 loc) · 2.6 KB
Raw

Frames_Json_Builder

Json file builder for Jahir Fiquitiva's Frames Dashboard This tool could help you create json file from wallpaper folders. Currently only works for projects hosted on GitHub. Powered by GNU Sed

Installation

Dependencies

Windows

There is currently no native script for windows. But you can use the script with WSL. (Install Ubuntu 22.04 for install exa without problem.)

sudo apt-get install nano sed exa
Ubuntu
sudo apt-get install nano sed exa

Download code and extract archive to main wallpaper folder. It should look like the following.

graph TD
A(Main repo directory)
    A --> B(frames_json_builder)
    B --> I(builder)
    B --> J(Scheme)
    B --> K(file_lists)
    B --> L[script.sh]
    A --> C(wallpaper directory)
    C --> D(collection1)
    C --> E(collection2)
    D --> F(wallpaper1)
    D --> G(wallpaper2)
    E --> H(wallpaper3)
Loading

Usage

Run script.sh

First configuration

The first time you run the script, it will check the configuration file and create it because it can't find it. You must fill in the variables on the screen that opens.

ROOT=destination of root directory of wallpapers
USERNAME=github username
REPO=github repository name
WALLFOLDER=parent directory name of the collections

After fill the variables press ctrl+x and save configuration file. Wait for the script finishes. Then your wallpapers.json file will be in root folder.

Naming scheme

  • All words must begin with a capital letter.
  • Use underscores instead of spaces.
  • There should be no spaces between numbers and words.
  • Filenames should be in the form of "Artist_Name-Wallpaper_Name.png" (The type of extension doesn't matter.)
  • For example "Osman_Onur_KOÇ-Material_You_Wp1.png"

Help

How to change Configuration file

Just delete config.cfg from file_lists directory. After run script it recreate new config file.

I'm having trouble creating the configuration file

Nano Shortcuts for how to use text editor while creating configuration file.

How to change type of wallpaper license.

Edit license line in ./Frames_Json_Builder/Scheme/Scheme.json file.

License

This source code is provided under the GPLv3 license. Script includes third party packages provided under other open source licenses, please see LICENSE for additional details.