Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rorkh/source

Source Query library for Crystal
https://github.com/rorkh/source

crystal-lang gmod source source-query-library

Last synced: 30 days ago
JSON representation

Source Query library for Crystal

Awesome Lists containing this project

README

        

# source

[Source Query](https://developer.valvesoftware.com/wiki/Server_queries) library for Crystal

[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://rorkh.github.io/source/index.html "Go to project documentation")

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
source:
github: Rorkh/source
```

2. Run `shards install`

## Usage

```crystal
require "source"

query = Source::Query.new "37.230.162.62", 27015
info = query.info

puts info.players

query.close
```

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Rorkh](https://github.com/Rorkh) - creator and maintainer