icewolfz / jimud Goto Github PK

A javascript error will happen if a value other then null, undefined or string is returned
Code lines effected :

• ExecuteAlias on line 1199
• ExecuteMacro on line 1239
• ExecuteTrigger on line 1406

returned value should have value checked and if null/undefined ignored and non strings should be converted to string

Re-code the inline variables and functions for parse in the parsing system instead of simple js replace function calls, should improve speed as will not have to call all functions all the time

At the current time they use a java-script replace call for each function, performance should improve if built into the parser directly as it will then only run the code if a match has been found instead of running the replace every time commands are sent from the mud.

There is a bug with aliases and macros when using script type.

Work around is to return an empty string, return ""; at the end of the alias/macro
this will add a blank line/possible send a new line to mud

Fixed in c31f57f but posting an issue since it will be a while before 0.3.2 can be build due to a crashed pc

Add menu bar to profile manager to match standard gui and allow navigation other then by buttons

Autologin doesnt always seem to load correctly and login using the correct username

See about speeding up profile loading as if a large amt of profiles it will load all into memory,
maybe limit to only enabled ones for memory and speed while leaving disabled ones unloaded and load on demand as needed. This should make a client load faster as it will not have to load every profile but only those required.

This is more possible now with the enabled list moved to settings file instead of per profile. where before the only way to know if a profile was enabled was by loading that profile.

Expand the editor to allow changing of not just the basic ANSI regular, bold and faint but all xterm 216 colors and grey scale colors.

The main issue with this is dialog space, native color picker takes up some space and having over 200 of them would be cramped, a possible solution is to use a custom list control and let users click edit or double click and open a popup window to pick a color

• Create an extension system extending the client easier
• Min info for a plugin is unique id/name
• Location of plugins allow {data}/plugins and {documents}/plugins
• convert mapper, backup, status, chat capture into plugins
• plugins are a sub folder with a package.json and maybe allow a theme.css for plugins as well?
  • Examples:
    • chat - {data}/plugins/chat/package.json
    • mapper - {data}/plugins/mapper/package.json
    • backup - {data}/plugins/backup/package.json
    • status - {data}/plugins/status/package.json
    • immortal - {data}/plugins/immortal/package.json
• package.json min requires: { "name":"short name", "productName":"Long name", "description":"describe", "main":"path to main js"}
• basic extension:
  • import { Client } from "./client"; export function create(client: Client) { }
  • export function menu { return [] }; return an array of menu items to be set for plugins > extension name > menu items, this is limited as electron does not support dynamic menus so it will require a rebuild everytime the menu changes
  • add an event to context menu that is emitted by client so extensions can hook and modify context menu
  • add execute evens to allow extensions to execute custom commands?
  • client.on('function', (event)=> {}), for custom functions
  • add IPC communication system to allow custom windows to communicate back with extension
    • good examples are mapper requires a separate window but the extension has to be created and started in main

Add event trigger support where you can have triggers executed when a client event happens

Possible event ideas

• Open, fired when client opened
• Closed, fired when client closed
• Connected, fired after connected to host
• Disconnected, fired when disconnected
• Error, fired when an error happens

when accessing it does not correctly sort the priority, in theory sorting should be done by priority of each item based on profile's priority.

Right now only buttons and triggers do any type of sorting by priority and its a global sort and ignores profile.

Best way to handle this is change how the client stores each type, what needs to happen is each type should be cached, profile keys are sorted by profile priority, so client just needs to loop the loaded profile keys, and build an array of each type, and sorting the array before contacting it to cache, thus it will first be sorted by profile, then by each item priority

seems to randomly skip files

Update all code to have proper JSDoc, including all classes, functions, enums, and any public variable for typescript and javascript files

The screen will continue to scroll in split screen mode instead of staying locked, the position needs to be adjusted as new text comes in

on slower systems it seems the mapper command queue can be mixed up and multiple blocks can be sent out of order preventing auto walk from working correctly, at time there is no real solution to fix it in code as its a slow processing issue, for now the only fix is to increase the mapper send delay above the default 500 milliseconds until it process slow enough for the target system.

