User Tools

Site Tools


en:orx:config:encryption

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
Next revisionBoth sides next revision
en:orx:config:encryption [2009/10/06 05:59 (15 years ago)] – Added orxcrypt info iarwainen:orx:config:encryption [2010/05/11 20:51 (14 years ago)] iarwain
Line 18: Line 18:
 @config.ini@ @config.ini@
  
-; Finally we put all the settings that we don't want to end user to mess up with+; Finally we include the file containing all the settings that we don't want to end user to mess up with
 ; If the end-user did provide values for them, they'll be overidden here anyway ; If the end-user did provide values for them, they'll be overidden here anyway
-[...]</code>+@crypted.ini@</code>
  
 In the same way, we can add included files for customized inputs, for example. We would add it just after the inclusion of config.ini.\\ In the same way, we can add included files for customized inputs, for example. We would add it just after the inclusion of config.ini.\\
Line 40: Line 40:
  
 ; Non-overridable config stuff (ie. everything else) ; Non-overridable config stuff (ie. everything else)
-[...]</code>+@crypted.ini@</code>
  
 And, of course, you might not want the end-user to mess up with this file, so we now need to encrypt it when releasing our game. And, of course, you might not want the end-user to mess up with this file, so we now need to encrypt it when releasing our game.
- 
- 
 ===== Encryption ===== ===== Encryption =====
  
Line 51: Line 49:
 Well, now that we've said that, let's see how we can use it! =) Well, now that we've said that, let's see how we can use it! =)
  
-First of all, we need an encryption key (or pass phrase). The longer, the better. If you don't provide any, orx's default one will be used, so you might want to change it for one of yours so that others can (too easily) decrypt your stuff. ;-)+First of all, we need an encryption key (or pass phrase). The longer, the better. If you don't provide any, orx's default one will be used, so you might want to change it for one of yours so that others could not (too easily) decrypt your stuff. ;-)
  
 To set the encryption key, you need to call: To set the encryption key, you need to call:
Line 57: Line 55:
 <code c>orxConfig_SetEncryptionKey("MyVeryLongEncryptionKey");</code> <code c>orxConfig_SetEncryptionKey("MyVeryLongEncryptionKey");</code>
  
-Of course, as orx will load its main config file it is initialized, you need to issue the call to ''orxConfig_SetEncryptionKey()'' before initializing orx. It would look something like this:+Of course, as orx will load its main config file **when** it is initialized, you need to issue the call to ''orxConfig_SetEncryptionKey()'' before initializing orx. It would look something like this:
  
 <code c>int main(int argc, char **argv) <code c>int main(int argc, char **argv)
Line 102: Line 100:
 ==== Input file list ==== ==== Input file list ====
  
-**-f / --filelist**+**-f / ''-''''-''filelist**
  
 The file list is mandatory. At least one file has to be provided and multiple files have to be separated by spaces. Unfortunately input files can't include spaces for now. The file list is mandatory. At least one file has to be provided and multiple files have to be separated by spaces. Unfortunately input files can't include spaces for now.
Line 114: Line 112:
 ==== Encryption key ==== ==== Encryption key ====
  
-**-k / --key**+**-k / ''-''''-''key**
  
 The encryption key parameter is optional. If it isn't provided, orx's default one will be used. The key is used for both decryption and encryption. OrxCrypt will figure by itself if your input files are encrypted or not. The encryption key parameter is optional. If it isn't provided, orx's default one will be used. The key is used for both decryption and encryption. OrxCrypt will figure by itself if your input files are encrypted or not.
Line 130: Line 128:
 ==== Output file ==== ==== Output file ====
  
-**-o / --output**+**-o / ''-''''-''output**
  
 The output parameter is optional. If none is provided, the merged output will be stored in ''orxcrypt.out''. The output parameter is optional. If none is provided, the merged output will be stored in ''orxcrypt.out''.
Line 140: Line 138:
 ==== Decryption ==== ==== Decryption ====
  
-**-d / --decrypt**+**-d / ''-''''-''decrypt**
  
 By default orxCrypt will encrypt the merged file, either by using the encryption key the user provided or by orx's default one.\\ By default orxCrypt will encrypt the merged file, either by using the encryption key the user provided or by orx's default one.\\
Line 150: Line 148:
  
 <code dos>-d</code> <code dos>-d</code>
- 
en/orx/config/encryption.txt · Last modified: 2024/03/11 14:47 (6 weeks ago) by iarwain