Difference between revisions of "NapGod.js Discord bot"

From Polyphasic Sleep Wiki
m
Line 17: Line 17:
 
To view information about a sleep schedule, use '''+[schedule-name]''', e.g. '''+DC1'''
 
To view information about a sleep schedule, use '''+[schedule-name]''', e.g. '''+DC1'''
  
Non-polyphasic schedules: '''Mono Random'''
+
* Non-polyphasic schedules: '''Mono Random'''
Biphasic schedules: '''E1 Segmented Siesta BiphasicX'''
+
* Biphasic schedules: '''E1 Segmented Siesta BiphasicX'''
Everyman schedules: '''E2 E3 E4 E5 Trimaxion SEVAMAYL'''
+
* Everyman schedules: '''E2 E3 E4 E5 Trimaxion SEVAMAYL'''
Dual core schedules: '''Bimaxion DC1 DC2 DC3 DC4'''
+
* Dual core schedules: '''Bimaxion DC1 DC2 DC3 DC4'''
Tri core schedules: '''TC1 TC2 Triphasic'''
+
* Tri core schedules: '''TC1 TC2 Triphasic'''
Experimental/Unproven schedules: '''CAMAYL QC0 DUCAMAYL'''
+
* Experimental/Unproven schedules: '''CAMAYL QC0 DUCAMAYL'''
Nap only schedules: '''Dymaxion Naptation SPAMAYL Tesla Uberman'''
+
* Nap only schedules: '''Dymaxion Naptation SPAMAYL Tesla Uberman'''
  
 
Supported schedule variants are shortened extended flipped modified and recovery
 
Supported schedule variants are shortened extended flipped modified and recovery
  
To set your schedule, use '''+set [schedule-name]'''.
+
* To set your schedule, use '''+set [schedule-name]'''.
You may set a schedule variant after a dash, e.g. '''+set DC1-extended'''.
+
* You may set a schedule variant after a dash, e.g. '''+set DC1-extended'''.
For schedules not listed use '''+set Experimental'''.
+
* For schedules not listed use '''+set Experimental'''.
To set your napchart, use '''+set [napchart-link]'''.
+
* To set your napchart, use '''+set [napchart-link]'''.
To set both your napchart and your schedule, use '''+set [schedule] [napchart-link]'''.
+
* To set both your napchart and your schedule, use '''+set [schedule] [napchart-link]'''.
  
 
=== History ===
 
=== History ===
  
