Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.
/ phaser3-bta-tpe Public archive

A beat'em up game connected with Twitch Api through an extension, using Phaser3 and Typescript.

License

Notifications You must be signed in to change notification settings

jmcartlamy/phaser3-bta-tpe

Repository files navigation

Phaser3 Beat'em up - Twitch Plays Experience

A beat'em up browser game connected with Twitch Api through an extension, using Phaser3 and Typescript.

This repository is a Phaser3 game with ES6 & Typescript supports that includes hot-reloading for development and production-ready builds.

Connect with Twitch

Phaser3 Beat'em up is built with Interactive Sync, a ready-to-use Twitch extension promoting interactions.

Register your application

Connect on Twitch Developers and register an application to use Twitch API.

  1. Set a name, the following OAuth redirect url http://localhost:8080 and after the registration, you will get an Client ID.
  2. Click to manage your application and create a new Client Secret
  3. Save your Client ID / Secret for the environment variables

Register a new Twitch extension

  1. Go on Interactive Sync Front and follow the instructions
  2. Use Developer Rig to preview the result

Create a local server for EBS

  1. Go on Interactive Sync EBS and follow the instructions
  2. On start, the server will running at localhost:8081

Play the game

Setting environment variables

Create a .env file with this template:

EXT_CLIENT_ID=YOUR_CLIENT_ID
EXT_CLIENT_SECRET=YOUR_CLIENT_SECRET
EXT_HOST=YOUR_HOST

EXT_HOST must follow this structure - //YOUR_HOST/ - and is to be defined when you deploy the game on the website.

Launch the game

On the repository, run yarn start:prod to launch the game in ready-to-use mode.

Open your browser (100% compatibility with Mozilla Firefox) and go on localhost:8080. You can connect the game with your twitch channel.

Available Commands

Command Description
yarn install Install project dependencies
yarn start For development only
yarn start:prod Build project in ready-to-use mode with your twitch channel
yarn build Output the bundle and assets

About

A beat'em up game connected with Twitch Api through an extension, using Phaser3 and Typescript.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published