https://github.com/thinkverse/parakeet
Asynchronous multiplayer game provider written in Laravel 8
https://github.com/thinkverse/parakeet
Last synced: 4 months ago
JSON representation
Asynchronous multiplayer game provider written in Laravel 8
- Host: GitHub
- URL: https://github.com/thinkverse/parakeet
- Owner: thinkverse
- License: mit
- Created: 2021-06-18T23:40:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-19T00:03:53.000Z (almost 5 years ago)
- Last Synced: 2025-01-23T10:13:08.439Z (over 1 year ago)
- Homepage:
- Size: 354 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Parakeet
Parakeet provides an asynchronous server implementation for multiplayer games via a HTTP based API. Built on Laravel 8 it is easily extended and modified to suit your games specific needs.
Out of the box, Parakeet can support user authentication, creating and joining games as well as a basic matchmaking system.
## Features
* User authentication and authorization supported by Laravel's Sanctum
* Game creation
* Basic matchmaking - join an available game or create one if none are available
* Player seat numbering (for example, seating players around a poker table)
* Game data synchronisation between clients
## Installation
1. Download this repository
2. Use composer to install the dependencies
```composer install```
3. Create a copy of ```env.example``` and save as ```.env```
4. Modify your ```.env``` file to suit your project
5. From the command line, run ```php artisan key:generate``` to generate a new application key
6. Serve up your project!
## Contributing
Please feel free to contribute to this project by creating a pull request with details of your changes or additions to the project.