| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| module:avatars [2018/02/28 11:38] – [Sharing Avatar Collections] Fixed typo digital man | module:avatars [2018/03/01 12:21] – old revision restored digital man |
|---|
| Export frequency controls (''export_freq'' setting in ''modopts.ini'') applies to avatar collections as well as user avatars. | Export frequency controls (''export_freq'' setting in ''modopts.ini'') applies to avatar collections as well as user avatars. |
| |
| | ===== Command-Line ===== |
| | |
| | ''avatars.js'' supports several commands and options, many are only to be used for experimental or trouble-shooting purposes. For a comprehensive list of commands and options, view the file: ''avatars.js'': |
| | |
| | ==== Commands ==== |
| | Commands are just words (no special prefix), but many commands support an optional ''=<value>'' suffix: |
| | |
| | ^ Command ^ Description ^ |
| | | import | Import user avatars and avatar collections from a networked message base | |
| | | import=<usernum> | Import an avatar for a specific local user account number | |
| | | export | Export any new/updated local user avatars to a networked message base | |
| | | export <filenames> | Export one or more avatar collections to a networked message base (forced, not throttled by ''export_freq'' value) | |
| | | export -share | Export any/all locally-shared avatar collections (throttled by ''export_freq'') | |
| | | dump=<usernum> | Display a JSON representation of a local user account's avatar configuration | |
| | | draw | Display (using absolute positioning and ANSI only) the current user's avatar | |
| | | draw=<usernum> | Display specified user's avatar | |
| | | draw <filenames> | Display specified avatar collection files | |
| | | show | Display (using relative positioning and terminal-compliant representation) the current user's avatar | |
| | | show=<usernum> | Display specified user's avatar | |
| | | show <filenames> | Display specified avatar collection files | |
| | | verify <filenames> | Verify specified avatar collection files | |
| | | remove | Remove current user's avatar | |
| | | remove=<usernum> | Remove specified user's avatar | |
| | | enable | Enable current user's avatar | |
| | | enable=<usernum> | Enable specified user's avatar | |
| | | disable | Disable current user's avatar | |
| | | disable=<usernum> | Disable specified user's avatar | |
| | | newuser <filename> | Import a new user default avatar from specified avatar collection file | |
| | | normalize <filenames> | Normalize one or more avatars | |
| | | normalize | Normalize the current user's avatar | |
| | | install | Install the avatars and avatar_chooser modules into a Synchronet system | |
| | |
| | ==== Options ==== |
| | Command-line options contain a ''-'' prefix and are used to modify the default behavior of the ''avatars.js'' module: |
| | |
| | ^ Option ^ Description ^ |
| | | -v | Increase verbosity of console output (e.g. for trouble-shooting) | |
| | | -offset=<value> | Specify a record offset of an avatar in an avatar collection file | |
| | | -realnames | When exporting user avatar, include the user's real name as well as their alias - required if the message network uses/requires real names | |
| | | -ptr=<value> | Over-ride the stored import/export message pointer value | |
| | | -all | Import/export all messages (even those exported locally) - not normally recommended | |
| | | -share | When combined with the ''export'' command, automatically exports any new/updated shared avatar collections and will re-export at the configured ''export_freq'' interval | |
| | | -user=<value> | Specify a user account number to operate on (not normally required) | |
| | | -file=<value> | Specify a filename to operate on (not normally required) | |
| ===== See Also ===== | ===== See Also ===== |
| * [[:module:|Modules]] | * [[:module:|Modules]] |
