Awesome Ranvier

What this is

awesome-ranvier is a repository for quality community-made content around the Ranvier MUD engine. If you know of a community fork, bundle, or other content that is not listed here, feel free to submit an issue or pull request to add it.

Contributing

If you add a resource, please do so in the following format:

Category Name (if not already present) should be a 3rd level subheading

• Link text should be the name of the content, e.g. "RanvierMUD website". (compatible Ranvier version info if applicable, e.g. version 3.x) A short description of the content should be included as part of the same list item.

Categories

Legend: :construction: - Under construction or Looking for development help. :warning: - Unmaintained or Deprecated

Bundles

• axon-olc (v3.x) Ranvier in-game entity editor
• myelin-quests (v2.x) A bundle with custom QuestGoals and quest-related behaviors. ⚠️
• Community Bundles (v3.x) List of community bundles in the Ranvier documentation.

Building Tools

• Axolemma (v2.x or 3.x, examples are in 2.x) A CLI tool and library leveraging ROT-js to procedurally generate areas for Ranvier games.
• Soma (2.x) Electron-based building tool. ⚠️
• ranvier-webhooks (3.x). This bundle comes with a webhook that handles GitHub events so you can trigger an automatic rebuild and relaunch of your Ranvier instance when committing to your public repository.
• ranvier-zpanel (3.x) Web-based control panel and building client for Ranvier ⚠️

Core Engine Forks & Versions

• RanvierMUD 3.1 (v3.1) Experimental alpha branch of the core engine. 🚧 ⚠️
• Ranvier-TS (v3.1+) A fork of Ranvier that converts the entire engine to TypeScript, with some additional enhancements. 🚧
• Pinwheel MUD Engine (2.x) Pinwheel is a rewrite of the Ranvier MUD engine and its bundles into a highly opinionated format. The engine makes decisions about world persistence and core features so you can focus on building your world and community. ⚠️

Clients

• Neuro (2.x, 3.x) Electron websockets client. The original.

DataSources

• datasource-file (3.x) YAML and JSON DataSources for the Ranvier game engine
• ranvier-mongodb-datasource (3.x) DataSources to store entities in MongoDB.
• ranvier-datasource-sqlite (3.x) SQLite DataSource.
• ranvier-datasource-couchdb (3.x) CouchDB DataSource

Games

• Mnemosyne A graphical browser-based game using modified Ranvier-TS (3.x? 4.x?) as a backend.
• Your game here! Please submit a pull request.

Libraries

• Fantasy Time Crunch (v2.x or v3.x) A library for handling arbitrary units of time and time-related "tick" events, made to plug into a Ranvier bundle easily. 🚧
• Lobus (v2.x or 3.x) A library for handling event-based menus, made for creating Ranvier input-event menus. 🚧
• ranvier-tracery (3.x) Generate and manipulate text in Ranvier with Tracery
• Magic-Symbols (v2.x or v3.x) Color syntax and parser for ANSI and Xterm256 colors

Contact

If you'd like to contact the maintainer of this site or folks in the Ranvier community, either submit an issue to the awesome-ranvier repository or check out the community Slack.