Documentation

Getting Started

• [Welcome to Pomelo] (Welcome-to-Pomelo "Welcome-to-Pomelo")
• [Installation] (Installation "Installation")
• [HelloWorld of Pomelo] (HelloWorld-of-Pomelo "HelloWorld-of-Pomelo")

Overview

• [Design Motivation] (Pomelo-design-motivation "Pomelo-design-motivation")
• [Framework Overview] (Pomelo-framework-overview "Pomelo-framework-overview")
• [Tools & Libraries] (Pomelo-tools-libraries-introduction "Pomelo-tools-libraries-introduce")
• [Client Platform Support] (client-platform-supported "client-platform-supported")

Tutorial

• [Preface] (Preface "Preface")
• [Terminologies] (Terminologies "Terminologies")
• [Chat Source Code & Installation] (Getting-Source-Code-&-Installation "Getting-Source-Code-&-Installation")
• [Server Scalability] (Server-Scalability "Server-Scalability")
• [Adding a Filter] (Adding-a-Filter "Adding-Filter")
• [Route Compression] (Route-Compression "Route-Compression")
• [Protobuf Compression] (Protobuf-compression "Protobuf-Compression")
• [RPC Invocation] (RPC-Invocation "RPC-Invocation")
• [Adding a Component] (Adding-a-component "Add-a-Component")
• [Adding an Admin-Module] (Adding-an-Admin-Module "Adding-an-Admin-Module")
• [Summary] (Tutorial-Summary "Tutorial-Summary")

User Guide

• [Pomelo Style & Conventions] (Style-and-Conventions "Style-and-Conventions")
• Framework Analysis
  • [Framework Class Diagram] (Framework-Class-Diagram "Framework-Class-Diagram")
  • [Builtin Components Introduction] (Builtin-Components "Builtin-Components")
  • [Framework Execution Flow] (Framework-Execution-Flow "Framework-Execution-Flow")
  • [Server Administration Framework] (Server-Administration-Framework "Server-Administration-Framework")
  • [Frontend Server & Communication with Client] (Communication-with-Client "Communication-with-Client")
  • [Backend Server] (Backend-Server "Backend-Server")
  • [RPC Framework] (RPC-Framework "RPC-Framework")
  • [Message Compression ] (Message-Compression "Message-Compression")
• [Log Management ] (Log-Management "Log-Management")
• [Understanding Connector] (Understanding-Connector "Understanding-Connector")
• [Communication Protocol] (Communication-Protocol "Communication-Protocol")
• [Application Configuration] (Application-Configuration "Application-Configuration")
• [Plugin] (plugin)
• [Client Development] (Client-Development "Client-Development")
• [Performance] (Pomelo-performance "pomelo performance")
• Tools & Libraries
  • [Pomelo command line tool] (Pomelo-command-line-tool "Pomelo-command-line-tool")
  • [Pomelo-cli] (Pomelo-cli-Usage "Pomelo-cli-Usage")
  • [Pomelo-admin-web] (Pomelo-admin-web-tool-Usage "Pomelo-admin-web-tool-Usage")
  • [Pomelo-daemon] (Pomelo-daemon-usage "Pomelo-daemon-Usage")
  • [Pomelo-robot] (Pomelo-robot-usage "Pomelo-robot-Usage")
  • [Pomelo-sync] (Pomelo-sync-usage "Pomelo-sync-Usage")

Practices

• Treasures
  • [Treasures Practices] (Treasures-introduction)
• Lordofpomelo
  • [Lordofpomelo Introduction ] (LordOfPomelo-introduction)
  • [Lordofpomelo Installation Guide] (LordOfPomelo-installation-guide)
  • [Lordofpomelo Server Introduction] (LordOfPomelo-server-introduction)
  • [Lordofpomelo Code Organization] (LordOfPomelo-code-organization)
  • [Lordofpomelo Starting Process] (LordOfPomelo-startup-Process)
  • [Lordofpomelo Snapshots] (http://pomelo.netease.com/demo.html)
  • Play LordOfPomelo online

Release Notes

• [Pomelo 0.6 version] (Pomelo's-new-features-in-version-0.6)
• [Pomelo 0.5 version] (Pomelo's-new-features-in-version-0.5)
• [Pomelo 0.4 version] (Pomelo-0.4-new-features)
• [Pomelo 0.3 version] (Pomelo-0.3-new-features)
• [Pomelo 0.2 to version 0.3 Update Guide ] (Pomelo-update-tutorial-from-0.2-to-0.3)

API Reference

• [Pomelo API] (http://pomelo.netease.com/api.html "pomelo API")
• [Client API] (Client-Development#wiki-clientAPI "pomelo client development ")

Presentations & Slides

• lxjs 2013 [slide] (http://www.slideshare.net/xieccy/game-server-development-in-nodejs), [video] (http://www.youtube.com/watch?v=nvUGXjGrhg4)

Clients

• Javascript

  • Websocket version: [pomelonode / pomelo-jsclient-websocket] (https://github.com/pomelonode/pomelo-jsclient-websocket)

  • Socket.io version: [pomelonode / pomelo-jsclient-socket.io] (https://github.com/pomelonode/pomelo-jsclient-socket.io)

• C

  • Socket vesion: [NetEase / libpomelo] (https://github.com/NetEase/libpomelo/)

• IOS

  • Socket.io version: [NetEase / pomelo-iosclient] (https://github.com/NetEase/pomelo-iosclient)

  • Socket version: [ETiV / PomeloClient-iOS-WebSocket] (https://github.com/ETiV/PomeloClient-iOS-WebSocket)

• Android & Java

  • [NetEase / pomelo-androidclient] (https://github.com/NetEase/pomelo-androidclient)

  • [Jzsues / pomelo-websocket-java-client] (https://github.com/jzsues/pomelo-websocket-java-client)

• Unity3d

  • Socket.io version: [NetEase / pomelo-unityclient] (https://github.com/NetEase/pomelo-unityclient)

  • Socket version: [NetEase / pomelo-unityclient-socket] (https://github.com/NetEase/pomelo-unityclient-socket)

• Flash

  • Socket.io version: [stokegames / pomelo-flashclient] (https://github.com/stokegames/pomelo-flashclient)

  • Socket version: [D-Deo / pomelo-flash-tcp] (https://github.com/D-Deo/pomelo-flash-tcp)

• Cocos2dx

  • C++: [NetEase / pomelo-cocos2dchat] (https://github.com/NetEase/pomelo-cocos2dchat)