ShellSubmissionCheckList

From Alcugs

Jump to: navigation, search

Shell Submission Checklist

This checklist ensures that your shell files are ready for integrating into Ahra Pahts with minimal conflict. Please make sure your shell adheres to these conventions.

Preparation

  • All objects in your shell are on your shell's page. For example, if your shell is 111, then each object should have the following property:

string page_num = 111

  • Nothing in your shell can be over 60 feet (or Blender units) tall.
  • All geometry objects are named beginning with either sNNN or NNN, where NNN is your 3-digit shell/page number. For example, the name of an object in shell 111 would begin with s111 or 111.
  • All materials and meshes are named beginning with either sNNN or NNN.
  • All texture files are named beginning with either sNNN or NNN.
  • All colliders, regions, softvolumes, soundemitters, seekpoints, etc. are named beginning with either sNNN or NNN.
  • All objects are within the bounds of your shell walls. (The walls are on the layer 4 of your shell Blend file)
  • All Python script files are named beginning with sNNN, and all classes within the scripts are named beginning with sNNN.
    • If you have any global variables, declare them within a Python file named sNNNGlobals.py. This will put them in the sNNNGlobals namespace.
    • If your Python classes are subclasses of ptModifier, then set self.id equal to 189NNNX, where NNN is your shell number, and X is a number from 0 to 9 - this depends on how many ptModifier subclasses you have.
  • All objects defined using AlcScript are named beginning with either sNNN or NNN.
  • All sound objects are named beginning with either sNNN or NNN. (The ability to rename sound objects will become available in the near future)
  • All sound files are distributed in .ogg format and named beginning with "pahts", the 3 digit shell number, an underscore, and a name, e.g.: pahts111_ambient.ogg

Submission

To submit your shell:

  • Export and test your shell
  • Put the following files into a directory named after your shell:
    • the Pahts_District_sNNN.prp file
    • all compiled Python files (e.g. sNNN*.pyc)
    • any SDL files
    • any OGG files
  • Zip up the directory, then submit them to Aloys
Personal tools