Skip to content

signorpipo/wle-ppefault

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Overview

Default template project for the Wonderland Engine.

The project includes the PP library.

If u prefer to start with a more elaborated template project that uses the PP library, you can use one of the PPlayground templates instead.

A collection of assets that can be useful while working with the Wonderland Engine (like gamepads 3D models) can be found here.

The development of this template and the PP library is actually being done on the wle-pp-dev repository, where you can find the most up to date version of the library, even though it might not be stable.

Downloads

You can download this template through the following links:

Template Versions

There are two versions of this template:

  • wle-ppefault
    • the PP library is included as an npm package
  • wle-ppefault-unbundled
    • the PP library is not included as an npm package, but as files in the project
    • can be useful if u plan to edit the PP library to adjust them to your need
  • wle-ppefault-pipo
    • a specific version made for myself
    • it is based on the unbundled version plus some extras like the PWA support

Scene Structure

In the scene you will find only a few objects that should make it easier and faster to get started with the development, without adding too many things you may have to delete.

The scene is composed by a Scene object that contains a Player and two Lights.

The Scene object has the following components on it:

  • pp-gateway
    • entry point of the PP library
    • let you specify some settings like if the debugs are enabled or not
    • setup some stuff like the InputManager and the SceneObjects

The Player object includes:

  • Reference Space
    • used to offset the head and the hands, for example to have a specific height
  • Camera Non XR
    • used to render the view when you have not entered an XR session yet
  • Eyes
    • used to render the XR view
  • Hands
    • follow the gamepads/tracked hands positions
    • the gamepads are displayed as two low poly Meta Quest gamepads that are animated, that means buttons react when pressed in real life
    • the tracked hands are displayed through cubes positioned on the tracked hand joints
    • includes pp-console-vr-tool and pp-easy-tune-tool, two tools that can be useful while debugging and tuning
  • Head
    • follows the head of the player
    • includes a pp-spatial-audio-listener component

Things To Know

When using this template, there are certain things to take into consideration:

  • if u change the structure of the Player object, some features might not work properly anymore
  • inside the index.js file of the wle-ppefault template, the following line is added to make type extensions available to typescript
    • import "wle-pp/add_type_extensions_to_typescript.js";
    • if u delete the index.js file and auto generate it again, type extensions might cause type errors until you add this line back manually

License

Copyright (c) 2021-2024 Elia "Pipo" Ducceschi.

Released under the ISC License.

Credits