6.5 KiB
About <package name>
Use the <package name> package to <list of the main uses for the package>. For example, you can use <package name> to create/generate/extend/capture <mention major use case, or a good example of what the package can be used for>.
The <package name> package also includes <other relevant features or uses>.
Note: Here are some examples for reference only. Do not include these in the final documentation file.
Use the Unity Recorder package to capture and save in-game data. For example, use Unity Recorder to record an mp4 file during a game session. The Unity Recorder package also includes an interface for setting-up and triggering recording sessions.
AR Foundation allows you to work with augmented reality platforms in a multi-platform way within Unity.
AR Foundation is a set of
MonoBehaviours and APIs for dealing with devices that support the following concepts:
- World tracking: track the device's position and orientation in physical space.
- Plane detection: detect horizontal and vertical surfaces.
- Point clouds, also known as feature points.
- ... etc.
Note: For packages that are not yet released, see the Confluence page Documenting experimental, pre-release, and deprecated packages and refer to the appropriate section for your package's compatibility status for guidance on which installation instructions to include. Remember to remove or hide these instructions when the package is ready for release. When the package is at the Release Candidate or Released stage, use the Installation section below.
Installation
To install this package, follow the instructions in the Package Manager documentation.
Note: This section begins with a cross-reference to the official Unity Manual topic on how to install packages. If the package requires special installation instructions, include these steps below:
In addition, you need to install the following resources:
-
<name of resource 1>: To install, open Window > <name of menu item>.
The resource appears <at this location>.
-
... etc. -->
Package contents
The following table describes the package folder structure:
| Location | Description |
|---|---|
| MyFolderName | Contains <describe what the folder contains>. |
| MyFolderName/MyFileName | Contains <describe what the file represents or implements>. |
Requirements
This version of <package name> is compatible with the following versions of the Unity Editor:
- 2018.1 and later (recommended)
Note: You may also include additional requirements or recommendations for 3rd party software or hardware. If you need to include references to non-Unity products, make sure you refer to these products correctly and that all references include the proper copyright (©), trademark (™) or registered trademark(®):
To use this package, you must have the following 3rd party products:
- <product name and version>™
- ...etc.
Known limitations
<package name> version <package version> includes the following known limitations:
- <brief one-line description of limitation.>
- ... etc.
Note: If there are no known limitations, or if the limitations are trivial, exclude this section.
Here is an example for reference only. Do not include this in the final documentation file:
The Unity Recorder version 1.0 has the following limitations:
- The Unity Recorder does not support sound.
- The Recorder window and Recorder properties are not available in standalone Players.
- MP4 encoding is only available on Windows.
Helpful links
If you are new to <package-name>, or have a question after reading the documentation, you can:
- Watch the Tutorials here.
- Join our support forum.
- Follow us on Twitter.
Using <package name>
To use the <tool-name>, attach this component to your GameObject and open the <component-name> in the Inspector:
Use this component to access the YYY and ZZZ properties which control ...
Note: For a package containing a library, you can use this type of a description:
The XXX and YYY libraries contain APIs which allow you to <do-something>. The <class-name> class extends the <other-class-name> class so you can ...
You can implement a <something> using the XXX:
using Unity.Editor;
using MyPackage;
namespace MyNamespace
{
public class MyClass
{
...
}
}
<package name> workflows
To edit objects and elements:
- Decide which tools can help you achieve the end results. There might be multiple solutions that can all produce the effect you want.
- Select the element(s) that you want to modify. Often, the editing tool impacts which elements you need to select and how you need to select them.
- Depending on which tool you are using, set any options to help customize the outcome or change the default settings.
- Perform the action. Depending on what you are doing, this may be a simple matter of clicking a button. In some cases, you may be carrying out some intricate procedures. For example, you can click to ...
Advanced topics
This section provides more information on the following topics:
- First topic: provides a list of ...
- Second topic: explains the origin of ...
- etc.
First topic
This is a list of ...
Second topic
The XXX extends the YYY by tracking the ...
XXX window
You can access these properties on the XXX window:
| Property: | Function: |
|---|---|
| MySlider | Set this value to ... |
| MyCheckbox | Enable this property to ... |
| MyDropdownMenu | Choose how you want to ... |
| Value 1 | Select this value if ... This is the default. |
| Value 2 | Select this value if ... |
| Value 3 | Select this value if ... |
| MyReference | Set a reference to ... |