Earwigo Wiki

User Tools

Site Tools

Trace:
cartridges

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
cartridges [2010/08/02 21:54] – Boettcherscartridges [2017/05/01 06:40] (current) – removed references to the tutorial Boettchers
Line 1: Line 1:
-====== Cartridges **Under Construction** ======+====== Cartridges ======
  
 Back to [[edit_cartridges|Tabs List]].  Back to [[edit_cartridges|Tabs List]]. 
  
-(Note1: picture showing the tab for cartridges should go here) +{{:create_your_first_cartridge:clipboard07.jpg|}}
- +
-(Note 2: this page has no content, just the formating)+
  
 ===== Cartridge Tab in the Builder ===== ===== Cartridge Tab in the Builder =====
Line 13: Line 11:
 ==== Properties ==== ==== Properties ====
  
-The **Name** section shows the current name of the cartridge. Since we are working on the cartridge "Tiny Adventure", this is the name that you see in this section.+The **Name** section shows the current name of the cartridge. The screenshot is taken from the tutorial "Tiny Adventure", this is the name that you see in this section.
  
 The cartridge is set to **Visible** by default. I do not think that this has an effect in the current Wherigo players but in general this property makes sure the cartridge is displayed by the Wherigo player. The cartridge is set to **Visible** by default. I do not think that this has an effect in the current Wherigo players but in general this property makes sure the cartridge is displayed by the Wherigo player.
  
-**Use logging when playing cartridge** saves a log of the players progress through the cartridge for debugging. We do not need this option during the tutorial.+**Use logging when playing cartridge** saves a log of the players progress through the cartridge for debugging. 
  
 **Obfuscate Strings** is used to "scramble" the characters in the Wherigo cartridge. This might be necessary because the normal cartridge file contains all text files in readable format. If the solution to your cartridge is contained in the cartridge text, you might want to obfuscate the cartridge's strings. Since this (totally lua compatible) option poses the risk that the cartridge might not play on some players I try to conceal the cartridge secrets by other means. I do for example really like to ask the human player things like "What 5 digit number do you see at this location?" It is quite hard to find the answer to this kind of question without going to the actual location 8-). But as said earlier, the **Obfuscate** option invokes a perfectly legal lua subroutine and it works well. I have not yet heard any complaints about it. **Obfuscate Strings** is used to "scramble" the characters in the Wherigo cartridge. This might be necessary because the normal cartridge file contains all text files in readable format. If the solution to your cartridge is contained in the cartridge text, you might want to obfuscate the cartridge's strings. Since this (totally lua compatible) option poses the risk that the cartridge might not play on some players I try to conceal the cartridge secrets by other means. I do for example really like to ask the human player things like "What 5 digit number do you see at this location?" It is quite hard to find the answer to this kind of question without going to the actual location 8-). But as said earlier, the **Obfuscate** option invokes a perfectly legal lua subroutine and it works well. I have not yet heard any complaints about it.
Line 25: Line 23:
 Make sure to enable the **Upload media file** check mark. This option allows you to upload graphics directly from your computer to the Earwigo server. This is the most convenient way to work with graphics. Make sure to enable the **Upload media file** check mark. This option allows you to upload graphics directly from your computer to the Earwigo server. This is the most convenient way to work with graphics.
  
-**Allow other users to edit cartridge** offers the opportunity to develop a cartridge in a team. If this option is enabled you can send the link to the cartridge to your buddy and have him work on the same cartridge. A good team combination would e.g. be the code crunching lua programmer and the well spoken story teller. We will not use this option during the tutorial. //Side Note: Don't use this option to "donate" your cartridge. If you want to "donate" your cartridge to someone in another country and allow him to set up a copy of your cartridge in his country, you should send him a backup cartridge. He will be able to upload the backup to his account.//+**Allow other users to edit cartridge** offers the opportunity to develop a cartridge in a team. If this option is enabled you can send the link to the cartridge to your buddy and have him work on the same cartridge. A good team combination would e.g. be the code crunching lua programmer and the well spoken story teller. //Side Note: Don't use this option to "donate" your cartridge. If you want to "donate" your cartridge to someone in another country and allow him to set up a copy of your cartridge in his country, you should send him a backup cartridge. He will be able to upload the backup to his account.//
  
-Always set a **Starting location** for your cartridge. This value determines where the cartridge is placed until it is opened (in other words, this is where other people will see your cartridge on a map). This value is also essential for the functionality of the WWB "Zones". All zones will automatically be created at this location until you specify more precise coordinates. If no "Starting location" is specified, new zones can not be created.+Always set a **Starting location** for your cartridge. This value determines where the cartridge is placed until it is opened (in other words, this is where other people will see your cartridge on a map). This value is also essential for the functionality of the "Zones". All zones will automatically be created at this location until you specify more precise coordinates. If no "Starting location" is specified, new zones can not be created.
  
 You might want to set the **Activity type** of your cartridge to an appropriate value. I don't know what effect this value might have but why take chances ;-). You might want to set the **Activity type** of your cartridge to an appropriate value. I don't know what effect this value might have but why take chances ;-).
  
 ==== Events ==== ==== Events ====
 +The cartridge can trigger the following events:
  
-(Explanation of events tab, with a few examples?) +  * **Start** This event is triggered whenever the cartridge is started. You can put your cartridge initialization here. Don't overload this event. There are reports that an overloaded Start event might cause trouble on low CPU power units (typically GPS bases systems).  
 +  * **End** This event fires when the cartridge ends. 
 +  * **Restore** This event is associated with a start from a previously saved position. 
 +  * **Save** This event is activated when the cartridge is saved.
 ==== Author Script ==== ==== Author Script ====
  
-(Explanation of author script, with common examples?) +The author script section can contain any LUA script that you like to add to your cartridge. Basic LUA commands can be entered directly in the events (LUA statement) but more complex scripts can be copied into the Author Script section of the cartridge. Don't forget to select the option "Include Author Script" before you compile your cartridge.
 ==== Map ==== ==== Map ====
- +You can use the map to define the cartridge start location and the alternative start location (see this page for details on cartridge locations). Always create a start location for your cartridge. Other objects (e.g. Zones) need this information to create properly.
-(Explanation of map)+
cartridges.1280778899.txt.gz · Last modified: 2012/07/09 23:38 (external edit)