Completition code

[+Mr. REM Esq.]

Hi colleagues.

 

Please tell me how to work with completition code? How generate it and store when cartridge has been completed?

[Ranger Fox]

In Groundspeak's Builder, Urwigo, or Earwigo?

 

Try doing a search in this forum for "CompletionCode" (one word) and you should get several topics. If you do two words, put them in quotes and you'll get a few more topics. We've been talking about the completion code since this forum began in January 2008.

 

Here's some information about the completion code:

The completion code is 15 characters. At times, the player will see a 16 character completion code. This is a bug and we are aware of this. Please instruct your players to remove the last character in their completion code and they'll be able to unlock the cartridge.

 

For those of us using either a Garmin or a third-party Player that creates save files (I don't think any of the third-party Player developers have been able to create a proper save file that the web site can import), please also unlock the cartridge when you display the completion code. This is important because, when the Wherigo API is complete, the third-party Player developers will be able to unlock the cartridge for their players. I imagine they will choose to do so when the cartridge is marked as unlocked.

 

There are two things you can do with the completion code. I recommend them both. You can show the completion code in a dialog. You can also set a task or item's name or description to the completion code.

 

And, now, a step-by-step tutorial using Groundspeak's Builder (because that's the only Builder I have installed on my work's virtual machine). You will also find this tutorial attached to this post.

 

• Go to wherever you want to show the user's unlock code in the cartridge.
  
• Click "Add an Action", choose "Show a message to the player", and click on the "messagebox" link in the second section.
  
• Now, type in something like "Your completion code is: ]] .. Player.CompletionCode .. [[. Please use it to unlock the cartridge." Do not type the double quotes. The "]] .. Player.CompletionCode .. [[" section is what will fool the Builder into displaying the completion code text.
  
• We will now add the completion code to a task (just remember: completed tasks might not show to players on some Players). Click the "Script to run when button clicked" button in the same screen you typed your message.
  
• Click "Add an Action", choose "Set an object property or variable to a value, variable or object property", and click on the first hyperlink in the second section.
  
• Choose the following: your object type is a Task (or Item), the object is whatever task (or item) you're going to use, and the Description property. Click the upper "OK" button.
  
• Click the second hyperlink in the second section. Choose the "Value" radio button and type "[[Your completion code is ]] .. Player.CompletionCode .. [[.]]" (again, without quotes).
  
• Click a bunch of OK buttons until you're back to the main screen. You're done.
  

CompletionCode_Demo.zip

[+Mr. REM Esq.]

Thank you very much!

 

If I understood you correctly, completion code will be generated automatically during cartridge compiling. Is it correct?

 

I use Urwigo builder. How correctly to write "Your completion code is: ]] .. Player.CompletionCode .. [[. Please use it to unlock the cartridge" in message window? I tried to write "as is" and see full string in the message window in player (not completion code). Does Urwigo use another syntax?

[+jonny65]

create a message and in it a concatenate box with 2 (string) values and the code itself. drag the object property from the left frame "objects and properties" > player > completion code and drag it into the concatenate box.

 

 

dont forget to set the cartridge to status complete.

output of the code only works, if the real cartridge is downloaded from Wherigo.com. in emulator a dummy code like 012345678901234 will be shown.

Edited December 15, 2011 by jonny65

[+Mr. REM Esq.]

create a message and in it a concatenate box with 2 (string) values and the code itself. drag the object property from the left frame "objects and properties" > player > completion code and drag it into the concatenate box.

 

 

dont forget to set the cartridge to status complete.

output of the code only works, if the real cartridge is downloaded from Wherigo.com. in emulator a dummy code like 012345678901234 will be shown.

Thanks a lot.

[+redsox_mark]

Is it mandatory (or just good form) to provide a completion code and unlock? My Wherigo is designed to be used to find a Wherigo Geocache, and it does that. I didn't address the concept of a completion code or unlocking.

[+Mr. REM Esq.]

Is it mandatory (or just good form) to provide a completion code and unlock? My Wherigo is designed to be used to find a Wherigo Geocache, and it does that. I didn't address the concept of a completion code or unlocking.

It's good form for Wherigo caches.

[Ranger Fox]

Is it mandatory (or just good form) to provide a completion code and unlock? My Wherigo is designed to be used to find a Wherigo Geocache, and it does that. I didn't address the concept of a completion code or unlocking.

I agree with Mr. REM Esq. While unlocking cartridges doesn't have any benefit now, it will most likely play a role in the future. As a player, I would prefer for all the cartridges I've played up to this point to be unlocked when such a status begins to have meaning. In geocaching terms, we're at the point where "found it" logs don't have any benefit, but I want all of my found caches to be marked as such so when it becomes possible to filter the caches by the ones I haven't found, I'll be set.

[+redsox_mark]

Ok, thanks - I'll look into how to do that.

 

The way I have set my Wherigo up - when you get to the end of the game and it tells you where the cache is, I give the player a choice to choose either "Found the cache" or "Did not find the cache". Either way, the game ends at that point.

 

From a Wherigo perspective, I guess it makes sense to unlock which ever action is chosen, as the Wherigo is complete either way.

 

If you could point me to how to add the completion code/unlock that would be appreciated!

 

Mark

[+redsox_mark]

Duh - sorry, there are instructions at the start of this thread. I'll use those.

[+redsox_mark]

I tried following the example. I already had a "show a message to the player" action when the game ends, so I tried to add the completion code, but it shows the completion code as "builder"???

[Ranger Fox]

I tried following the example. I already had a "show a message to the player" action when the game ends, so I tried to add the completion code, but it shows the completion code as "builder"???

This is correct. The only time you'll ever see a valid completion code is when the cartridge is downloaded from Wherigo.com (the completion code is injected to the cartridge when a user downloads it). I believe the completion code is related to the user's GUID and the cartridge's GUID, both of which are unavailable from your computer. Anyway, long post short, you are seeing correct functionality.

[+redsox_mark]

I tried following the example. I already had a "show a message to the player" action when the game ends, so I tried to add the completion code, but it shows the completion code as "builder"???

This is correct. The only time you'll ever see a valid completion code is when the cartridge is downloaded from Wherigo.com (the completion code is injected to the cartridge when a user downloads it). I believe the completion code is related to the user's GUID and the cartridge's GUID, both of which are unavailable from your computer. Anyway, long post short, you are seeing correct functionality.

 

Thanks again Ranger Fox!