Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 1.51 KB

README.md

File metadata and controls

74 lines (54 loc) · 1.51 KB
Raw

fleet_app_client

A crystal API client to interact with the Hostari fleet.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  fleet_app_client:
    github: hostari/fleet_app_client

  2. Run shards install

Usage

require "fleet_app_client"

Build a new FleetApp client.

client = FleetApp::Client.new

Resource Methods

Start a Server

FleetApp::Server.start("2012197.xyz", "valheim", "1234")

Stop a Server

FleetApp::Server.stop("2012197.xyz", "valheim", "1234")

Restart a Server

FleetApp::Server.restart("2012197.xyz", "valheim", "1234")

Create a Server

FleetApp::Server.create("2012197.xyz", "valheim", "1234")

Get Server Details (For Other Games)

FleetApp::Server.get_details("2012197.xyz", "valheim", "1234")

Get CoreKeeper Game ID

FleetApp::Server.get_details("2012197.xyz", "core_keeper", "1234")

Contributing

  1. Fork it (https://github.com/your-github-user/fleet_app_client/fork)
  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