{"id":36970176,"url":"https://github.com/pschilly/dcs-server-bot-api","last_synced_at":"2026-01-13T21:45:20.981Z","repository":{"id":310538667,"uuid":"1040250233","full_name":"pschilly/dcs-server-bot-api","owner":"pschilly","description":"A Laravel interface for the DCS Server Bot RestAPI by Special-K","archived":false,"fork":false,"pushed_at":"2025-08-31T20:30:36.000Z","size":61,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-08T04:01:01.333Z","etag":null,"topics":["api-interface","dcs","dcs-server-bot","laravel"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pschilly.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"Pschilly"}},"created_at":"2025-08-18T17:23:52.000Z","updated_at":"2025-08-31T20:30:10.000Z","dependencies_parsed_at":"2025-08-18T19:33:36.116Z","dependency_job_id":"9f837061-8357-4e5c-84d9-461cbb2c3b06","html_url":"https://github.com/pschilly/dcs-server-bot-api","commit_stats":null,"previous_names":["pschilly/laravel-dcs-server-bot-api"],"tags_count":13,"template":false,"template_full_name":"spatie/package-skeleton-laravel","purl":"pkg:github/pschilly/dcs-server-bot-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschilly%2Fdcs-server-bot-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschilly%2Fdcs-server-bot-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschilly%2Fdcs-server-bot-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschilly%2Fdcs-server-bot-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pschilly","download_url":"https://codeload.github.com/pschilly/dcs-server-bot-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschilly%2Fdcs-server-bot-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28401078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T14:36:09.778Z","status":"ssl_error","status_checked_at":"2026-01-13T14:35:19.697Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-interface","dcs","dcs-server-bot","laravel"],"created_at":"2026-01-13T21:45:20.402Z","updated_at":"2026-01-13T21:45:20.975Z","avatar_url":"https://github.com/pschilly.png","language":"PHP","readme":"# Laravel DCS Server Bot API Service\n\n[![Packagist Version](https://img.shields.io/packagist/v/pschilly/dcs-server-bot-api?style=for-the-badge)](https://packagist.org/packages/pschilly/dcs-server-bot-api)\n[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/pschilly/dcs-server-bot-api/fix-php-code-style-issues.yml?branch=main\u0026style=for-the-badge)](https://github.com/pschilly/dcs-server-bot-api/actions/workflows/phpstan.yml)\n[![DCSServerBot](https://img.shields.io/badge/🤖_Requires-DCS_Server_Bot-green?style=for-the-badge)](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot)\n[![Laravel v12 Required](https://img.shields.io/badge/Laravel-v12-FF2D20?style=for-the-badge\u0026logo=laravel\u0026logoColor=white)](https://laravel.com)\n\nThis 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.\n\nIn 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:\n\n-   RestAPI [Docs](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/plugins/restapi/README.md)\n-   WebService [Docs](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/services/webservice/README.md)\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require pschilly/dcs-server-bot-api\n```\n\n## Configuration\n\nIn 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.\n\nTo alter this default URL, run one of the following commands:\n\n```bash\nphp artisan dcs-server-bot-api:install\n```\n\n```bash\nphp artisan dcs-server-bot-api:install --url=\"http://localhost:9867\" [--force]\n```\n\nAlthough 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:\n\n```bash\nphp artisan vendor:publish --tag=\"dcs-server-bot-api-config\"\n```\n\n```php\nreturn [\n\n    /*\n    |--------------------------------------------------------------------------\n    | DCS Bot API URL\n    |--------------------------------------------------------------------------\n    |\n    | This value is the base URL for the DCS Bot API, which will be used when\n    | making requests to the API endpoints.\n    |\n    | See documentation of DCS Server Bot API for more details \u0026 configuration on your actual DCS Server Bot.\n    |   WebService: https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/services/webservice/README.md\n    |   RestAPI: https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot/blob/master/plugins/restapi/README.md\n    |\n    */\n\n    'base_url' =\u003e env('DCS_BOT_API_URL', 'http://localhost:9876'),\n\n];\n```\n\n## Usage\n\nImport the model:\n```php\nuse Pschilly\\DcsServerBotApi\\DcsServerBotApi;\n```\n\nCall 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:\n\n```php\n$data = DcsServerBotApi::getServerStats();\n```\n\nThis will give you a json array that you can then do with what you please!\n\nFor 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.\n\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## TODO\n\n-   Add Caching Support\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n-   [Schilly](https://github.com/pschilly)\n-   [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","funding_links":["https://github.com/sponsors/Pschilly"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschilly%2Fdcs-server-bot-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpschilly%2Fdcs-server-bot-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschilly%2Fdcs-server-bot-api/lists"}