Closed whiskers75 closed 7 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?
I still think you should document the self-documenting areas for those who do not know much about N
ode. And about authentication - how to change the messages it gives at the login screen.
I can certainly do that. Until I add that you just edit this file https://github.com/shawncplus/ranviermud/blob/master/data/motd
Could you also document an example of l10n in action and how to parse JSON files?
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.
In your README you mention that the JSONs can be parsed put do not mention how.
And please document the items such as attributes for people who just want to make a MUD.
You mention the attributes file - but how would you change an attribute in a script file?
What are you referencing when you say i mention an attributes file?
Your post here.
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?
See https://github.com/shawncplus/ranviermud/wiki/Skills-and-Affects which shows how to set affects/attributes
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.
And also the Skills and Affects doesn't mention attributes in player.js as far as I can see...
All of the skills and affects are driven by setting/getting player attributes, look at the setAttribute/getAttribute methods
@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.
Documentation should be updated - it does not document everything. Such as adding player attributes, authentication...