Difference between revisions of "Module:Notes"

From BNC4FREE
Jump to navigation Jump to search
(Initial Page)
 
m (Format Changes)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Information about this module will appear shortly
+
This module lets you store notes within the bouncer. Notes are available in the webpanel and will also be displayed to you on connect (unless you choose for them not to be).
  
[[Category:Modules]]
+
= Usage =
 +
 
 +
== Arguments ==
 +
This module takes 2 arguments
 +
 
 +
{| class="wikitable"
 +
! style="font-weight:bold;" | Argument
 +
! style="font-weight:bold;" | Type
 +
! style="font-weight:bold;" | Description
 +
|-
 +
| -disableNotesOnLogin
 +
| Optional
 +
| Takes no other parameters and will disable notes being shown to you on login
 +
|}
 +
 
 +
== Commands ==
 +
To add, remove, modify and list notes, the following commands are available:
 +
 
 +
    /msg *notes add <Key> <Note>
 +
Add a note with a given key/title
 +
 
 +
    /msg *notes del <Key>
 +
Delete a note with a given key/title
 +
 
 +
    /msg *notes mod <Key> <Note>
 +
Modifies a note with a given key/title
 +
 
 +
    /msg *notes list
 +
List all the notes that you have saved
 +
 
 +
[[Category:Modules]] [[Category:User_Modules]]

Latest revision as of 15:41, 20 June 2020

This module lets you store notes within the bouncer. Notes are available in the webpanel and will also be displayed to you on connect (unless you choose for them not to be).

Usage

Arguments

This module takes 2 arguments

Argument Type Description
-disableNotesOnLogin Optional Takes no other parameters and will disable notes being shown to you on login

Commands

To add, remove, modify and list notes, the following commands are available:

   /msg *notes add <Key> <Note>

Add a note with a given key/title

   /msg *notes del <Key>

Delete a note with a given key/title

   /msg *notes mod <Key> <Note>

Modifies a note with a given key/title

   /msg *notes list

List all the notes that you have saved