gcmh 0.2.0

A CLI tool to improve your custom maps on generals.io.
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

# gcmh


[![](https://img.shields.io/github/actions/workflow/status/jwcub/gcmh/rust.yml)](https://github.com/jwcub/gcmh/actions)
[![](https://img.shields.io/crates/v/gcmh)](https://crates.io/crates/gcmh)
[![](https://img.shields.io/crates/d/gcmh)](https://crates.io/crates/gcmh)
[![](https://img.shields.io/github/license/jwcub/gcmh)](https://github.com/jwcub/gcmh/blob/main/LICENSE)

**G**enerals **C**ustom **M**aps **H**elper

`gcmh` is a CLI tool to improve your custom maps on [generals.io](https://generals.io).

**Note: This project is currently work in progress. Some features are missing and will be implemented soon.**

## Usage


```plaintext
$ gcmh --help
A CLI tool to improve your custom maps on generals.io.

Usage: gcmh.exe [OPTIONS] <COMMAND>

Commands:
  search  Search for maps
  upvote  Upvote a map
  play    Play a map
  help    Print this message or the help of the given subcommand(s)

Options:
  -m, --map <MAP>            Map name [default: "1*1 Ultimate"]
  -c, --count <COUNT>        Operations count [default: 10]
  -i, --interval <INTERVAL>  Interval (ms) between two operations [default: 1606]
  -v, --verbose...           More output per occurrence
  -q, --quiet...             Less output per occurrence
  -h, --help                 Print help
  -V, --version              Print version
```

## Examples

- Search for three maps in keyword `maze`:
    ```sh
    $ gcmh -m maze -c 3 search

    ```

- Add 1606 upvotes to a map:
    ```sh
    $ gcmh -m "1*1 Ultimate" -c 1606 upvote

    ```

- Play a map for 161 times:
    ```sh
    $ gcmh -m "[From Kana]Maze 2" -c 161 play

    ```

## Installation


### Installing from Crates.io (Recommended)

```sh
$ cargo install gcmh
$ gcmh --version
gcmh 0.2.0
```

### Building from Source

```sh
$ git clone https://github.com/jwcub/gcmh
$ cd gcmh
$ cargo build --release
$ ./target/release/gcmh --version
gcmh 0.2.0
```

## License

This project is licensed under the [Unlicense](https://github.com/jwcub/gcmh/blob/main/LICENSE).