ranviermud / docs Goto Github PK

The tip here https://github.com/RanvierMUD/ranviermud/blob/master/docs/extending/areas/scripting.md#behaviors is no longer accurate, since we have metadata. I would suggest to change it into something hinting that if you don't need a script you should consider using the metadata property on entities.

Edit:
Since we are in a transition to 3.0 and https://github.com/RanvierMUD/core/blob/master/docs/extending/areas/scripting.md doesn't have that tip any more. This issue is nearly resolved. I would only suggest making people more aware of metadata and how to use it in the the scripting part of the documentation.

Document what's required if someone wants to use ranvier without using the example bundles from the point of server startup to taking player commands

The link to the Effects guide in the source docs for Attribute is broken.

This could be done in the bundle it's implemented in but I think it would be very helpful to document the format used by default for helpfiles, as well as information on how it's implemented so that people can easily extend it. I'm volunteering myself for this task, but wanted to make this issue as a reminder to do it and to gather feedback/input from the community.

The Contributing page does not have any useful content: https://ranviermud.com/contributing/

mkdocs.yml references contribution.md which is not in the repo:

This is another default/example implementation that seems to exist across multiple bundles and may be worth documenting.

RE: RanvierMUD/core#91

The comment says

// Have to be careful in weapon scripts. If you have a weapon script that causes damage and
// it listens for the 'hit' event you will have to check to make sure that `damage.source
// !== this` otherwise you could create an infinite loop the weapon's own damage triggering
// its script

yet that's not the case in the code for this weapon that does exactly that. Is it still needed or not?

Specify that the change function is to be called with await.
I know it could be sounds silly but someone could miss the Promise.