| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| module:avatars [2018/03/01 12:21] – old revision restored digital man | module:avatars [2019/06/04 02:13] – [Commands] Added msg-default command digital man |
|---|
| |
| |
| ===== Installation ===== | ===== Install ===== |
| |
| ==== 3.16 ==== | ==== 3.16 ==== |
| export_freq = 7 | export_freq = 7 |
| </file> | </file> |
| | |
| | The ''showmsgavatar.js'' module uses the ''sub_default'' or ''//<group-name>//_default'' or ''//<sub-code>//_default'' values for a default avatar to show for messages from users without an avatar. |
| |
| ^ Option ^ Description ^ | ^ Option ^ Description ^ |
| | sub | Sub-board internal code for import and export command (default: //auto-detected//) | | | sub | Sub-board internal code for import and export command (default: //auto-detected//) | |
| | export_freq | Maximum export (to message-base) frequency, in days (default: ''7'') | | | export_freq | Maximum export (to message-base) frequency, in days (default: ''7'') | |
| | | msg_default | Default avatar (base64-encoded) for displaying messages from users without an avatar | |
| | | //<sub-code>//_default | Default avatar (base64-encoded)for the specified message sub-board | |
| | | //<group-name>//_default | Default avatar (base64-encoded) for the specified message group | |
| |
| When user avatars or shared avatar collections (''.bin'' files) are updated, they will be exported immediately (or when the ''AVAT-OUT'' event is executed). | When user avatars or shared avatar collections (''.bin'' files) are updated, they will be exported immediately (or when the ''AVAT-OUT'' event is executed). |
| |
| This value can be set/changed with the ''avatar.js'' ''newuser'' command. For example, using [[util:JSexec]]: | This value can be set/changed with the ''avatar.js'' ''newuser'' command. For example, using [[util:JSexec]]: |
| jsexec avatars newuser=/sbbs/text/avatars/silhouettes.bin | jsexec avatars newuser=/sbbs/text/avatars/silhouettes.bin -offset=0 |
| | |
| | **Note:**\\ |
| | If no ''-offset'' value is provided, then an avatar will be chosen from the specified avatar collection (''.bin'' file) at random. |
| | |
| |
| If the ''avatar_offset'' key is not set (e.g. to a 0-based record index into the ''.bin'' file), then an avatar will be chosen at random from the specified ''avatar_file''. | If the ''avatar_offset'' key is not set (e.g. to a 0-based record index into the ''.bin'' file), then an avatar will be chosen at random from the specified ''avatar_file''. |
| |
| | ==== Message Default Avatar ==== |
| | |
| | A default message avatar may be imported into the ''msg_default'' key of the ''[avatars]'' section of the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file using [[util:JSexec]]: |
| | jsexec avatars msg-default=/sbbs/text/avatars/silhouettes.bin -offset=0 |
| | |
| | **Note:**\\ |
| | If no ''-offset'' value is provided, then an avatar will be chosen from the specified avatar collection (''.bin'' file) at random. |
| | |
| | Once imported into the ''modopts.ini'' file, you can rename or copy the ''msg_default'' key to ''//<sub-code>//_default'' or ''//<group-name>//_default'' as desired. The ''//<sub-code>//'' and ''//<group-name>//'' must be lower-case. |
| | |
| ===== Specifications ===== | ===== Specifications ===== |
| |
| - PabloDraw defaults to 80 columns width, so you may need to change the width to 10 columns manually | - PabloDraw defaults to 80 columns width, so you may need to change the width to 10 columns manually |
| - PabloDraw defaults to enabling iCE colors, so you may want to disable this to be sure you don't accidentally include the BLINK attribute | - PabloDraw defaults to enabling iCE colors, so you may want to disable this to be sure you don't accidentally include the BLINK attribute |
| - PabloDraw truncates (chops-off) the last line of ''.bin'' files when saving them, so you'll need to add an extra line (e.g. of ''X''s) before saving, and repeat this step if you close and re-open the file in PabloDraw | - PabloDraw truncates (chops-off) the last row of ''.bin'' files when saving them, so you'll need to add an extra line (e.g. of ''X'''s) before saving, and repeat this step if you close and re-open the file in PabloDraw |
| - PabloDraw has issues creating the SAUCE comment block correctly (at last, on Windows) - instead of an array of 64 character fields, it creates a single \n-delimited field, of up to 64 characters | - PabloDraw has issues creating the SAUCE comment block correctly (at least, on Windows) - instead of an array of 64 character fields, it creates a //single// \n-delimited field, of up to 64 characters |
| - You can use ''jsexec sauce -e <filename>'' to edit SAUCE records of files and work around some of these issues | - You can use ''jsexec sauce -e <filename>'' to edit SAUCE records of files and work around some of these issues |
| |
| | disable | Disable current user's avatar | | | disable | Disable current user's avatar | |
| | disable=<usernum> | Disable specified user's avatar | | | disable=<usernum> | Disable specified user's avatar | |
| | newuser <filename> | Import a new user default avatar from specified avatar collection file | | | newuser <filename> | Import a new user default avatar from specified avatar collection file (use with ''-offset'') | |
| | | msg-default <filename> | Import a default message avatar from specified avatar collection file (use with ''-offset'') | |
| | normalize <filenames> | Normalize one or more avatars | | | normalize <filenames> | Normalize one or more avatars | |
| | normalize | Normalize the current user's avatar | | | normalize | Normalize the current user's avatar | |
