PHPackages                             pschilly/dcs-server-bot-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. pschilly/dcs-server-bot-api

ActiveLibrary[API Development](/categories/api)

pschilly/dcs-server-bot-api
===========================

This package acts as an interface service for the DCS Server Bot RestAPI in order to access information from the bot on a remote web server for display purposes.

0.3.1(8mo ago)0144[3 PRs](https://github.com/pschilly/dcs-server-bot-api/pulls)1MITPHPPHP ^8.2CI passing

Since Aug 18Pushed 4mo agoCompare

[ Source](https://github.com/pschilly/dcs-server-bot-api)[ Packagist](https://packagist.org/packages/pschilly/dcs-server-bot-api)[ Docs](https://github.com/pschilly/dcs-server-bot-api)[ GitHub Sponsors](https://github.com/Pschilly)[ RSS](/packages/pschilly-dcs-server-bot-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (13)Versions (17)Used By (1)

Laravel DCS Server Bot API Service
==================================

[](#laravel-dcs-server-bot-api-service)

[![Packagist Version](https://camo.githubusercontent.com/fdd106eb388ee7c34e14ff92ed01bd397ca3afc7c8d723fb55277290bded7928/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f70736368696c6c792f6463732d7365727665722d626f742d6170693f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/pschilly/dcs-server-bot-api)[![GitHub Actions Workflow Status](https://camo.githubusercontent.com/57edc6a233080400b55ee44bf4fa02bb0586eb3e854bb3bed2e47ad5ccc92e37/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f70736368696c6c792f6463732d7365727665722d626f742d6170692f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e267374796c653d666f722d7468652d6261646765)](https://github.com/pschilly/dcs-server-bot-api/actions/workflows/phpstan.yml)[![DCSServerBot](https://camo.githubusercontent.com/ab946f671f2568e8b439e457d8eb1d0d60994e52e844411a712f768dc1fdfb62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2546302539462541342539365f52657175697265732d4443535f5365727665725f426f742d677265656e3f7374796c653d666f722d7468652d6261646765)](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot)[![Laravel v12 Required](https://camo.githubusercontent.com/df238df82918e42be8a74b41d68fa6b5b42d92644441f6362c17c02b194f6f6f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d7631322d4646324432303f7374796c653d666f722d7468652d6261646765266c6f676f3d6c61726176656c266c6f676f436f6c6f723d7768697465)](https://laravel.com)

This package acts as an interface service for the DCS Server Bot RestAPI in order to access information from the bot on a remote web server for display purposes.

In order for this to be function, you must already have the [DCS Server Bot](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot) setup and running, including the following plugin / service:

- RestAPI [Docs](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/plugins/restapi/README.md)
- WebService [Docs](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/services/webservice/README.md)

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require pschilly/dcs-server-bot-api
```

Configuration
-------------

[](#configuration)

In order for the service to know where to make the API calls you must identify where the API server is located. By default, the service will look for `http://localhost:9876` - this is only going to be useful if you are running your website on the same server as the **master node** of the DCS Server bot.

To alter this default URL, run one of the following commands:

```
php artisan dcs-server-bot-api:install
```

```
php artisan dcs-server-bot-api:install --url="http://localhost:9867" [--force]
```

Although possible, it is not necessary to publish the config file given that the singular config parameter is pulled from your applications .env. Never the less, this is the command and contents of the published config file:

```
php artisan vendor:publish --tag="dcs-server-bot-api-config"
```

```
return [

    /*
    |--------------------------------------------------------------------------
    | DCS Bot API URL
    |--------------------------------------------------------------------------
    |
    | This value is the base URL for the DCS Bot API, which will be used when
    | making requests to the API endpoints.
    |
    | See documentation of DCS Server Bot API for more details & configuration on your actual DCS Server Bot.
    |   WebService: https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/services/webservice/README.md
    |   RestAPI: https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/plugins/restapi/README.md
    |
    */

    'base_url' => env('DCS_BOT_API_URL', 'http://localhost:9876'),

];
```

Usage
-----

[](#usage)

Import the model:

```
use Pschilly\DcsServerBotApi\DcsServerBotApi;
```

Call the endpoint that you need based on the [DCS Server Bot RestAPI Docs](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/plugins/restapi/README.md), eg:

```
$data = DcsServerBotApi::getServerStats();
```

This will give you a json array that you can then do with what you please!

For more information on the API - you can enable "debug" mode on your WebService plugin where you will then be able to hit the API server with the following link `http://localhost:9678/docs` and get a full rundown on the API calls.

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

TODO
----

[](#todo)

- Add Caching Support

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Schilly](https://github.com/pschilly)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance69

Regular maintenance activity

Popularity10

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

13

Last Release

260d ago

PHP version history (2 changes)v0.1PHP ^8.3

0.3.1PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/3d11f5f96a4899c9df8dfa8bf9fef51dcdeb638b5f3f9e7d241a2f07d49c49dc?d=identicon)[Pschilly](/maintainers/Pschilly)

---

Top Contributors

[![pschilly](https://avatars.githubusercontent.com/u/307222?v=4)](https://github.com/pschilly "pschilly (76 commits)")

---

Tags

api-interfacedcsdcs-server-botlaravellaravelpschillydcs-server-bot-api

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/pschilly-dcs-server-bot-api/health.svg)

```
[![Health](https://phpackages.com/badges/pschilly-dcs-server-bot-api/health.svg)](https://phpackages.com/packages/pschilly-dcs-server-bot-api)
```

###  Alternatives

[dedoc/scramble

Automatic generation of API documentation for Laravel applications.

2.0k7.8M57](/packages/dedoc-scramble)[scalar/laravel

Render your OpenAPI-based API reference

6183.9k2](/packages/scalar-laravel)[ryangjchandler/bearer

Minimalistic token-based authentication for Laravel API endpoints.

8129.8k](/packages/ryangjchandler-bearer)[combindma/laravel-facebook-pixel

Meta pixel integration for Laravel

4956.9k](/packages/combindma-laravel-facebook-pixel)[stechstudio/laravel-hubspot

A Laravel SDK for the HubSpot CRM Api

2971.0k](/packages/stechstudio-laravel-hubspot)[njoguamos/laravel-plausible

A laravel package for interacting with plausible analytics api.

208.8k](/packages/njoguamos-laravel-plausible)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)