Skip to content

Latest commit

 

History

History
128 lines (99 loc) · 5.94 KB

README.md

File metadata and controls

128 lines (99 loc) · 5.94 KB

jiMUD

A mud client using electron for ShadowMUD based on it's web client.

Build

To build jiMUD you must have node, npm, typescript 2.3+, cPython installed Steps to build:

Clone repository or use archive zip

  1. git clone https://github.com/icewolfz/jiMUD.git or git pull if already ready cloned, or you can download and unzip the source archive

Windows

  1. npm install - install all the node modules, Note you will need to rerun this only if modules have been updated in the package.json
  2. npm run release:win - build installer and portable exe

Linux

  1. npm install - install all the node modules, Note you will need to rerun this only if modules have been updated in the package.json
  2. npm run release:linux - build tar, deb, appImage, and rpm packages

Mac

  1. npm install - install node modules, Note you will need to rerun this only if modules have been updated in the package.json
  2. npm run release:mac - build Mac packages

Build and package files are all saved to dist folder

Run

  1. npm install - install node modules
  2. npm run rebuild - this rebuilds modules to work with electron if needed
  3. npm run compile - compile typescript into javascript files
  4. npm run start - start jiMUD

This will allow you to run jiMUD directly from this folder with out the need to package into a self contained folder or building an installer.

Note you only need to run the install, rebuild, and compile steps the first time or any time you update the packages.

Standalone application

  1. npm install - install node modules
  2. npm run build:debug-compile

This will compile typescript into javascript, rebuild native node modules and create a runnable package that can be ran from dist/ARCH-unpacked folder. This can be used for debugging or running it as full app with out the need to install, just run the jiMUD executable in dist/ARCH-unpacked folder.

FAQ

Basic questions answered about jiMUD

Command line arguments

Usage: jiMUD [arguments...]

  • -h, --help Print console help
  • -v, --version Print current version
  • -d, --debug Enable dev tools for all windows
  • -s=[file], --settings=[file] Override default setting file
  • -m=[file], --map=[file] Override default map file
  • -c=[name or id], --character=[name or id] Load a character from character database, may be used multiple times to supply multiple characters to load
  • -c=[id:#], --character=[id:#] Load a character from character database by id only, may be used multiple times to supply multiple characters to load
  • -e, --editor, -e=[file], --editor=[file] Open code editor with current/new client, may be used multiple times to supply multiple files to load
  • -eo, --eo, -eo=[file], --eo=[file] Open only the code editor, may be used multiple times to supply multiple files to load
  • -no-pd, -no-portable-dir When using portable exe use default local data directory
  • -data-dir=[file] Set a custom directory to store saved data
  • -l=[file], -layout=[file] Load window layout file
  • -il, --ignore-layout Ignore layout and do not save window states
  • -nci, --no-character-import Do not import old character.json
  • -f, --force Force load of instance even if single only instance enable
  • -nls, --no-layout-save Do not save any layout changes when application is closed
  • -nw, --new-window Open a new window
  • -nw=[id], --new-window=[id] Open a new window with and load a character
  • -nt, --new-tab Open a new tab
  • -nt=[id], --new-tab=[id] Open a new tab and load a character, similar to --character but will not replace current active tab if it exist
  • -el=[file], --error-log=[file] Set a custom error log path

References

Known Issues

  • Linux:
    • Tray icon: When app indicator is used on Linux, the click event is ignored, see Electron docs for more limits
    • Auto updating is only supported by Appimage
    • Show in task bar is no longer supported because Electron removed support due to wayland
  • Display:
    • Unicode RTL text selection display is not correct
    • MXP Image height is limited to line height
    • MXP Image selection/copy not supported
  • Backup:
    • Loading data that is related to operating system may revert to default or be ignored as paths could not exist or may be in wrong format
  • Command input
    • Spell checking will not check for errors until a space or newline is entered, or when the command box is refocused, you may right click any word at any point to get a forced list of suggested corrections.
    • Text selection may be lost when other controls are given focus
  • Immortal tools
    • Dragging multiple files and dropping outside to other applications will only drop the first file, all others ignored. This is a limitation of electron drag and drop support, until it is added it can not be supported outside of application
  • Advanced editor
    • Paste may lose some colors/background colors on pasted, this is a bug in TinyMCE editor
    • When applying styles to all text some styles may get stuck
    • Some styles will not flash when flashing is enabled depending on order of styles applied
    • Reverse style has weird results with heavy nesting of reverse tags and colors, suggest to just use normal background colors.
    • Correction from context menu may remove applied styles depending on if they are just that word
    • Complex color codes may be returned due to nesting and other complex style choices
  • General slow performance, do not use --disable-gpu it can impact overall performance
  • Mapper
  • Code editor