Documentation Priorities

From Multiverse

Contents 1 Server plug-in docs 1.1 How MARS interacts with the server API and Client 1.2 Events 2 Client-side development 3 Correct existing docs 4 Tutorials 4.1 Platform Tutorial 4.2 Transfer tutorials from the forums 5 Other 5.1 End-user docs 5.2 Cleanup and other minor stuff

Server plug-in docs

The docs on writing and extending server plug-ins need a lot of work. Specifically:

• Fill in Adding Functionality to Server Plug-ins

How MARS interacts with the server API and Client

Clarify what can and can't be done in certain processes, and other things. I'm basing this out of the example of when I was inquiring information on how to grab region lists, some tidbits were answered on the forums that could easily have been in the documentation. There are probably a lot more examples, especially if someone were to want to re-write MARS.

• More on MARS in general
• Improve MARS Javadoc

Events

Would be great to have a list of out-of-box events and how to create your own on both the client and server side.

Client-side development

We could have a better introduction on starting client development.

I am having an issue with how to get strated with client side development. I have looked through all the scripts and I think I understand them. But I still do not feel that I have a good grip on how to start? Do I start with creating my own script and attaching a handler, then calling the script from the startup.py script?

--LuckyWolf19

From Jeff:

1. Create a new script file
2. Import the script file in Startup.py
3. Register a slash command handler (via MarsCommand) for the code to test the functionality of the script, if it makes sense for that particular script.

For example, if I'm creating a new coordinated effect, I would create a slash command that would invoke the effect. If I'm doing something that reacts to object property changes, the test command might set the properties.

Correct existing docs

• Fix How To Fly
• Review Debugging Client Errors and rewrite Structure of the Client Trace File.
• Add info on how to recreate the database (this can be generally useful)

Tutorials

Platform Tutorial

• Missing Section: Importing Animated Models
• Write Platform Tutorial Creating Player Characters

Transfer tutorials from the forums

Developers often post tutorials and other detailed information on the forums. In many cases, it is appropriate to put this information on the wiki. Here is a list of forum threads that are recommended for transfer:

• Instantiate an Object and make into a real tutorial. Make sure it works with 1.5!

• Earth Sculptor Tutorials (DimiTree)
• Icon Format - Tutorial (ronalmb)
• Character Modelling for MV

New tutorials:

• Creating an Icon and an Item from ronalmb's tutorial above.

Other

• Finish Client-server Communication

End-user docs

This is lower priority and not relevant to developers, but some end-users don't understand all the key mappings, how to move, etc. So a nice simple user tutorial for Client would be helpful.

Cleanup and other minor stuff

• The Client API reference tables for method parameters currently use "None" when there is no default value. Unfortunately, in Python, None has a specific meaning (like null), and thus this can lead to confusion. We should change "None" in all these tables to "N/A" or "No default - value required" or something else unambiguous.
• Make widget attribute lists into tables.