RanvierMUD / ranviermud

A node.js based MUD game engine
https://ranviermud.com
MIT License
796 stars 247 forks source link

Docs #7

Closed whiskers75 closed 7 years ago

whiskers75 commented 12 years ago

Documentation should be updated - it does not document everything. Such as adding player attributes, authentication...

shawncplus commented 12 years ago

I consider some things self-documenting. Like player attributes there is just an object in src/player.js that is commented // Attributes that you can just add to. As far as authentication could you provide more specifics on what you mean by authentication?

whiskers75 commented 12 years ago

I still think you should document the self-documenting areas for those who do not know much about N

whiskers75 commented 12 years ago

ode. And about authentication - how to change the messages it gives at the login screen.

shawncplus commented 12 years ago

I can certainly do that. Until I add that you just edit this file https://github.com/shawncplus/ranviermud/blob/master/data/motd

whiskers75 commented 12 years ago

Could you also document an example of l10n in action and how to parse JSON files?

shawncplus commented 12 years ago

For l10n in action see the Practical Example section of https://github.com/shawncplus/ranviermud/wiki/Localization and what about parsing JSON files that's a bit ambiguous.

whiskers75 commented 12 years ago

In your README you mention that the JSONs can be parsed put do not mention how.

whiskers75 commented 12 years ago

And please document the items such as attributes for people who just want to make a MUD.

whiskers75 commented 12 years ago

You mention the attributes file - but how would you change an attribute in a script file?

shawncplus commented 12 years ago

What are you referencing when you say i mention an attributes file?

whiskers75 commented 12 years ago

Your post here.

shawncplus commented 12 years ago

Well, I said that there's an Attributes section of src/player.js if that's what you meant. What do you mean change an attribute in a script file? Like, you have a script and you want to change a player's health or something?

shawncplus commented 12 years ago

See https://github.com/shawncplus/ranviermud/wiki/Skills-and-Affects which shows how to set affects/attributes

whiskers75 commented 12 years ago

Yes I do mean a script to change an attribute - trying to create a money attribute and do not know how to change the amount per player.

whiskers75 commented 12 years ago

And also the Skills and Affects doesn't mention attributes in player.js as far as I can see...

shawncplus commented 12 years ago

All of the skills and affects are driven by setting/getting player attributes, look at the setAttribute/getAttribute methods

seanohue commented 8 years ago

@whiskers75 Check out my fork of the project for some practical examples of adding custom attributes, classes, effects, skills, etc. You will need, at least, a basic working knowledge of JS to make a MUD using ranvier's engine, to be honest.