Differences

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

--- module:avatars [2019/02/08 04:34] – [PabloDraw] typos digital man
+++ module:avatars [2026/03/01 23:45] (current) – [modopts.ini] Document the enabled option (defaults to true) digital man
@@ Line 14: / Line 14: @@
 ===== Collections =====
-The set of [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/text/avatars/|stock avatar collections]] available for users to choose from includes over 150 original pieces of ANSI-art created and contributed by Synchronet sysops: [[person:digital man]], [[person:echicken]], and [[person:kirkman]].
+The set of [[https://gitlab.synchro.net/sbbs/sbbs/-/tree/master/text/avatars/|stock avatar collections]] available for users to choose from includes over 150 original pieces of ANSI-art created and contributed by Synchronet sysops: [[person:digital man]], [[person:echicken]], and [[person:kirkman]].
 The following screen shots are some of the stock avatar collections being shown in the ANSI terminal mode //Avatar Chooser// (a web-based avatar chooser is also [[https://bbs.electronicchicken.com/?page=More/avatar-gallery.xjs|in the works]], per [[person:echicken]]):
@@ Line 43: / Line 43: @@
 | ''[[dir:exec]]/load/graphic.js''       | ANSI "graphics" library |
 | ''[[dir:exec]]/load/ansiterm_lib.js''  | ANSI terminal library |
+| ''[[dir:exec]]/load/identicon.js''     | Identicon library |
 | ''[[dir:exec]]/showmsghdr.js''         | Module to display a message header, with avatar (i.e. executed via ''msghdr.asc'' for v3.16 ) |
 | ''[[dir:exec]]/showmsgavatar.js''      | Module to display a message avatar, only (using ''text.dat'' approach or custom ''msghdr.asc'') |
@@ Line 53: / Line 54: @@
 | ''[[dir:exec]]/logon.js''              | Updated to display user's avatar during logon sequence |
 | ''[[dir:exec]]/newuser.js''            | Updated to set a new user's default avatar, when configured in ''modopts.ini'' |
-| ''[[dir:text]]/avatars/*.bin''         | Avatar collections (from CVS and imported from SYNCDATA) |
+| ''[[dir:text]]/avatars/*.bin''         | Avatar collections (from the Synchronet Source Repository and imported from SYNCDATA) |
-===== Installation =====
+===== Install =====
 ==== 3.16 ====
 If running Synchronet v3.16 or a non-current v3.17:
-Download the file ''[[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/text/menu/msghdr.asc|msghdr.asc]]'' to your ''[[dir:text]]/menu/'' directory, if you do not already have it (e.g. from CVS).
+Download the file ''[[https://gitlab.synchro.net/sbbs/sbbs/-/raw/master/text/menu/msghdr.asc|msghdr.asc]]'' to your ''[[dir:text]]/menu/'' directory, if you do not already have it (e.g. from [[dev:Git]]).
 This ''msghdr.asc'' will execute the script ''[[dir:exec]]/showmsghdr.js'' whenever a message header is displayed to a user of the Terminal Server.
@@ Line 74: / Line 75: @@
 ==== Step 1 ====
-If you haven't already, get the ''[[dir:text]]/avatars'' directory contents either via CVS or [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/text/avatars/?view=tar|download]] from this web-page: http://cvs.synchro.net/cgi-bin/viewcvs.cgi/text/avatars/
+If you haven't already, get the ''[[dir:text]]/avatars'' directory contents either via Git or download from this web-page: https://gitlab.synchro.net/sbbs/sbbs/-/tree/master/text/avatars/
 ... and place these files in your Synchronet ''text/avatars'' directory (create it if it doesn't exist).
@@ Line 193: / Line 194: @@
 Other than command-line parameters, the only configuration options for ''avatars.js'' are stored in the ''[avatars]'' section of the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:
-<file modopts.ini>
+<file ini>
 [avatars]
 sub          = dove-syncdata
@@ Line 199: / Line 200: @@
 </file>
-^ Option       ^ Description ^
+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.
-| 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'') |
+^ Option       ^ Default  ^ Description ^
+| enabled      | ''true'' | Set to ''false'' to disable avatar prompting and display from the various avatar-enabled JS modules |
+| sub          | //auto// | Sub-board internal code for import and export command (your networked //sync-data// message area) |
+| export_freq  | ''7''    | Maximum export (to message-base) frequency, in days |
+| msg_default  | //none// | Default avatar (base64-encoded) for displaying messages from users without an avatar |
+| //<sub-code>//_default   |//none//| Default avatar (base64-encoded) for the specified message sub-board (internal code, lowercase) |
+| //<group-name>//_default |//none//| Default avatar (base64-encoded) for the specified message group (name, lowercase)|
+| msghdr_draw_top | ''true'' | Display message avatar at the top-of-screen when the message header was displayed at top-of-screen |
+| msghdr_draw_above | ''true'' | Display message header avatar above current cursor position |
+| msghdr_draw_right | ''true'' | Display message header avatar right-justified |
+| auto_identicon    | ''true'' | Auto-generate [[wp>identicons]] for users or message-authors/file-uploaders that don't have an avatar set |
 When user avatars or shared avatar collections (''.bin'' files) are updated, they will be exported immediately (or when the ''AVAT-OUT'' event is executed).
@@ Line 207: / Line 219: @@
 Also in the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:
-<file modopts.ini>
+<file ini>
 [newuser]
 avatar = <base64-encoded avatar data>
 avatar_file = <filename of avatar collection>
 avatar_offset = <0-based record number of avatar to use>
+avatar_identicon = <set to true to auto-generate an identicon based on new user's alias for their default avatar>
 [logon]
@@ Line 223: / Line 236: @@
 The new user default avatar, if you have one, will be set with the ''avatar'' value in the ''[newuser]'' section of the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:
-<file>
+<file ini>
 [newuser]
 avatar=IH8gfyB/3H/cf9x/3H8gfyB/IH8gfyB/3n/bf9t/23/bf91/IH8gfyB/IH/ef9t/23/bf9t/3X8gfyB/IH8gf9x/23/bf9t/23/cfyB/IH8gf9t/23/bf9t/23/bf9t/238gfyB/23/bf9t/23/bf9t/23/bfyB/
@@ Line 229: / Line 242: @@
 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.
@@ Line 235: / Line 251: @@
 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.
+===== Disable =====
+While the Avatar system can be disabled by deleting the events and changing ''set_avatar'' to ''false'' in the ''[login]'' section of ''modopts.ini'', the events will be re-added and ''set_avatar'' set back to ''true'' the next time you run the ''update.js'' script. To prevent this, you must delete all the ''text/avatars/*.bin'' files, which will cause the ''install'' option of ''avatar.js'' to fail.
 ===== Specifications =====
@@ Line 337: / Line 367: @@
 | 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 |
+| 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             | Normalize the current user's avatar |
@@ Line 348: / Line 379: @@
 | -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 |
+| -realnames      | When exporting user avatars, include the user's full real name as well as their alias |
+| -aliasonly      | When exporting user avatars, do not include even an MD5-digest of the user's real name |
 | -ptr=<value>    | Over-ride the stored import/export message pointer value |
 | -all            | Import/export all messages (even those exported locally) - not normally recommended |

Trace: • Avatars

Differences

Navigation

Search

Toolbox