Allow an option to disable spell checker in command input / advanced editor

Allow the chat capture window to have its own font and font size

It requires a mac to build proper support, so unless there is some open source mac builder mac version will never be supported or able to be tested.

Those that want to build mac versions and submit fixes are free to

Create a system to allow commands to be delayed before sending.

Best way to handle this would be to create a command queue system and push the latest command on to the stack and track last sent time, if time >= delay period send next command and just repeat until no commands are sent.

Add a zoom system simlar to chat window

The tile area for profile manager items overflows when text is to long

The desktop file is lacking a Categories= entry in the *.desktop file.

According to the menu spec,

By including one of the Main Categories in an application's desktop entry file, the application will be ensured that it will show up in a section of the application menu dedicated to this category. If multiple Main Categories are included in a single desktop entry file, the entry may appear more than once in the menu.

Hence, please add at least one of the following in the Categories= key.

In addition, you could specify one or more from the longer list of Additional Categories.

Please test the result with desktop-file-validate and make sure it passes.

electron-builder offers native support for this since v19.22.1.

Reference: AppImage/appimage.github.io#2

Add support for gamepads using chrome gamepad API, best bet is to link it to the macro system somehow using custom key code in a gamepad #+buttons+axis format. will have to figure out some format as not to effect current macro system. Another way is expand macro code object to have new gamepad fields that sets the pad # and the buttons/axis data using a custom enum system for 12 buttons and 3 axis with 5 axis directions -x, -y, x, y, none

When chat capture system is enabled text from chat capture do not fire triggers when gag is enabled. Will have add code to fire triggers when gag enabled

• Re-code to not stream but download to local storage
• Make local storage create proper folder structure based in {data}/sounds/ using MSP protocol docs

MSP Docs
MSP Docs Alt

Allow chat window to zoom in / out / reset like main window

Add a basic log viewer, and try and determine log format based on file extension of html, raw.txt or .txt

Add an edit to button context menu that will open the button directly in the profile manager for editing.

This requires either re-coding the button bar build system and instead of using the global button array to use custom code to build the button bar. The custom code will to loop each loaded profile and then sort each button array by priory then build the button bar adding a custom data-profile to link a button to profile for gathering in to to load profile manager.

• Upload/Download of files
  • Allow use OS temporary files
• Reset sever and local data
• Custom editor open
  • Open files after download in editor
• Queue progress tracking
  • Allow stop, pause, restart of items in list
• List resizing, allow resize of local/remote and the queue/file browsing areas
• Add context menus
  • queue
  • log
  • local list
  • remote list
• Remote features, include any proper warnings
  • Directory browsing
  • Select all
  • Goto - add goto object
  • Backup - allow users to run backup command
  • Delete - allow deleting of file
  • Clone - clone files
  • Renew - renew files
  • Update - update object
  • Dest
  • Change to dir - change to current remote directory
  • Copy full path - copy full local or remote path
  • Rename - rename a file
  • Make directory
• Local features, include any proper warnings
  • Directory browsing
  • Select all
  • Delete
  • Make directory
  • Create new file
  • Copy full path
  • Rename
  • Maybe copy/paste/cut support
  • Upload changed files of current folder, ignoring just downloaded
  • Allow watching of folder/s to upload files outside of current open local folder
• Drag and drop support
• Folder support: allow support for selected folders for all operations allowed on files
• Status bar with basic status total local files/folders, remote files/folders, current selected local/remote
• Accelerators: add custom key down tracking for custom accelerators based on current focused list
• Add notifications for errors and important messages
• View: allow opening remote file locally in basic viewer built into jiMUD using a temporary file
• Edit: allow opening remote file locally in basic editor built into jiMUD using temporary file
• optimizing and improving speed and other areas

Some people have reported mapper data disappearing randomly, i have been unable to recreate the issue reliable, reports are it happens on installing updates, changing profiles, and any thing that changes data causes the mapper to be lost

there are alignment issues when measuring string width when certain Unicode when displayed.

saddly this can not be added with out a lot of work, it would require a custom system to handle timing.

