mzx / dgt

decentralized-game-template

Fork this repo or click the Use this template button above to start using the template.

Installation

• Make sure you have Node.js ≥ 12 installed (https://nodejs.org)
• Install dependencies: npm install

Running The Example Game

The repo includes the example Breakout game from Phaser 3.0.

• npm start: Run the game locally

Deployment

Deploying on Github Pages

The game can be easily deployed via the Github Pages Settings Page, using the root folder.

Deploying on IPFS

To deploy on IPFS we need to do the following steps:

• Retrieve API keys from Pinata

  • PINATA_API_KEY
  • PINATA_API_SECRET_KEY

• Input these keys as Repository Secrets

• Go to the Release Workflow on Github Actions and click Run Workflow

• The game is now deployed and can be accessed using the IPFS gateways listed on the Release Notes

Contributing

We hope to improve the template with your help! The Github Discussions is a great way to get started.