Differences

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

--- module:avatars [2018/02/28 11:38] – [Sharing Avatar Collections] Fixed typo digital man
+++ module:avatars [2018/03/01 12:11] – Links to util:binkit changed to module:binkit digital man
@@ Line 50: / Line 50: @@
 | ''[[dir:text]]/menu/main.asc''         | Updated to include new ''/A'' (change avatar) main menu option |
 | ''[[dir:exec]]/default.src''           | Updated to include new ''/A'' (change avatar) main menu option |
-| ''[[dir:exec]]/default.bin''           | Generated by compiling ''default.src'' using [[util:Baja]] |
+| ''[[dir:exec]]/default.bin''           | Generated by compiling ''default.src'' using [[binkit]] |
 | ''[[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'' |
@@ Line 84: / Line 84: @@
 From a command prompt, run ''jsexec avatars install''
-This step will perform all the necessary [[util:SCFG]] changes and optional ''[[config:modopts.ini]]'' changes detailed later in this article.
+This step will perform all the necessary [[binkit]] changes and optional ''[[config:modopts.ini]]'' changes detailed later in this article.
 ==== Step 3 ====
 **Optional:**
-Update your command shells to either execute ''avatar_chooser.js'' directly (using Baja ''exec_bin'' or JS ''bbs.exec'' or ''load'' functions) **or** use Baja ''exec_xtrn'' or JS ''bbs.exec_xtrn'' to execute the module via internal code (e.g. ''AVATCHOO''). This [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/exec/default.src?r1=1.18&r2=1.19|small change]] was already made in the "Synchronet Classic" command shell:  ''[[dir:exec]]/default.src''. You will need to recompile ''default.src'' to ''default.bin'' using [[util:Baja]] (in the ''[[dir:exec]]'' directory):
+Update your command shells to either execute ''avatar_chooser.js'' directly (using Baja ''exec_bin'' or JS ''bbs.exec'' or ''load'' functions) **or** use Baja ''exec_xtrn'' or JS ''bbs.exec_xtrn'' to execute the module via internal code (e.g. ''AVATCHOO''). This [[http://cvs.synchro.net/cgi-bin/viewcvs.cgi/exec/default.src?r1=1.18&r2=1.19|small change]] was already made in the "Synchronet Classic" command shell:  ''[[dir:exec]]/default.src''. You will need to recompile ''default.src'' to ''default.bin'' using [[binkit]] (in the ''[[dir:exec]]'' directory):
   baja default.src
@@ Line 102: / Line 102: @@
 ==== AVATCHOO ====
-The //Avatar Chooser// script (by echicken) configured in [[util:SCFG]]->External Programs->Online Programs->Main:
+The //Avatar Chooser// script (by echicken) configured in [[binkit]]->External Programs->Online Programs->Main:
 <file>
 ╔══════════════════════════════════════════════════════════╗
@@ Line 131: / Line 131: @@
 ==== AVAT-IN ====
-Create a timed event to import network user avatars and shared avatar collections via [[util:SCFG]]->External Programs->Timed Events:
+Create a timed event to import network user avatars and shared avatar collections via [[binkit]]->External Programs->Timed Events:
 <file>
 ╔════════════════════════════════════════════════════════════════════╗
@@ Line 157: / Line 157: @@
 ==== AVAT-OUT ====
-Create a timed event to export local users' avatars to message networks via [[util:SCFG]]->External Programs->Timed Events:
+Create a timed event to export local users' avatars to message networks via [[binkit]]->External Programs->Timed Events:
 <file>
 ╔════════════════════════════════════════════════════════════════════╗
@@ Line 228: / Line 228: @@
 </file>
-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 [[binkit]]:
   jsexec avatars newuser=/sbbs/text/avatars/silhouettes.bin
@@ Line 305: / Line 305: @@
 If you use the ''-share'' command-line option along with the ''export'' command, then any files matching the pattern:
 ''[[dir:text]]/avatars///<QWK-ID>//.*.bin'' will be automatically exported whenever the ''avatars.js'' ''export'' command is used.
-Where ''//<QWK-ID//'' is the local system's QWK-ID ([[util:SCFG]]->Message Options->BBS ID) value, in uppercase.
+Where ''//<QWK-ID//'' is the local system's QWK-ID ([[binkit]]->Message Options->BBS ID) value, in uppercase.
 :!: **Note:**
 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 =====
   * [[:module:|Modules]]
-  * [[:util:JSexec]]
+  * [[binkit]]
   * [[https://bbs.electronicchicken.com/?page=More/avatar-gallery.xjs|Web-based Avatar Gallery]]
 {{tag>ansi avatar}}

Trace:

Differences

Navigation

Search

Toolbox