condini-mastheus / the-duel

Open source PvP game. Inspired by Retimed

The Duel

---

Getting Started

To clone and run this template, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/condini-mastheus/the-duel

# Go into the repository
$ cd the-duel

# Install dependencies
$ npm install

# Fire up the project
$ npm start

Client

All your game code lies inside the /src/client/scripts folder. All assets need to be inside the /src/client/assets folder in order to get copied to /dist/client while creating the production build. Do not change the name of the index.html and game.ts files.

# Start the local development server (on port 8080)
$ npm run client:dev

# Ready for production?
# Build the production ready code to the /dist/client folder
$ npm run client:build

# Play your production ready game in the browser
$ npm run client:up

Server

All your server code lies inside the /src/server folder. We are using Colyseus to handle multiplayer and monitor the application.

# Start the local colyseus server (on port 2567)
$ npm run server:dev

# Ready for production?
# Build the production ready code to the /dist/server folder
$ npm run server:build

# Serve your production ready colyseus local server
$ npm run server:up

Custom Configurations

TypeScript Compiler

Change the TypeScript compiler's settings in the tsconfig.json file.

If you are new to TypeScript, you maybe want to set "noImplicitAny" to false.

You'll find more information about the TypeScript compiler here.

Typings

You can put your custom type definitions inside typings/custom.d.ts.

Webpack

All webpack configs are in the webpack folder.

Obfuscation

Obfuscation is disabled by default.

We are using the webpack-obfuscator. Change its settings in webpack/webpack.prod.js if needed. All available options are listed here.

Useful Links

• Phaser Website
• Phaser 3 Forum
• Phaser 3 API Docs
• Official Phaser 3 Examples
• Notes of Phaser 3
• Colyseus Docs
• Project Template
• Multiplayer with Physics

Credits

• A huge thank you to Rich @photonstorm for creating Phaser

• A huge thank you to Yannick Deubel @yandeu for creating this template

• A huge thank you to Endel Dreyer @endel for creating Colyseus