Libraries

From ETC Public Wiki
Jump to: navigation, search

Libraries

Libraries are groupings or packages of various assets that can easily be loaded into Panda Storyteller for access. Libraries allow us to keep any project asset directory clean and concise, but enables developers to quickly pull assets from other projects into their own files with little hassle.

Libraries are denoted by the .lbr file extension. They are completely self contained, housing all of the .egg files, texture maps, scripts, animation files, etc. in a single compressed file for portability. Once a library is created it can be moved independently of any existing file structures for archiving or access.

Opening Libraries

To open a library, you simply access it by going to File > Browse External Library. Navigate to the desired .lbr file and click open. Panda Storyteller will then display the contents of that library in the standard asset browser.

To open the Default Library, use File > Browse Default Library

The Storyteller Default Library

Currently the Storyteller default library exists as a very simple set of assets that new users can use to get started working with Panda and the Storyteller. It is important to recognize that this default library should not become over-bloated with new asset additions over time as it is designed and intended to give new users a friendly lightweight base set of assets and actors to choose from as they familiarize themselves with the interface and tools.

Currently, the Default library consists of the following assets:

  • 2 Actor complete with standard animation sets
  • 4 Default Terrains
  • 5 Different Items/Collectibles
  • 3 Simple Props
  • 1 Transition Point
  • Full Script Library


Any further asset additions should be documented and approved.

Any new scripts MUST be documented and added to the default.lbr at time of addition.

Procedure for Adding Assets to the Default Library

To add any new assets to the Default Library, a developer must utilize the Panda Storyteller. You will open Storyteller and then open the project located in:

direct>ETCleveleditor>LEGameAssets>DefaultLibrary>DefaultAssets

You will find a Storyteller project in this directory called DefaultAssets. Open this project.

To add an asset, use the Import tool or Browse External Library tool to find the asset that you need. Once you have added the necessary file/files, save the project and then go to File>Export Library…

This will create a new library that should be called default.lbr. Overwrite the existing library file in that project directory. To finish the process, copy the default.lbr file that you have just exported and move it to:

Panda3D-1.7.2>direct>ETCleveleditor>models

You will overwrite the current default library in the folder. Test the new default library by creating a new Storyteller project and browsing the default library to ensure that all the assets now appear in the folder.

Troubleshooting

Storyteller has had issues in the past where an asset library may not export as intended. Assets may be missing or working improperly in the library that is created.

This is caused by an error in the project folders and files. As of this article, a solution was not actually found for this problem but it could be linked to missing assets in the project that were not removed through Storyteller. This commonly happens if you delete assets from a Storyteller project directory without removing the asset through Storyteller itself. Mostly, this occurs with the Scripts since Storyteller has no built in functionality for removing script assets at this time.

If you would like to remove a Script from a library, it is necessary to also edit any of the associated files used to catalog and organize the project's assets. Delete the Script from the 'Scripts' directory location in the project being used to create the library and then remove the associations to that script in the necessary .py files.