q3tool 0.1.3

A Rust library for interacting with ioq3 (Quake 3) based game servers.
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


# Q3Tool

A Rust library for interacting with ioq3 (Quake 3) based game servers.

[![Rust](https://github.com/dogue/q3tool-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/dogue/q3tool-rs/actions/workflows/rust.yml)
[![GitHub issues](https://img.shields.io/github/issues/dogue/q3tool-rs.svg)](https://GitHub.com/dogue/q3tool-rs/issues/)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

## Getting Started
### Quick Example
```rust
use q3tool::Q3Tool;

fn main() {
    let q = Q3Tool::new("someserverhost:27960");
    let server_info = q.get_status().unwrap();
    
    // Print all public server c_vars
    for (k, v) in server_info.vars() {
        println!("{}: {}", k, v);
    }

    // Print all players
    for player in server_info.players() {
        println!("Name: {}, Score: {}, Ping: {}", player.name(), player.score(), player.ping());
    }
}
```

## Current Status

Q3Tool is still very early in development. So far it seems to work fine, but there are likely to be breaking changes in the future.
Error handling is currently non-existent. This is being worked on.

## Running the tests
Tests are somwhat lacking at the moment, but this is being worked on.

`cargo test`

## Versioning

We use [Semantic Versioning](http://semver.org/) for versioning.

## License

This project is licensed under the [MIT License](LICENSE)