Home / Node.js / Miscellaneous

Game Server Framework

Game Server Framework for Node.js Install Linux, macOS # Replace my-gameserver with how you wish to name your game export NODE_ENV=development npm install mage --bootstrap --prefix my-gameserver cd my-gameser
Information
Category: Node.js / Miscellaneous
Watchers: 9
Star: 54
Fork: 19
Last update: May 19, 2022
Resource links
https://wizcorp.jp/mage/
https://github.com/mage/mage

MAGE logo

GitHub tag npm npm Gitter

Game Server Framework for Node.js

Install

Linux, macOS

# Replace my-gameserver with how you wish to name your game
export NODE_ENV=development
npm install mage --bootstrap --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 --bootstrap --prefix my-gameserver
cd my-gameserver
npm run develop

Then follow the indications on screen as they appear.

See Also

18 Open More issues
Closed

Archivist retry

Should we add retry logic on write failures or do we just want to rely on multi-vault set ups taking care of these issues? Retries do have to be very carefully managed or they can take down an already unstable system.

Thoughts?

feature request 
opened Sep 12, 2017 by ronkorving 16
Closed

Bootstrap creates filevaults for auth not in gitignore

Noticed this when about to push a small sample project, the gitignore doesn't include the file vaults. After a conversation with @ronkorving it might not be appropriate to create the auth module and such in the bootstrap.

I'm on the side that creating these is actually a good thing, but it might take the user down the path where they use filevault for everything, like auth and such, which probably isn't so good.

@stelcheck what is your opinion on this? How do you think we should go about it.

doc usability 
opened May 30, 2017 by nullorvoid 16
Closed

Type definition file driven API doc

Todo

  • [x] Port content from the old API documentation to the type definition file

Description

Requires #5

This PR introduces Typedoc as our system for API doc generation. Some refactoring of the current documentation will be required (example: vault backends are now in the API doc, but should probably be in the user doc).

opened May 17, 2017 by stelcheck 16
Closed

Enhances coverage of config and removes a few redundant code paths.

It looked like my patchy old unit tests could use some enhancements, so that's exactly what I did. This is still rather flat and haphazard though, so if you'd prefer testing of methods in different sub-describes then let me know.

opened Apr 24, 2017 by qubyte 15
Closed

npm command format

  • use : instead of - as a context separator
  • update the documentation wherever needed

Fixes #118

opened Aug 22, 2017 by stelcheck 14
Closed

What to do about Plato?

Right now we use the yaml2json dependency for Plato, which seems overkill. Plato should be able to pass a yaml config file to ESLint. If it can't, let's fix Plato.

We also have yamljs lingering around, and it seems we should not need it.

If we can get rid of them, that would be nice. But these are dev dependencies only and don't have any negative impact (beyond dev installations being a tiny bit slower), so it's not a massive priority.

chores 
opened Apr 22, 2017 by ronkorving 14
Open

Documentation: add link to blog

https://medium.com/mage-framework

  • [ ] Readme
  • [ ] Documentation
  • [ ] Elsewhere?
opened Mar 19, 2019 by stelcheck 0
Open

Archivist: document preventVault

See https://github.com/mage/mage/blob/c713f5b0108114cce60760a6b0961b47aec9d099/lib/tasks/archivist-drop.js#L29

opened Sep 10, 2018 by stelcheck 0
Open

msyql vaults: if two vaults connect to the same db, only one will get migrated

More details coming later.

opened Sep 7, 2018 by stelcheck 0
Open

Fixes/websocket session

Alternative PR to #186.

Update sessions with small batches at different period of times.

Fixes #184

opened Apr 24, 2018 by Nokitoo 0
Open

Destructuring breaks user commands (when using mage-sdk-js) 

export default class {
	public static async execute(
		state: mage.core.IState,
		{ userId, password }: any
	) {
		return UserModule.login(state, userId, password);
	}
}

This will break because MAGE will not know what name to give to the destructured variable.

opened Apr 18, 2018 by stelcheck 0
Open

ArchivistModuleError, module refactoring

