# pollenwall

<details open>
  <summary>Table of Contents</summary>

- [pollenwall](#pollenwall)
  - [About](#about)
  - [Installation](#installation)
    - [Binary releases](#binary-releases)
    - [Build from source](#build-from-source)
  - [Usage](#usage)
    - [Command Line Arguments](#command-line-arguments)
  - [App Folder](#app-folder)
  - [Road Map](#road-map)
  - [Changelog](#changelog)
  - [License](#license)
  - [Copyright](#copyright)

</details>

## About

**pollenwall** is a little command line app which sets your wallpaper with incoming image generating pollens once they arrive from [pollinations.ai](https://pollinations.ai/c/Anything).

## Installation

After downloading, add it to an appropriate place in your file system which is included in your `PATH` variable and run `pollenwall` in command line.

If you wish you can navigate to the folder where `pollenwall` is and run it like the following `./pollenwall`.

If mac doesn't let you run the app please remove the extended attributes on the app.
`xattr -d com.apple.quarantine <path-to-app>`

### Binary releases

Check the [releases page](https://github.com/pollinations/pollenwall/releases) to download `pollenwall`.

### Build from source

You need [Rust](https://www.rust-lang.org/tools/install) to be installed on your system to build `pollenwall`.

For doing a debug build just run `cargo build` in repository root.
For doing a release build just run `cargo build --release` in repository root.

> I have only tested building on an arm based mac, if you have issues building or running on other platforms please create an issue and I'll test and add instructions.

If you're using a mac and want to cross compile to all supported platforms as well as build a universal binary for mac you may use [cargo-make](https://github.com/sagiegurari/cargo-make).

```bash
cargo install --force cargo-make
```

Setup your environment

```bash
cargo make install-targets
cargo make setup-cross-compilation-environment-mac-host
```

Build for all supported platforms

```bash
cargo make build
```

> For more granular control you may check `Makefile.toml`

Alternatively you may use [just](https://github.com/casey/just)

Setup your environment

```bash
just prepare-mac
```

Build for all supported platforms

```bash
just build
```

Outputs could be found in `target` folder.

## Usage

Just run the app, it is as simple as that.

Hint: Don't forget to try the attach mode! `pollenwall -a`

### Command Line Arguments

```
pollenwall [OPTIONS]
```

**Options:**

```
-a, --attach            Attach to a random processing pollen until its evolution is done.
    --address <addr>    You may give a custom address to pollinations ipfs node.
-c, --clean             Remove images in "~/.pollen_wall" directory.
-h, --help              Print help information
    --home <home>       If "pollen_wall" couldn't determine your home directory, to help it
                        please run it with "--home <absolute-path-to-your-home-directory>"
-V, --version           Print version information
```

## App Folder

App folder where `pollenwall` stores the pollens is located in your home directory with the name `.pollen_wall`.

## Road Map

- [ ] Download other artifacts about a pollens (in progress)
- [ ] Give option to exclude or include different models in attach mode
- [x] Show the count of processing pollens in the app output
- [x] Make pollen storage volatile
- [x] Support Windows
- [x] Support Linux
- [x] Add attach to processing pollen mode
- [ ] Support video or `GIF` wall papers in supported platforms
- [ ] Add a run at startup option
- [ ] Publish to package managers for easy installation

## Changelog

All notable changes to this project will be documented under this part.

- 0.2.0
  - Count of processing pollens in the output
  - Attach mode
  - Volatile storage
  - Support Windows
  - Support Linux (x86_64, ARM)
- 0.1.0
  - Initial release

## License

[MIT License](https://en.wikipedia.org/wiki/MIT_License)

## Copyright

Copyright © 2021, [pollinations-contributors](https://github.com/orgs/pollinations/people)