SHEATH - Ranvier World Viewer and Editor
This is an Electron/React/Redux app being developed alongside Ranvier, a MUD engine written in NodeJS. Eventually, Sheath will be a full-featured world-viewer and editor.
- Viewing all loaded items, players, NPCs, rooms, and areas.
- Viewing all definitions of items, NPCs, rooms.
- Cloning/spawning items, NPCs, and room from definition files.
- Creating new definitions that will be stored and persisted by the MUD server.
Built with electron-react-boilerplate
- Note: requires a node version >= 6 and an npm version >= 3.
- If you have installation or compilation issues with this project, please see our debugging guide
ProTip: Install with yarn for faster and safer installation
$ cd sheath-ranviermud && npm install
Run these two commands simultaneously in different console tabs.
$ npm run hot-server $ npm run start-hot
or run two servers with one command
$ npm run dev
Optional Editor Configuration
- Editorconfig Integration
- ESLint Integration
- Syntax Highlighting
- Node Snippets
- ES6 Snippets
Toggle Chrome DevTools
- OS X: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
See electron-debug for more information.
This boilerplate is included following DevTools extensions:
- Devtron - Install via electron-debug.
- React Developer Tools - Install via electron-devtools-installer.
- Redux DevTools - Install via electron-devtools-installer.
You can find the tabs on Chrome DevTools.
If you want to update extensions version, please set
UPGRADE_EXTENSIONS env, just run:
$ UPGRADE_EXTENSIONS=1 npm run dev # For Windows $ set UPGRADE_EXTENSIONS=1 && npm run dev
This boilerplate out of the box is configured to use css-modules.
.css file extensions will use css-modules unless it has
If you need global styles, stylesheets with
.global.css will not go through the
css-modules loader. e.g.
If you want to import global css libraries (like
bootstrap), you can just write the following code in
To package apps for the local platform:
$ npm run package
To package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
$ npm run package-all
To package apps with options:
$ npm run package -- --[option]
To run the application without packaging run
$ npm run build $ npm start
To run End-to-End Test
$ npm run build $ npm run test-e2e
This boilerplate uses a two package.json structure.
- If the module is native to a platform or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under
- If a module is
imported by another module, include it in
./package.json. See this ESLint rule.
- Otherwise, modules used for building, testing and debugging should be included in
Static Type Checking
This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.
If you want to have native-like User Interface (OS X El Capitan and Windows 10), react-desktop may perfect suit for you.
Dispatching redux actions from main process
How to keep the boilerplate updated
If your application is a fork from this repo, you can add this repo to another git remote:
git remote add upstream https://github.com/chentsulin/electron-react-boilerplate.git
Then, use git to merge some latest commits:
git pull upstream master
Maintainers for Boilerplate
License for Boilerplate
MIT © C. T. Lin