General Attraction Submission Format

From Blue Mars Developer Guidebook

This page is protected and certified by Avatar Reality Inc. Only Editable by Avatar Reality Staff Members.

Attraction Submission Format.

Standard Folder Path Format

Setting up the file structure for your Blue Mars directories

Now it's time to set up your file structure. You can see an example structure in the sample level we included in your installer: \Game\Levels\NEWCO\

When you create a city using the template function in the City Editor: City Editor ->New... and enter your level name. The level name is composed of <COMPANYCODE>_<CITYPATH>. The Company Code has a Maximum of 6 alphanumeric characters and the letters must be Uppercase. You choose this code when you sign up for a city in the developer MyPage. The company code is followed by an underline character, then the city path. This is also something that you will choose when you sign up for a city.

In the following example TEST is the Company Code(your company name) and template is the city name. This will create a Directory Called TEST(Company Code) and in that directory it will create a City Directory called template, when you goto City Editor ->File ->Save ,This file will be saved in the City Directory, template. Currently there is only one template available but more are coming soon. This is only a template to start you off, please change the City to your specifications.



or rename the /Levels/NewCompany/ folder to match your company name. For example: for company=AR: /Levels/AR/ (the company name is limited to 6 alphanumeric characters upper case ONLY) Rename the /Levels/YourCompany/NewCompany_NewCity/ folder to match your company and city name. For example: for company=AR and city=BeachCity: /Levels/AR/AR_BeachCity/ Rename the /Levels/YourCompanyName/YourCityName/NewCompany_NewCity.cry file to match your company and city name. For example: /Levels/AR/AR_BeachCity/AR_BeachCity.cry You must have a city directory. Create the following folders: For simplicity and ease of maintenance, we recommend storing all of your data in the Common directory. These files can be shared by all of your blocks and cities:

/Game/Levels/YourCompany/Common/Entities (.ent files)

/Game/Levels/YourCompany/Common/Materials

/Game/Levels/YourCompany/Common/Objects

/Game/Levels/YourCompany/Common/Scripts/ (.lua scripts)

/Game/Levels/YourCompany/Common/Textures

For example: /Game/Levels/AR/Common/Entities

If you really need to separate some data or source files for a particular city, you can place them here. These files can only be used by that particular city.

/Game/Levels/YourCompany/YourCompany_YourCityName/Entities

/Game/Levels/YourCompany/YourCompany_YourCityName/Materials

/Game/Levels/YourCompany/YourCompany_YourCityName/Objects

/Game/Levels/YourCompany/YourCompany_YourCityName/Scripts/Entities/Minigames

/Game/Levels/YourCompany/YourCompany_YourCityName/Textures

For example: /Game/Levels/AR/AR_BeachCity/Entities

Important:

The data stored in the "Common" folders will be shared with the block creators in all of your cities. You must NOT change any of the data in the "Common" folders after you release it to the public. This will avoid missing textures, broken scripts and geometry, and other unexpected results.

MyData:
Game/Objects/MyData/YourCompany_YourCityName/BlockNames

Standard Object Folder Format

Objects such as vegetation should be named as the following examples: CoconutTree, Flower_yellow
When naming an object use underline _ or no space between words, do not have blank spaces in the names of Objects or Directory names.