Quick start guide

Pomelo is a high-performance framework for node.js. Through some simple command, it can help you for avoid boring rehanding and underlying logic.

Installation

Install pomelo by npm(node package manager):

npm install pomelo -g

Also you can down the source code by the command of "git clone https://github.com/NetEase/pomelo.git".

Usage

Create new project

A new project can be created by two ways as follows:

first

Add path to command "pomelo init": 'pomelo init ./helloWorld'; If so, the command of "pomelo init" will automatically mkdir helloWorld and init it.

second

'mkdir helloWorld && cd helloWorld && pomelo init .'

At last, the dependencies should be installed by command "sh npm-install.sh"

A new project is made up of many folders as follows:

The directory structure corresponds to the game logic, and you can fill code in related directory.

More infomation about this directory:

game-server

game-server is game server made of pomelo and contains all of the game logic and components. In practical work,all code about game logic and components should be fill here.