README

JaxWilko.Game

A Winter CMS plugin that provides a multiplayer game engine running in PHP for 2D sprite based games using HTML5 Canvas and WebSockets.

Features

Browser based
Multiplayer
Quests
Items
Inventory
Level Editor
Scriptable Entities
Scriptable Triggers
Scriptable Item Objects
Scriptable Inventory Objects
Scriptable Sprites
Teleporters (local & cross level)
Entity AI (multiple modes)

Requirements

php >= 8.2
ext-posix
ext-pcntl
ext-sockets

Install

composer require jaxwilko/wn-game-plugin
php artisan migrate
php artisan mix:install
php artisan mix:compile -f -p jaxwilko.game
php artisan game:publish

For a detailed installation guide including server configuration and level editing, see: Getting Started.

Running

To run the game server with the demo level, execute:

php artisan game:serve -f -m demo

The game server can be started via the backend control panel or via the CLI (in both fg and daemonized modes). See the help page for details:

php artisan game:serve -h

Why?

I thought it would be funny and nobody stopped me, for more see development notes.

Thanks

_{Luke Towers}

Putting up with my rambling, testing and reviewing

_{Robert Alexa}

Listening to me complain about pathing logic

_{Josh Gaby}

Patching Ratchet for php8

jaxwilko / wn-game-plugin

Maintainers

Details