pomelo README

The project's README from github.com/NetEase/pomelo. As one markdown file: README.md.

Pomelo -- a fast, scalable game server framework for node.js

Pomelo is a fast, scalable game server framework for node.js. It provides the basic development framework and many related components, including libraries and tools. Pomelo is also suitable for real-time web applications; its distributed architecture makes pomelo scale better than other real-time web frameworks.

Build Status

Features

Complete support of game server and realtime application server architecture

Fast, scalable

Easy

Powerful

Extensible

Why should I use pomelo?

Fast, scalable, real-time game server development is not an easy job, and a good container or framework can reduce its complexity. Unfortunately, unlike web, finding a game server framework solution is difficult, especially an open source solution. Pomelo fills this gap, providing a full solution for building game server frameworks. Pomelo has the following advantages:

How can I develop with pomelo?

With the following references, you can quickly familiarize yourself with the pomelo development process:

Contributors

License

(The MIT License)

Copyright (c) 2012-2017 NetEase, Inc. and other contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pomelo (NetEase/pomelo)

Searching Database…

11.9K ·GitHub
archived
What is this?A fast, scalable game server framework for Node.js, originally built by NetEase. It ships the core framework plus related components — libraries and tools — and also suits realtime web apps.
Is this a full game engine, or just the server side?Just the server side: a framework plus components (rpc, protocol, admin, scheduler, logger) running on Node.js, not a client engine. Client libraries for connecting apps are included separately.
How do I get started building a server with it?Everything is distributed as npm modules — add the pomelo core and the components you need to a Node.js project, then follow the Getting started docs and tutorial. The test suite runs via grunt.
What do I need installed to run it?Only Node.js — the whole architecture is designed around node's single-threaded model. Runtime dependencies include socket.io, async, crc and pomelo's own modules like pomelo-rpc and pomelo-protocol.
Is pomelo still actively maintained?No — the GitHub repository is archived and read-only, and the license copyright stops at 2017. Treat it as a frozen but once battle-tested codebase rather than a living project.
What kinds of games and apps is it meant for?Multiplayer games — mobile, social, web and mid-size MMO RPGs — plus realtime applications like chat and message push.
Can I use it in a commercial game, and what does it cost?It's MIT licensed: free for any use, including commercial projects, as long as you keep the copyright notice in your copies.
How does it scale to many players?Through a distributed, multi-process architecture: each process runs single-threaded, which fits node's model well. You scale by adding server processes, and server types are flexibly extensible.
Which client platforms can connect to a pomelo server?Many: JavaScript (web), Flash, Android, iOS, cocos2d-x and plain C — client support is listed as one of the framework's selling points.
Is there a working demo to learn from?Yes — an open-source MMO RPG demo with an HTML5 client, alongside many examples and full documentation. The authors say the demo is a far better reference than any book.
Can I extend it with my own components?Yes: there is a plugin architecture, official plugins like online status and master high availability, and you can define your own network protocol and custom components.
What tooling comes with it out of the box?A command-line tool, an admin tool and a performance test tool, plus libraries for AI and path finding.
Creator
NetEase
Size
59.7 MB
Stars
11.9K
Updated
CommitNov 08
Age
14y
Commits · 90 Days