room.js

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #android #deep-learning #macos #java #windows #vue #security #mcp #openai

(★ 87)

A node.js MOO server

File Explorer

Download Latest Version (.zip)

- - .gitkeep
- users.json
- CUSTOMIZING.md
- DEMO_MUDLIB.md
- PROGRAMMING.md
- PROGRAMMING_OBJ.md
- PROGRAMMING_REF.md
- PROGRAMMING_TUT.md
- - base-child-controller.js
  - player-controller.js
  - programmer-controller.js
  - socket-controller.js
  - unauthenticated-user-controller.js
  - user-controller.js
- - c3.js
  - colors.js
  - deserializer.js
  - environment-config.js
  - fs-db.js
  - idify.js
  - moo-db.js
  - namespace-node.js
  - namespace.js
  - on-exit.js
  - parse.js
  - pbkdf2.js
  - print.js
  - rewrite-eval.js
  - room-js-server.js
  - serialize.js
  - simple-db.js
  - timer.js
  - world-object-class-builder.js
  - world-object-proxy-builder.js
  - world.js
  - wrap-string.js
- config.js
- console.js
- index.js
- - authenticated-test.js
  - playing-test.js
  - programming-test.js
  - programming-ui-test.js
  - unauthenticated-test.js
  - unauthorized-test.js
- - socket-controller-test.js
- - mock-db.js
  - test-server.js
- - c3-test.js
  - deserialize-test.js
  - fs-db-test.js
  - idify-test.js
  - moo-db-test.js
  - namespace-node-test.js
  - namespace-test.js
  - parse-test.js
  - pbkdf2-test.js
  - print-test.js
  - rewrite-eval-test.js
  - serialize-test.js
  - simple-db-test.js
  - timer-test.js
  - world-object-class-builder-test.js
  - world-object-proxy-builder-test.js
  - world-test.js
  - wrap-string-test.js
- - .gitkeep
- users.json
.env.development
.env.test
.gitignore
.tool-versions
.travis.yml
CHANGELOG.md
CONTRIBUTORS.md
LICENSE
package.json
README.md
yarn.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

RoomJS Game Engine
======================

[![Greenkeeper badge](https://badges.greenkeeper.io/doughsay/room.js.svg)](https://greenkeeper.io/) [![Travis](https://img.shields.io/travis/doughsay/room.js.svg)](https://travis-ci.org/doughsay/room.js) [![Code Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://standardjs.com/) [![Codecov](https://img.shields.io/codecov/c/github/doughsay/room.js.svg)](https://codecov.io/gh/doughsay/room.js) [![David](https://img.shields.io/david/doughsay/room.js.svg)](https://david-dm.org/doughsay/room.js) [![David](https://img.shields.io/david/dev/doughsay/room.js.svg)](https://david-dm.org/doughsay/room.js?type=dev)

> **NOTE:** The master branch represents ongoing work and may have the server in a currently unstable state.  Please check the [releases](https://github.com/doughsay/room.js/releases) to get the most recent stable version.

This repository contains the RoomJS game engine (or server).

RoomJS is a modern Node.js-based [MUD](https://en.wikipedia.org/wiki/MUD)/[MOO](https://en.wikipedia.org/wiki/MOO) engine, where (privileged) players can extend everything while in game. The basic idea is that one can create and edit objects, locations and code from inside the game.

The engine includes built-in WebSocket (SocketIO) communication, user account management, flexible command parsing system and persistent on-disk storage.

Prerequisites
=============

The RoomJS server requires **Node.js 6.10** or newer.

Clone the repository or download a ZIP archive.

Installation steps are straightforward:

1. `yarn install`
2. Create a `.env` file to customize the server's configuration. See `.env.development` for examples and explanations.
3. `yarn start`

To interact with the server, you must use a web client application. The standard [client](https://github.com/doughsay/room.js-client) is provided in a separate repository.

Main features
=============

These are but a few of all the things that you get just out-of-the-box:

- Modern **Playing**:
  - Connect and play simply using a web browser. *No need for good old telnet or third-party MUD client.*
  - Fully enjoy the leveraged experience, with colors and clickable links!

- Advanced **Scripting**:
  - Code your game in plain modern JavaScript (ES6), using a nice oriented-object design with inheritable traits, with all scripts running in sandboxes. *No need for proprietary custom programming languages.*
  - Edit your code directly in the browser, using the well-known in-browser code editor [CodeMirror](https://codemirror.net/) with syntax coloring and other neat features. *No need to leave the game in order to add features and hotboot your changes.*

- Flexible On-Disk  **Structure**:
  - All objects are stored in JSON format, in subdirectories along with their attached scripts in JS files: real easy to work with, or to parse for external usage if you ever need to quit the in-browser editing for any reason. *No need for custom file formats, YAML entities or other weird things.*
  - Name and organize your assets logically according to your own needs, without strong restrictions. *No strongly imposed directory structure.*

- Easy **Communication** Channels:
  - Out-of-the box "Say" channel for the chatty ones, "Chat" channel for broadcasting... and "Eval" mode for the developers.
  - Extensible and easily customizable "mode" system.

- Powerfull **Debugging**:
  - The game engine relies on [Bunyan](https://github.com/trentm/node-bunyan), a simple and fast JSON logging library, with a nice CLI for viewing and analyzing logs.

- Lightweight **Demonstration**:
  - The server is bundled with but a small demonstration, to illustrate a few possible ways of coding your own world. *No huge codebase with so many specific combat or leveling rules, or complex skill systems, that one would immediately get lost.*
  - Use it as a base, or wholly replace it, focussing on your own gaming logic!

Demonstration world
===================

Live demonstration: http://roomjs.dose.ninja/

Documentation
=============

And it even comes with documentation...

- [Building and programming your own RoomJS MUD/MOO](doc/PROGRAMMING.md)
- [Organizing and customizing your world objects](doc/CUSTOMIZING.md)
- [A brief description of the demonstration mudlib](doc/DEMO_MUDLIB.md)

room.js

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

room.js

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README