node package manager

mage

MAGE logo

GitHub tag npm npm Gitter

Build Status: Linux & macOS Build Status: Windows Coveralls branch

MAGE is a Game Server Framework for Node.js. It allows game developers to quickly create highly interactive games that are performant and scalable.

Features

  • Supports both JavaScript and TypeScript
  • Easily create transactional API endpoints
  • Supports multiple storage backends
  • Built-in distributed mode
  • Rich ecosystem of SDKs, modules and tools

See our user documentation for more details.

Client SDKs

We officially support the following client-side SDKs:

Name Language Location
mage-js-sdk JavaScript (browser) GitHub
mage-sdk-unity C# (For Unity) GitHub

Install

Linux, macOS

# Replace my-gameserver with how you wish to name your game 
export NODE_ENV=development
npm install mage --create --prefix my-gameserver
cd my-gameserver
npm run develop

Then follow the indications on screen as they appear.

Windows

# Replace my-gameserver with how you wish to name your game
set-item env:NODE_ENV=development
npm install mage --create --prefix my-gameserver
cd my-gameserver
npm run develop

Then follow the indications on screen as they appear.

TypeScript

Optionally, you may also create a TypeScript project. Simply add the --typescript flag to the previous npm command.

npm install mage --create --prefix my-gameserver --typescript

See Also