Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Overview

Ogre is provided as a renderer with the toolkit as an opensource alternative to Unity. Ogre communicates with smartbody using the Bonebus library for sending and receiving messages.

Users

Section aimed at users, especially how they can run and use the component, if applicable. Provide information on how to use the function mentioned in the previous section. Put each functionality in a seperate section.

Example: Launch the Component

For instance, what dependencies exist, what parameters can be chosen on start-up.

Example: Set up the Component

For instance, what settings are needed within a certain scenario, which are mandatory, which are optional, etc.

Example: Perform a Component Specific Task

For instance, how to send a text string to the agent using the speech client, how to kill all checked components using the launcher, etc.

Authors

Section aimed at authors. Authors can create new characters or adapt existing ones. Provide an overview of what data can be manipulated and how. Provide examples and mini-tutorials on who to perform specific tasks.

Developers

Section aimed at developers. Use to explain the architecture of the component, how to make changes, where files are located, what caveats exists, etc. Should at least contain a section on the messages received and send.

Message API

List here all the (ActiveMQ) messages this module receives and sends. You can use this section to explain how this module fits within the overall architecture.

Known Issues

Provide a list of known issues and peculiarities. Allow the reader to give feedback, probably by giving a link to the Support page.

FAQ

Probably just link to the appropriate section in the Main FAQ.

  • No labels