Refactored the code to use promises, reduce copy/pastes, and throw ArchivistModuleError which contain more details for logging purposes.

opened Dec 11, 2017 by stelcheck 2

1.5.0(May 23, 2018)

Removed

  • Session's module user commands: loginAsActor, loginAnonymous, reassign. (#179)
  • Dev modes allowing to access to all user commands without acl. (#179)
  • msgServer.getMsgStreamUrl since it has been replaced by msgServer.getPublicConfig. (#212)
  • Some vaults: elasticsearch, dynamodb, manta, redis, memcached, sqlite3. (#220)

Supports only node >= v8.x (#200 #237)

Mage Error class (#164 #210)

Standard MageError class for user-land.

This should help:

  1. Standardize error management.
  2. Allow for throwing errors (and interrupt the execution flow) without necessarily logging an error.
  3. Allow to attach additional details to the error to be logged, thus removing the need for an additional log call prior to throwing.
  4. Attach a response code to be sent to the client; this also has the advantage of being part of the log data, thus making it easier to search for error occurences by code instead of by message content.

Archivist

  • Removed archivist.add since it could make transaction fail in flight without any means to recover. (#196)
  • archivist:create now implies archivist:migrate. (#234)
  • Changes archivist.scan return value format to retrieve the index. The new format is [ [index, value], [index, value], ... ]. (#216)

Couchbase vault (#222 #223)

  • Better errors.
  • Init the client at application boot rather than at first operation.
  • Fix 5.x compatibility.
  • Updated documentation in consideration.

API changes

  • Add changePassword method to the auth module. (#198)
  • Make user command cache optional. See how here. (#195)
  • In .yaml config files, empty fields are now overwritten by default.yaml. To disable an option, the field has to be set to false. (#225 #229)
  • Move vaults connections opening in setup() to open() method. (#228)

Documentation improvement

  • Add supported Node versions. (#208 #237)
  • Add built-in modules part + list MAGE built-in modules. (#218 #248 #253)
  • List MAGE external helpers modules. (#242)
  • Add warning to specify vaults need to be added in list, read and write order. (#217)
  • Explain how msgStream works, which is used by events. (#255)

Small changes

  • Updates subdependencies. (#200 #201 #213 #219)
  • Always exit the server on error when we are not in a running state (eg. startup, shutdown, etc). (#202)
  • Removed Readme files about the internal architecture of MAGE. (#199)
  • Fix MemoryVault and FileVault expiration time that did not update correctly when calling multiple times archivist.set. (#231 #236)
  • Add ttl for topics. More details here. (#232)
  • Fix SingleService service discovery which did not take into account type and name of the service. Thus, 2 services with a different name and type were able to communicate. (#245)
  • Expose client config with config.get user command. It's meant to be used by the SDK. (#243)

1.4.1(Dec 15, 2017)

Fixes an issue with the new npx-based install process.

1.4.0(Dec 15, 2017)

Release notes

Command line interface

  • A number of NPM commands have been renamed. Please run ./node_modules/.bin/mage --help to see the changes and update your package.json file accordingly.

Removed

  • The deprecated "ident" module has been removed.

Archivist

  • You can now configure a maximum data size for your values. You can configure warning and error thresholds.

Process manager and management

  • The old shutdown behavior that shut down only the current process that was mage.quit() is now mage.exit(). A new mage.quit() function shuts down the entire local cluster.
  • On startup of the cluster, all workers are now spawned at once (used to be capped at 4-at-a-time).
  • Workers now all have and keep (even after they restart) a fixed ID. You can read it from the mage.workerId property.
  • The WorkerManager object has now been exposed via processManager.getWorkerManager() (API documentation pending).
  • You can now configure whether the system should shutdown on uncaught errors via the server.shutdownOnError boolean in your configuration file(s). This defaults to true.

MMRP (server to server communication):

MMRP relies on service discovery to keep its list of known relays up to date. However, under certain conditions, and depending on the behavior of the service discovery backend in use, you may end up with two relays sharing the same URI. This, in and of itself, appeared to be the cause of multiple issues.

You may also end up with case where lingering nodes are cleaned up after the replacing node has been added; in such cases, a disconnect was still triggered, thus leaving the MMRP cluster in an inconsistent state where messages where silently black-holed.

To solve this problem, these changes have been made:

  1. On relay down, disconnect based on the cluster ID instead of disconnecting based on the uri (we still verify that the URI is consistent)
  2. On relay up, disconnect any relay with the same URI but a different clusterId

Other changes that have been applied;:

  • Add a timestamp to MMRP's service discovery metadata, so that in case of conflicts/overlaps, we pick the most recent addition.
  • Discard any nodes during relayUp that serviceDiscovery tells us is a localNode.
  • The cluster ID is now generated from a hash of the local IPs on the machine.

Small changes

  • Creation of new projects now uses npx which ships with npm.
  • mage.getClientConfig(appName) has received a 2nd argument: baseUrl (default value is what it used to be).
  • Various documentation improvements.
  • TypeScript template dependency updates.

1.3.1(Nov 20, 2017)

Apologies. The 1.3.0 release introduced a small bug. This patch release addresses that.

  • Archivist: Fixes an assertion bug for base64 -> utf8 conversion
  • Archivist: Allows Couchbase to store binary

1.3.0(Nov 13, 2017)

Improvements

Minor improvements

  • Display a large "Development mode" banner when on.
  • Enable developers to dynamically change the configuration at runtime.
  • Added support for JSON5 as a configuration format.
  • State objects passed to module setup/teardown now carries a description.
  • Documentation updates.
  • Huge timeout values in file- and memory-vault are now safe to use, thanks to https://www.npmjs.com/package/safe-timers
  • Archivist encodings that are not string or Buffer will now throw.

Daemonization

Demo video: https://asciinema.org/a/ASEQCfwIdNzFZErCGhOTXi9w6

  • reload SIGUSR2 -> SIGALARM (fixes #137)
  • reload: reverting to spawn instead of of fork (fixes #136)
  • Using a named pipe for sharing logs between MAGE and the daemonizer
  • start, stop, restart and reload show logs
  • all logs are always shown (instead of only errors on crashes)
  • colorization is forced when daemonized, and the daemonizer filters out colors whenever it needs to

State event emission

Behavior changes

  • state.setTimeout, if ever used on a user command's state, would leave the client connection hanging forever, if triggered. Since this feature didn't appear to make any sense on state in the first place, this feature was re-implemented in the command center instead (see below)
  • Do not log a warning if we call emitEvents without broadcast data regardless of whether msgServer is present or not
  • Do not log a warning if we call emitEvents without emit data regardless of whether the session module is present or not
  • Log an error on state close if either of those modules are required, or if any other errors are returned

API changes

  • State instanciation now takes an options argument (see IStateOptions)
  • Removed emitToActors (was already deprecated)
  • Removed: state.setTimeout/clearTimeout
  • Removed the 'language' option on emit
  • emit/broadcast new alwaysEmit option: emit even on failure (fixes #91)
  • New public method distribute(): distribute all archivist mutations and events
  • New public method distributeEvents(): distribute only events

Bugfixes

  • broadcast(...): do not send on error (unless alwaysEmit is set) (fixes #91)
  • emit to self: do not send on error (unless alwaysEmit is set) (fixes #91)
  • emit(...): do not de-duplicate emitting of the same event to the same actorId multiple times

Internal refactoring

  • The state's internal address cache was useless, since archivist was caching values behind that anyway.
  • StateAccessError -> StateError
  • state.addresses -> state.addressesCache
  • Unit tests: 100% code coverage
  • Updated type definition file

Other

  • commandCenter: refactoring of the user command execution flow so that all user commands would be executed as promises. This helped to simplify the implementation of the timeout feature (see next point), but also provides a bit more safety, since now early assertions (not executed in an asynchronous context) will also be caught
  • usercommand.timeout: configurable user command field allowing to terminate the execution of a user command based on a timeout value. Not set by default (so the execution will never time out)

Archivist

  • Added a scan method to archivist (shorthand for list-then-query).
  • Added per-query option for mget. Query options will be merged with the options passed to the mget call.
  • clearCache would clear mutated entries; instead, we now renamed it to reset, and created a new clearCache which only deletes non-mutated entries.

Couchbase

Now ignores auth errors on open. An auth fail after a successful bucket creation would mean that the credentials are valid, but that the bucket has not fully been created yet.

Bugfixes

  • Fix: Archivist now returns an error if no vaults are available.
  • Fix: Command Center message hooks now also have batch meta data set on the state object.
  • Fix: Documentation link in project template fixed.
  • Fix: TypeScript INamedArchivistQuery is a key-value of INamedArchivistQuery, not of INamedArchivistIndex.
  • Fix: The default threshold for logging a call as slow is configurable, but the configuration entry was not read.
  • Fix: ZooKeeper reannounce failed since MAGE 1.2.6.

1.2.7(Aug 25, 2017)

https://github.com/mage/mage/pull/128 was not properly tested, and so the PID was erased from the output instead of being padded. Apologies for any conveniences.

Contents

    markriedl Game AI Game Engine
    Cyinx a framework in golang for game server or app server
    sumeetchhetri Framework for Enterprise Application Development, webrtc signalling server, peerjs webrtc, c++ framework, c++ web framework, c++ application framework, c++ rest framework, c++ soap framework, c++ web sites, c++ web applications, c++ driven web development - c++
    BeardedManStudios In short, Forge Networking is a free and open source multiplayer game (multi-user) networking system that has a very good integration with the Unity game engine. You wanna make a multiplayer game or real time multi-user application? This is the library for you.
    cocos Cocos Creator is a complete package of game development tools and workflow, including a game engine, resource management, scene editing, game preview, debug and publish one project to multiple platforms.
    nivent RGB (Rust Game Boy) is a simple emulator for the original game boy and the color game boy.
    Igoorx A open-source server emulator for Mario Royale browser game.
    ermanimer server-monitor is a server monitoring tool for Linux.
    pterodactyl Pterodactyl is the open-source game server management panel built with PHP7, Nodejs, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to administrators and users.
    bignimbus Framework for expressing Conway's Game of Life in n-dimensional space
    ubisoft Massgate is the online backend server for the Massive Entertainment game World in Conflict, and is now open-source to make it possible for anyone to host their own Massgate server.
    benjmarshall A weekend project to create a Snake game in Go using the Pixel game library.
    DeBankDeFi open-sourced, rig-resistant and verifiably fair dice game
    Syauqizaidan Web Platform Portal Game Indonesia yang dibuat oleh Syauqi Zaidan Khairan Khalaf
    tinyBigGAMES A 2D indie game library that allows you to do game development in Delphi
    node-pinus Pinus -- a fast, scalable game server framework for node.js
    The-MMORPG-Project An on-going project consisting of a launcher, a client, a web server, and a game server.
    Pterodactyl Pterodactyl is the open-source game server management panel built with PHP7, Nodejs, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to administrators and users.
    giongto35 Gowog, Golang based Web multiplayer Online Game
    photonstorm Phaser CE is a fun, free and fast 2D game framework for making HTML5 games for desktop and mobile web browsers, supporting Canvas and WebGL rendering.
    photonstorm Phaser is a fun, free and fast 2D game framework for making HTML5 games for desktop and mobile web browsers, supporting Canvas and WebGL rendering.
    Share this repo

    Related Repos


    Miscellaneous
    3
    Haxe externs for W the micro WebGL2 framework
    gogoprog haxe-w Haxe externs for W the micro WebGL2 framework Requirements Haxe 4 Example import js.Browser.document; import w.W; function main() { var c:
     
    Miscellaneous
    255
    Crazee Rider - BBC Micro
    KevEdwards Crazee Rider ( BBC Micro ) Version V1.00 (c) Kevin Edwards 1986-2018 In 1986 I began writing a motorcycle racing game for the BBC Micro, Electron and
     
    Miscellaneous
    4
    Galaforce 2 for the BBC Micro home computer from 1987 ( full, buildable 6502 source code )
    KevEdwards Galaforce 2 ( BBC Micro ) Version V1.00 (c) Kevin Edwards 1987-2021 40 years ago, on the 1st December 1981, the BBC Micro was launched. Demand was ver
     
    Miscellaneous
    29
    ๐Ÿ”ฐ๐Ÿฆธ Template to start developing a REST API with Node.js (Express), TypeScript, ESLint, P...
    borjapazr ๐Ÿ”ฐ๐Ÿฆธ Template to start developing a REST API with Node.js (Express), TypeScript, ESLint, Prettier, Husky, TypeORM, etc.
     
    Miscellaneous
    1.5k
    ๐Ÿ›  Node.js stateless session utility using signed and encrypted cookies to store data
    vvo ๐Ÿ›  Node.js stateless session utility using signed and encrypted cookies to store data. Works with Next.js, Express, NestJs, Fastify, and any Node.js HTTP framework.
     
    Miscellaneous
    266
    Lightweight and performant Lucene-like parser and search engine.
    gajus Lightweight and performant Lucene-like parser and search engine.
     
    Miscellaneous
    3
    Bamboo API v3.0
    joog-lim Bamboo APIv3 ๊ธฐํš ๋ฐฐ๊ฒฝ ๋ณ€๊ฒฝ ์‚ฌํ•ญ ๊ธฐํš ๋ฐฐ๊ฒฝ ๊ธฐ์กด์— ์กด์žฌํ•˜๋˜ Bammboo API v1, v2์˜ ๊ฒฝ์šฐ NoSQL๋กœ ์ž‘์„ฑ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. ๊ทธ๋กœ ์ธํ•˜์—ฌ ์„œ๋กœ ํ‚ค๋ฅผ ๊ตํ™˜ํ•˜์ง€ ์•Š์œผ๋ฉด, ๊ทธ๋ฆฌ๊ณ  ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค๋ฅผ ์—ฌ๋Ÿฌ๊ฐœ ์—ฐ๊ฒฐํ•˜์ง€์•Š์œผ๋ฉด ๊ฐ’์„ ๊ฐ€์ ธ์˜ค๋Š”๋ฐ, ์—ฌ๋Ÿฌ ์• ๋กœ์‚ฌํ•ญ์ด ์กด์žฌํ•˜์˜€์Šต
     
    Miscellaneous
    21
    Fast & elegant PDF invoice generator for Node using PDFKit. No Puppeteer
    baptistejamin Fast & elegant PDF invoice generator for Node using PDFKit. No Puppeteer
     
    Miscellaneous
    104
    Simple URL shortener built with Fastify. Uses PostgreSQL, Redis, and Kafka.
    smallcase Simple URL shortener built with Fastify. Uses PostgreSQL, Redis, and Kafka.
     
    Miscellaneous
    12
    TypeScript Express.js MongoDB Multi Language Boilerplate
    alirezanasseh TypeScript Express.js MongoDB Multi Language Boilerplate
     
    Miscellaneous
    1.2k
    A dedicated open-source Discord bot for Zhycorp based on our Discord bot template with mor...
    Clytage A dedicated open-source Discord bot for Zhycorp based on our Discord bot template with more features. Easy to use, and with no coding required.
     
    Miscellaneous
    1.3k
    output coverage reports using Node.js' built in coverage
    bcoe output coverage reports using Node.js' built in coverage
     
    Miscellaneous
    35
    Nodejs API Boilerplate
    trantoan960 A delightful way to building a Node.js RESTful API Services with beautiful code written in Vanilla Javascript.
     
    Miscellaneous
    12
    AKA is a simple, private URL shortener/bookkeeper for personal use that is hosted locally.
    brandonLi8 A simple, private URL shortener/bookkeeper that is hosted locally.
     
    Miscellaneous
    1.1k
    Simple API-caching middleware for Express/Node.
    kwhitley Simple API-caching middleware for Express/Node.