Look up someone's schedule history: '''+hist [user] [page]'''
+
* Look up someone's schedule history: '''+hist [user] [page]'''
Look up someone's full schedule history '''+histfull [user] [page]'''
+
* Look up someone's full schedule history '''+histfull [user] [page]'''
Full history does not merge any attempts and shows indices.
+
* Full history does not merge any attempts and shows indices.
You need these indices to edit past schedules.
+
* You need these indices to edit past schedules.
  
 
All dates must be in ''yyyy-mm-dd'' format, such as 2020-04-07
 
All dates must be in ''yyyy-mm-dd'' format, such as 2020-04-07
Add a schedule in the past '''+histadd [schedule-name] [start-date]'''
+
* Add a schedule in the past '''+histadd [schedule-name] [start-date]'''
Remove a schedule in the past '''+histdel [index]'''
+
* Remove a schedule in the past '''+histdel [index]'''
  
 
=== Timezones ===
 
=== Timezones ===
  
Set your timezone '''+settz [timezone]'''
+
* Set your timezone '''+settz [timezone]'''
  
Look up a user's sleep status '''+status [user]'''
+
* Look up a user's sleep status '''+status [user]'''
Look up a user's timezone '''+gettz [user]'''
+
* Look up a user's timezone '''+gettz [user]'''
Look up a user's napchart '''+get [user]'''
+
* Look up a user's napchart '''+get [user]'''
  
  
 
=== Napchart ===
 
=== Napchart ===
  
Create a new napchart '''+create [time-ranges]'''
+
* Create a new napchart '''+create [time-ranges]'''
Show a napchart '''+nc [napchart-link]'''
+
* Show a napchart '''+nc [napchart-link]'''
  
 
=== Roles ===
 
=== Roles ===
  
 
Focus is a mode that disables discord notifications for a time.
 
Focus is a mode that disables discord notifications for a time.
Enter Forced Productivity '''+focus [duration]'''
+
* Enter Forced Productivity '''+focus [duration]'''
Leave Forced Productivity '''+unfocus'''
+
* Leave Forced Productivity '''+unfocus'''
  
Get some information about a role: '''+roleinfo [role]'''
+
* Get some information about a role: '''+roleinfo [role]'''
Disable new youtube video notifications: '''+noYT'''
+
* Disable new youtube video notifications: '''+noYT'''
Enable / disable marketplace role: '''+togglemarketplace'''
+
* Enable / disable marketplace role: '''+togglemarketplace'''
Enable / disable NMO watch group: '''+togglewatchgroup''' (not many people are using NMO, a software which allows one another to watch themselves to avoid oversleeps)
+
* Enable / disable NMO watch group: '''+togglewatchgroup''' (not many people are using NMO, a software which allows one another to watch themselves to avoid oversleeps)
  
  
 
=== Logging ===
 
=== Logging ===
  
To log in a free format: use '''+freelog'''.
+
* To log in a free format: use '''+freelog'''.
To log using the bot's private messages help: use '''+log'''.
+
* To log using the bot's private messages help: use '''+log'''.
To customize logging: use '''+logoption''' to check what options are available to make logging faster or more personalized (could be very useful, do not hesitate to use it).
+
* To customize logging: use '''+logoption''' to check what options are available to make logging faster or more personalized (could be very useful, do not hesitate to use it).
To post an EEG log: use '''+logeeg''' and send the bot your eeg screenshot in a private message.
+
* To post an EEG log: use '''+logeeg''' and send the bot your eeg screenshot in a private message.
Video on how to use the log bot: https://www.youtube.com/watch?v=Syq388GeoPY
+
* Video on how to use the log bot: https://www.youtube.com/watch?v=Syq388GeoPY
  
 
You are welcome to send constructive feedback about the logging bot to Ninichat.
 
You are welcome to send constructive feedback about the logging bot to Ninichat.
Line 82: Line 82:
 
=== Misc ===
 
=== Misc ===
  
Generate Nap God report: '''+report'''
+
* Generate Nap God report: '''+report'''
 
The report is a json file which allows you to see user schedules.
 
The report is a json file which allows you to see user schedules.

Revision as of 13:02, 4 December 2020

Description

The bot allows you to interact with the discord server in multiple ways.

Source

Github link: https://github.com/PolyphasicDevTeam/NapGod.js

Commands

For every command, if [user] is omitted, target defaults to you.

For various tips and tricks about polyphasic sleeping, use !help

Schedules

To view information about a sleep schedule, use +[schedule-name], e.g. +DC1

  • Non-polyphasic schedules: Mono Random
  • Biphasic schedules: E1 Segmented Siesta BiphasicX
  • Everyman schedules: E2 E3 E4 E5 Trimaxion SEVAMAYL
  • Dual core schedules: Bimaxion DC1 DC2 DC3 DC4
  • Tri core schedules: TC1 TC2 Triphasic
  • Experimental/Unproven schedules: CAMAYL QC0 DUCAMAYL
  • Nap only schedules: Dymaxion Naptation SPAMAYL Tesla Uberman

Supported schedule variants are shortened extended flipped modified and recovery

  • To set your schedule, use +set [schedule-name].
  • You may set a schedule variant after a dash, e.g. +set DC1-extended.
  • For schedules not listed use +set Experimental.
  • To set your napchart, use +set [napchart-link].
  • To set both your napchart and your schedule, use +set [schedule] [napchart-link].

History

  • Look up someone's schedule history: +hist [user] [page]
  • Look up someone's full schedule history +histfull [user] [page]
  • Full history does not merge any attempts and shows indices.
  • You need these indices to edit past schedules.

All dates must be in yyyy-mm-dd format, such as 2020-04-07

  • Add a schedule in the past +histadd [schedule-name] [start-date]
  • Remove a schedule in the past +histdel [index]

Timezones

  • Set your timezone +settz [timezone]
  • Look up a user's sleep status +status [user]
  • Look up a user's timezone +gettz [user]
  • Look up a user's napchart +get [user]


Napchart

  • Create a new napchart +create [time-ranges]
  • Show a napchart +nc [napchart-link]

Roles

Focus is a mode that disables discord notifications for a time.

  • Enter Forced Productivity +focus [duration]
  • Leave Forced Productivity +unfocus
  • Get some information about a role: +roleinfo [role]
  • Disable new youtube video notifications: +noYT
  • Enable / disable marketplace role: +togglemarketplace
  • Enable / disable NMO watch group: +togglewatchgroup (not many people are using NMO, a software which allows one another to watch themselves to avoid oversleeps)


Logging

  • To log in a free format: use +freelog.
  • To log using the bot's private messages help: use +log.
  • To customize logging: use +logoption to check what options are available to make logging faster or more personalized (could be very useful, do not hesitate to use it).
  • To post an EEG log: use +logeeg and send the bot your eeg screenshot in a private message.
  • Video on how to use the log bot: https://www.youtube.com/watch?v=Syq388GeoPY

You are welcome to send constructive feedback about the logging bot to Ninichat.

Misc

  • Generate Nap God report: +report

The report is a json file which allows you to see user schedules.