But there exist an alternative method already, you can use javascript to simluat this by using script type for macro, alias, trigger, or buttons just use setTimeout(()=> { your code after wait is over}, milliseconds);

for example to simulate <#wait 2000;get all> you would do setTimeout(()=> { client.sendCommand("get all"); }, 2000);

Deleting a profile does not cause the client ot unload it from memory causing it to be saved when using client load systems

Seems to be an issue when trying to copy or paste test into macro or triggers

MSP module has forced url settings set to override server set ones.

Fixed with: 8814476

for those with older version you can fix it by running:
client.MSP.forcedDefaultSoundURL = ""; client.MSP.forcedDefaultMusicURL = "";
from the dev tools or a script trigger or alias

When picking a size in pref dialog it can some times mess up current display and only way to fix is clear.
Also when changing font size NAWS window size doesn't always seem to be set correctly until you force a resize

Maybe add MCP protocol support, unneeded with GMCP custom protocol for immortal tools. But may be useful for non immortal as it supports a simple editor system for any editor which may be a nice feature to add. An alterivtve way would be to create a GMCP user editor protocol as GMCP uses telnet while MCP does not and older MUDs can not add it with out updating server code or ways to interrupt data if a user is in an editor.

MCP home page
MCP protocol specs 2.1

Create and bundle basic help files built form docs to allow access from help menu. A basic window with a simple breadcrumb or similar should be enough.

also finish building help docs, mostly assets.md

When docking some times the docks are using the mainlock dock room instead of creating a new zone/room possible overlapping maybe

When test is formatted as flashing the editor does not correctly insert the pinkfish code (%^FLASH%^) into the formatted output text sent to the main client

Spell checker does not seem to work in 32bit windows in command line or advanced editor

Builds crash (blank screen) when pressing space in command input.

This is caused by the spell checker/sqlite3 being wrong platform, fix is to build each version stand alone. Rebuild node modules for 32bit, build package, rebuild 64bit then build package, and repeat for arm that way everything should have correct versions of node modules.

This will slow build times but only real fix when using native modules for sqlite3 and the spell check.

Another options is to try and see if any native modules can be left unpacked in free folders to allow them to be replaced if wrong build happens.

Mapper Temp fix

If mapper causing issues try to disable mapper in settings, other related featuers that will not work
are backup systems

Spell check temp fix

Run from dev tools:
webFrame.setSpellCheckProvider("en-us", true, { spellCheck (text) { return true; } });

This may also run from an alias of script type webFrame, should be a global variable, but due to a bug in aliases and script see #9 for details on how to work round the bug until a new release is ready

Chat capture system captures store list and locker inventories due o the update of allowing any charcter sin the [] blocks due to party line support, a way around it is to match maybe the ----------- lines or the column header line and turn on an "ignore" flag and then turn it back off at the footer

add alarms, timers and tick timer like zmud, at the current time jiMUD can create timers using javascript setTimeout and aliases/triggers but maybe can add functions and a simple interface i nthe profile manager for easy adding/disabling/management like zmud maybe using things like #alarm, #timer, #tick

CSS for monster icons and party icons needs to be completed

Basic icons for common monsters, the css class names exist just need to assign icons from spirtes in assets if exists or find a new one

Basic race icons for player party icons, simple silhouette should be good generic ones as most races have distinct features like ears/ head sizes with only minor expects like faeries, but those exceptions can be gotten around with some creative solutions, for example faeries just add the tops of the wings poking up near shoulders

Expand paste special to have an advanced replace regex system

Test pasted HTML from more sources and continue to adjust paste processing to fix issues

Allow custom pasting of clipboard test, to allow prepending, appending text to each line, making immortal development easier.

Requires a custom dialogm should use ctrl+shift+v

update to include new setting fields, and update the related doc table of supported settings for these commands

When creating a new trigger after clicking apply for trigger it will instead create a new profile.

Steps:
create new trigger, apply, click add new trigger

Due to bugs in npm5 fsevents fails to rebuild on windows and linux.

work around is just delete fsevents from the local node_module path unless you use it.
as none of the default settings use fsevents it should be safe to remove an rebuild as needed