https://github.com/hostari/fleet_app_client
A crystal API client to interact with the Hostari fleet.
https://github.com/hostari/fleet_app_client
Last synced: about 1 year ago
JSON representation
A crystal API client to interact with the Hostari fleet.
- Host: GitHub
- URL: https://github.com/hostari/fleet_app_client
- Owner: hostari
- License: mit
- Created: 2022-05-13T08:29:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T22:54:49.000Z (about 2 years ago)
- Last Synced: 2025-01-24T22:41:24.909Z (over 1 year ago)
- Language: Crystal
- Homepage: https://hostari.github.io/fleet_app_client/
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fleet_app_client
A crystal API client to interact with the Hostari fleet.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
fleet_app_client:
github: hostari/fleet_app_client
```
2. Run `shards install`
## Usage
```crystal
require "fleet_app_client"
```
Build a new FleetApp client.
```crystal
client = FleetApp::Client.new
```
## Resource Methods
Start a Server
```crystal
FleetApp::Server.start("2012197.xyz", "valheim", "1234")
```
Stop a Server
```crystal
FleetApp::Server.stop("2012197.xyz", "valheim", "1234")
```
Restart a Server
```crystal
FleetApp::Server.restart("2012197.xyz", "valheim", "1234")
```
Create a Server
```crystal
FleetApp::Server.create("2012197.xyz", "valheim", "1234")
```
Get Server Details (For Other Games)
```crystal
FleetApp::Server.get_details("2012197.xyz", "valheim", "1234")
```
Get CoreKeeper Game ID
```crystal
FleetApp::Server.get_details("2012197.xyz", "core_keeper", "1234")
```
## 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
- [Pauline De Polonia](https://github.com/paula4230) - creator
- [Manuel Tinio](https://github.com/Weltinio) - maintainer
- [Xavi Ablaza](https://github.com/xaviablaza) - maintainer
- [Rafael Cadorna](https://github.com/jcads) - maintainer