zeeper 1.2.2

a playlist tool for zeepkist
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# Zeeper

<!--toc:start-->
- [Zeeper](#zeeper)
  - [Description](#description)
  - [Getting Started](#getting-started)
    - [Dependencies](#dependencies)
    - [Installation](#installation)
      - [Cargo](#cargo)
      - [Binary](#binary)
    - [Executing Program](#executing-program)
  - [Help](#help)
  - [Author](#author)
  - [Version history](#version-history)
  - [License](#license)
  - [Acknowledgements](#acknowledgements)
<!--toc:end-->

A playlist tool for Zeepkist

## Description
Zeeper allows you to create a playlist from GTR data, you can get your favorite maps, random maps, hot and popular too.

## Getting Started
### Dependencies
 - install rust/cargo <https://www.rust-lang.org/tools/install>

### Installation

#### Cargo
`cargo install zeeper`

if you're building from source `cargo install --path /path/to/repo`

#### Binary
download binary from releases, put in `~/.local/bin/zeeper` if on Linux, if on Windows IDK.

### Executing Program
in the terminal run `zeeper [OPTIONS] <CMD>`

## Help
helper command `zeeper help [SUBCMD]`
if levels don't load, that is a steam/Zeepkist issue. Or they changed file formats :3

## Author
me

## Version history
 - 0.1.0 
    * favorites
    * random
    * hot
    * popular
 - 1.0.0 
    * windows/mac support (just changed to Path instead of strings to write the file)
 - 1.1.0
    * now can get levels from records
    * updated hot and popular, now can take limit and offset args
 - 1.1.1 
    * I forgot to remove an early return lol
 - 1.1.2
    * streamlined inner workings in prep for possible GUI
 - 1.2.0
    * now uses Zworpshop where possible (only random tracks) (can use GTR with -G)
    * added macros to use internally
 - 1.2.1
    * finally updated to new web API, so it works now
    * removed arguments that are no longer used
    * ZEEP_PLAYLIST_DIR env variable is used, so you don't have to specify output Dir
    * Favorites limit default is now 100
    * Hot and Popular no longer have arguments due to new GTR/Zworpshop API
    * updated macros for new web API's
    * little extra info outputted
 - 1.2.2
    * removes duplicate tracks based on track UID

## License
This project is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0) license - see [LICENSE](LICENSE.txt) file for details.

## Acknowledgements
ThunderNerd for creating [GTR](https://zeepkist-gtr.com) and [zworpshop](https://api.zworpshop.com/)