Web-based control panel and building client for Ranvier
Create and modify game data for Ranvier via a web app. Built with mithril-starter-kit.
To use this bundle, you will need a specific checkout of Ranvier. You MUST use my experimental fork (azigler/zigmud) alongside a checkout of my experimental core:develop branch (azigler/core:develop).
This bundle WILL NOT WORK with a regular Ranvier checkout.
As of now, this bundle has only been tested with ranvier-datasource-couchdb serving all entity data.
This bundle requires Ranvier to be using at least Node v12.18.2 LTS.
-
Install this bundle in your Ranvier repository.
-
Update
zPanelin yourranvier.jsonto include the port and URL you'll use for the web client:
"zPanel": {
"port": 4335,
"url": "localhost"
},
-
Add
zpanel: trueto theAccountmetadata of whomover can access zPanel and the accompanying API. -
When the server next starts, the app will compile and serve zPanel at the address provided (e.g.,
localhost:4335). Navigate to the address to log in and begin editing.
Currently this tool allows for the creation of very basic area, room, item, and NPC entities. When items and NPCs are created and updated they can be immediately spawned into the game from the new definition. At this time, you must reboot the server in order to see changes to rooms.
The app is built with Mithril and Construct-ui. You can use the npm start package script to run a Webpack development server for the Mithril app, but you will also need to run the game server to launch the API so it may be more effective to just reboot Ranvier when needed. The API is built with hapi and uses an HTTP cookie for authentication. You can readily add to the API and expand on the provided interface options since everything in the app potentially has access to state via the server-event that launches this bundle.
