Scripts

IMPORTANT

As Hyperfy is in alpha, the scripting API is likely to evolve fast with breaking changes. This means your apps can and will break as you upgrade worlds. Once scripting is stable we'll move toward a forward compatible model, which will allow apps to be shared/traded with more confidence that they will continue to run correctly.

Lifecycle

TODO: explain the app lifecycle across client and server

Apps

Apps power Hyperfy's content. You can think of them as a combination of a model and a script. They can talk to eachother, and run both on the client and the server. Apps have a UI to configure properties in the scripts, and can load additional models inside of them.

Nodes

Apps are made up of a hierarchy of nodes that you can view and modify within the app runtime using scripts.

The gltf model that each app is based on is automatically converted into nodes and inserted into the app runtime for you to interact with.

Certain node types can also be created and used on the fly using app.create(nodeName).

World

The World API access methods and properties outside of the Apps, like players, networking or managing nodes outside of the local hierarchy.

Utils

The Utils documentation provides a set of miscellaneous globals available in the scripting environment, like a random number generator and access to some three.js methods.

Networking

Hyperfy Networking happens inside of Apps, using methods from both the App and World APIs. You can either send events between the client and server on the same app, or send messages to external apps on the server.

Globals

• app
• world
• props
• utils