Document Introduction

Hello and welcome to ParaSpace Documentation! Here is a collection of documents for you to get started with ParaSpace. To cater to the demands of different readers, we offer tutorials for beginners, easy-to-understand thematic documents, and comprehensive API documents. Hopefully, all this will help you become an outstanding ParaSpace creator.

ParaSpace Documentation Composition

Reading such a great number of documents all at once is definitely not an easy task. Let us take some time to learn about the composition of ParaSpace Documentation first.

ParaSpace Documentation consists of 2 parts. The first part is Guides, which is intended to be the textbook of ParaSpace SDK. We recommend you start with this part. The second part is API Reference, which serves as a reference book for programming. After you have learned how to program using the ParaSpace SDK, you can refer to all the APIs that ParaSpace offers here. Therefore, you do not have to read this part in advance.


Guides aims to be the textbook of ParaSpace Documentation. It is composed of the following chapters:

  • Getting Started: This chapter covers the basics of ParaSpace, teaching you how to quickly create and upload an Avatar or a World. We recommend beginners start from this chapter to learn how to create content using ParaSpace.
  • Tutorials: This chapter offers tutorials on various themes and is intended for users who learn by doing. Each tutorial describes a use case step by step with a clear purpose. Following these tutorials to complete tasks will deepen your understanding of the ParaSpace SDK. We will continuously update this chapter. Please stay tuned.
  • SDK Tools: This chapter explains how to use the tools that ParaSpace SDK offers. For example, resource requirements and checks (required before you upload any Avatars and Worlds under certain restrictions to ensure that ParaSpace runs properly on all the devices), sample files offered in the SDK and commonly used in creations, a debugging tool for debugging Avatars and Worlds on a PC, and recommended third-party resources.
  • Avatars: This chapter introduces all aspects of Avatar creation. Rather than a tutorial, this chapter is more like a textbook that helps you understand Avatar creation features more deeply, such as Para Avatar Root, which is the most basic component in the Avatar SDK, Avatar Animation and Expressions, which are used to configure animations and exclusive expressions for a specific Avatar, as well as Avatar upload and replacement.
  • Worlds: This chapter introduces World creation in a comprehensive way. For example, you can learn how to use Para World Root, which is the most basic component in the World SDK, how to use various World-related components, like the pickup component, to create a more interesting World, and how to optimize your World.
  • Scripting: In this chapter, you can learn how to program when creating a World. If you want to create a World with complex game logic, programming is of essential importance. However, if you are a novice creator, programming is not a must for you to create an Avatar or a World. Just take it easy. This chapter tells you how to configure a programming environment and use Para Script. (Para Script is a programming component on which a Lua script can be mounted to implement the script logic.) This chapter also includes other content such as networking, synchronization, UI, and allowlisted Unity APIs.
  • FAQ: This chapter provides answers to frequently asked questions. You can look for solutions here when you have any problems. We will continuously update this chapter. If you cannot find an answer to your question here, join our Discord community and give feedback.

API Reference

API Reference aims to be a reference book for programming. It is composed of the following chapters:

  • Classes: Describes the properties, methods, and messages of each class that ParaSpace offers. Creators can refer to this chapter to call the classes.
  • Enums: Offers various enumeration values that are used for ParaSpace programming.
  • Lua Scripts: Describes the properties of the Lua scripts that ParaSpace offers.
  • Global Functions: Describes the Lua-based global functions that ParaSpace offers to help creators with their creation.
  • Lua Basics: Introduces the basics of Lua scripts.


Tips for Beginners

If you are a novice creator and have not ever created any content on Unity before, we recommend you start with the Getting Started chapter and then learn to create by referring to the articles in Tutorials.

If you have any problems, search for relevant content on ParaSpace Documentation first. If you cannot find an answer, you can join our Discord Community to consult our staff and other users.