TRIVIA!, SnapNJacks FAQ/Guide Options

[Snap]

SnapNJacks Trivia Guide

(See below for FAQ)

Important Notes

• Before posting about SnapNJack's Trivia, read this entire thread carefully (especially the FAQ)! If you post a question that can be easily answered by reading this thread, your topic will probably be trashed.
• You must be using the Plugin System to use this trivia. Click here to install it!
• This is a beta version. Please report all errors/suggestions in this forum.
• Home Site: http://snapnjacks.com

Explanation: Chat trivia striving for customization, simplicity, and stability. Asks questions and gives hints. This trivia requires no question.txt (But you can use one)-- it downloads questions from a web server.

Installation Instructions

1. Make sure you have the Plugin System installed.
2. Inside your bot type /getplugin st

---

SnapNJack's Trivia is written by Snap, free of charge.
Although Snap gives of his time freely, he does so for people like you.
If you'd like to make a donation via PayPal Snap would be very gratful.

---

Commands:
(As of ver 0.827 - Currently undergoing update.)

Replace the "." below with your bot's trigger. When inside the bot use "/" or "//" as your trigger Using double slash // will make the bot respond out-loud in the channel.



Use Commands: (Commands to use trivia)
.trivia [on/off]
Turns trivia on/off. If no arguements it will respond with the current Status and version. (tells you if trivia is on or off)
.skip
Skips question.
.donate (username) (amount)
Donates to (username) (amount) from your own pocket.
When used in-bot you can donate whatever, including negitive numbers:
/donate snap -100
[4:34:48 PM] Removed ($100.00) from snap



Stat Commands: (Commands to see scores and stats)
.score [Optional Username]
Returns username's score based on the resscore format.
.rank [Optional Username]
Returns username's rank, or your own rank if username is ommited.
Scores:
.hscores/.high scores
Returns the top 10 scores.
.fanswers/.fastest answers
Returns the top 10 fastest answers.
.manswers/.most answered
Returns the top 10 most answered.
.lstreak/.longest streak
Returns the top 10 longest streaks.



Settings Commands: (Commands to change settings)
.hints [number]
Sets the amount of hints to [number].
.hintchar [character]
Sets the hint char, default is a dash(-).
.gemote [on/off]
Emotes all messages, hints, questions - etc.
.useserver [on/off]
Use the server for questions. Or not.
.useprofile [on/off]
Use profile to display stats. (Based on Pformat)
.setfile [optional filename]
Picks the file from the questionfolder - or list the files in the folder (if filename isn't found - or isn't entered) - (".txt" will be added to the end of the file name if it's not there)
Automaticly turns trivia on when a question file is selected.
.blurtstats on/off
Turns blurtstats on/off.
.pformat (text)
Edits the corresponding config entry.
.aformat (text)
Edits the corresponding config entry.
.qformat (text)
Edits the corresponding config entry.
.hformat (text)
Edits the corresponding config entry.



Server Commands: (Commands related to the SnapNJacks Server)
.reportbadq [ID] [EXPLANATION]
Sends a report regarding that question. Example:
[102325] (Category) What's 3 + 3
6
The correct answer was 7
.reportbadq 102325 3+3 is 6!!
This is a very good way to help keep correct and updated questions.
The moderators will review your reports, and repair/delete the questions as needed.
.category [+/-]category1,[+/-]category2, ...
Edits the Category Setting.
Sets the category of questions to be downloaded. (See link for details)
.difficulty [range]
Similar to Category - limits questions to a specific difficulty rating.
1-5 selects all questions with difficults 1 through 5 (all questions)
3-5 selects more difficult questions.


In-Bot only commands: (These commands can't be used in the channel)
/a [Answer]
In-Bot only. Used to answer questions that the bot asks. (Allows you to play from the bot)
/stdelete [user]
Deletes a user from it's database (removing all score and other stats)
/stuserlist
Displays a list of users and their money.
/debug on/off
Turns on debug information
/stconfig
Opens the config file in your default application.
You should open this with notepad, or some other plain-text editor. When selecting notepad, I recommend you click the box "Always open with this program"



Misc:
.stver
Returns the current script version
.qadd
Adds a question to the server's review box. Use .qadd to see an explanation.

End of command list

---

Config Entrys:
Be sure to read the comments in the config too!

Formats:

(Formats allow you to customize what the bot says, using traditional StealthBot-Style variables.)


resscore (Format for the .score command)
Custom response for the .score command.

• Follows Normal Vars

pformat
Custom profile format. Updates after each answer. Variables:

• %hs - High Score
• %fa - Fastest Answers
• %ls - Longest Streaks
• %ma - Most Answered
• Each of these have an optional amount argument:
  

  %hs(5) would return:
  MrDude3: $74.00, MrDude4: $72.00, MrDude2: $67.00, MrDude5: $58.00, MrDude93: $57.00
  (Max 15)

• %su - Current Streak User. Returns the last person to answer a question
• %sc - Streak Count. Returns the amount of questions he has answered in a row
• %ch - Channel. Self-Explanatory.
• %lu - Last Update. Shows the time.
• %nl - New Line

aformat
Custom response to a correct answer.

• Follows Speed Vars and Normal Vars
  Along with:
• %a - The correct answer(s)
• %vl - How much he just got
• %nv - NewValue Current Cash
• %streakbonus - Bonus recievd for Streak - if existing.

qformat
Custom format for a question to be asked.

• %sk - Previous skipped answer - if existing.
• %df - Difficulty
• %vl - Value
• %id - ID number on snapnjacks.com
• %q - Question
• %ct - Category

Possible QFormat = "%skQ# %id (%ct) Difficulty: %df, for $%pt!: %q"
Possible outcome: "Q# 2341 (Family Guy/Cartoons) Difficulty: 3, for $2.50!: Who's the fattest guy in Family Guy?"


hformat
Custom format for hints to be displayed.

• %h - The hint

Hformat = "/me [%h]"
would result in emoted hints.

---

Anouncments:

AncStreakBreak (Break anothers streak)
Default: Sweet! %u, you broke %su Streak of %st!

• Follows Speed Vars and Normal Vars
  Along with:
  %su Current "Streak User".
  %st The Streak count of the %su

AncStreakRecord (Beat streak all-time record)
Default: Congrats %u! You have beaten the record for longest streak![%st]%nlPreviously held by %su. With a streak of: [%sa]

• Follows Speed Vars and Normal Vars
  Along with:
  %su All-time Record Holder.
  %sa All-time Record's Count.

AncStreakPersonal (Beat personal streak record)
Default: Nice %u! You beat your record for longest streak![%st]

• Follows Normal Vars

AncSpeedRecord (Beat speed all-time record)
Default: Congrats %u! You have beaten the record for fastest answer![%spm ms]%nlPreviously held by %fu. With a speed of: [%fa ms]

• Follows Speed Vars and Normal Vars
  Along with:
  %fu Record holder's username.
  %fa Record holder's speed.

AncSpeedPersonal (Beat personal speed record)
Default: Great job %u! you beat your fastest time![%spm ms]

• Follows Speed Vars and Normal Vars

---

Speed Vars
Speed variables - for showing speed:

• %sps - Speed in seconds.
• %spm - Speed in miliseconds
• %sps(0) Speed - rounded to the 0th decimal. 22 seconds
• %sps(1) Speed - round to the 1st decimal. 22.1 seconds
• %sps(2) Speed - 22.11 seconds
• %sps(3) Speed - 22.113 seconds
• %sps(4) Speed - 22.1132 seconds

Normal Vars

• %vl - Money, in currency style.
• %intmoney - Money as just a number.
• %st - Current Streak amount
• %qa - Questions Answered
• %fa - Fastest Answer
• %la - The time of his last answer.
• %intrank - Rank as just a number.
• %rank - Rank with a suffix, like: 1st, 2nd
• %u - Username of the user in question.
• %nl = New Line - This will use multiple addq's. (Gemote still affects the newlines)

---

Category Setting

.category -Starcraft,-80s
Result: Starcraft and 80s questions will no longer be asked.
.category +Starcraft,+80s
Result: Starcraft and 80s questions will be asked.
.category Starcraft,Movies,Pop
Result: ONLY Starcraft, Movies, and Pop questions will be asked.

A full list of categories are listed at snapnjacks.com Here.

---

Options:
These options are all set as true/false.
Note: Some of them may not exist in the config - You must add them to the config. (Such as Debug)

• blurtstats - Randomly blurt random statistics when someone answers a question
• useserver - Uses the server, or a file for questions.
• GlobalEmote - Sets EVERYTHING to be emoted, commands, hints, questions, answers.
• StopOnEmpty - Trivia script stops when it see's "No one hears you"
• debug - Outputs some debuging information - specificly helpful for debuging a question file (finds erroring lines in a question file)

---

[Access] Section:
The [access] section in the config allows you to set access for any of commands in SnapNJacks.
Note: The access must be set for the real command name, not an alias created by the [Commands] section
All commands will default to the Access setting at the top of the config file. 0 allows anyone to use it.

Command=Access
Examples:
Trivia on=10
Score=0


[Commands] Section:
The [commands] section in the config allows you to set unlimited AKA's for any command.
AKA=Command
Examples:
turn trivia on=trivia on
myscore=score
top scores=hscores
Click here for a list of commands

---

Latest Version: 0.827

This post has been edited by The-Black-Ninja: Oct 17 2008, 02:56 PM

[Snap]

SnapNJacks Trivia FAQ


How can I make it emote?/Changing the color of questions.


How do I change hints from "Hint: -----" to "Hint: _____" or any char


How do I get the script?


My Trivia Bot Floods out!


How can I input my own question files!?


How to delete the user-database/How do I reset the scores.


How do I edit the score of a user/How do I delete a user.


If I want to use question files, where can I find some questions?


I'm recieving an error message!


Can I add a question to the server?


I don't like the questions it's asking.


How many questions does the server have?


Can I use the old Trivia still?


When will SnapNJacks be out of Beta?


How can I make hints easier/more difficult?


What's the config.ini?


Why "SnapNJacks"?

---

• Q: How can I make it emote?/Changing the color of questions.
• A: Type /gemote on.
  
  
• Q: How do I change hints from "Hint: -----" to "Hint: _____" or any char.
• A: Type use /hintchar [newchar]
  
  
  
• Q: How do I get the script?
• A: You must have the Plugin System. Then type "/getplugin st". At this time there is no intention of ever making a script.txt version.
  
  
• Q: My Trivia Bot Floods out!?
• A: You'll need to open up your ST_Config.ini located in your plugins folder.
  To open up your bots folder: Settings > Edit Files... > Open Bot Folder (Then open your plugins folder)
  Open up your ST_Config.ini using a text editor, like notepad. And find these lines:
  

  ; Amount of seconds between hints (must be above 5)
  Askrate=9
  ; Delay after a question has been answered, to ask again.
  AnswerDelay=7
  
  ; Randomly blurt a random stastic after a question is answered (odds are one in 5 if no other anouncment is made.)"
  BlurtStats=True"
  

  
  Try setting Askrate=12 and AnswerDelay=9.
  The larger the number the longer the wait between questions.
  You can also turning BlurtStats off. (by setting BlurtStats=False)
  
  
  
• Q: How can I input my own question files!?
• A: When the script loads for the first time it will create a "question files" folder located in your StealthBot directory.
  Simply put you're question file in there, and in the bot type /useserver off.
  To open up your bots folder: Settings > Edit Files... > Open Bot Folder
  Questions file can be listed and selected via the setfile command.
  
  Supported file format:
  Question*Answer1/Answer2*2
  The 2 at the end is the money amount recieved for answering the question (negitive numbers, and decimals are accepted)
  And // should be used for comments.
  
  Example of a question.txt:
  

  What is 2+2?*4/four*1
  State in base 2 the number 4.*100*2
  //This is a comment here just for no reason.
  There are no strings on*me*1
  Cat and the*hat

  
  There must be at least 3 questions in the file (in the correct format) for it to work.
  The question file must be a "txt" file. But it doesn't matter what the file name is.
  
  Questions will default with the qtxtvalue config entry.
  Questions are asked at a reduced-repeat chance random method. (The same question can be repeated twice in a row, but it's highly unlikely.)
  
  
• Q: How to delete the user-database/How do I reset the scores.
• A: Simply open your plugins folder and delete the ST_Users.mdb file.
  You can delete specific users using the stdelete command.
  
  
• Q: How do I edit the score of a user/How do I delete a user.
• A: You can modify a user using donate command in-bot using negitive/positive numbers.
  You can delete specific users using the stdelete command.
  
  
• Q: If I want to use questions files, where can I find some questions?
• A: A collection of several question files compiled by Jack: Click.
  
• Q: I'm recieving an error message!
  ST: Question download failed:
  There's 2 possibilities.
  #1. You have set your Category string to something with no results.
  #2. The server is down - if you can view http://snapnjacks.com. then this isn't the case.
  
  If you receive any other error, please post them in this forum, so that they can be resolved publicly.
  
• Q: How many questions does the server have?
• A: Last I checked it was at 28,805 (08/31/07). Click here for current amount - The amount of questions will continue to grow.
  
  
• Q: Can I add a question to the server?
• A: Please do! The questions you add will be reviewed. Go to: http://snapnjacks.com/qsubmit.php to add your questions to the review.
  If you have a large question file you wish to add. Please PM me.
  
  
• Q: I don't like the questions it's asking.
• A: Use the .category command. As explained Here.
  If you find any erroneous questions/answers please report them using the .ReportBadQ command.
  
  
• Q: Can I use the old Trivia still?
• A: Feel free to continue to use the old trivia. New users should start with SnapNJacks. Old users are recommended to switch to SnapNJacks once out of beta. (Until then the features may not be up to par).
  Remember that forum support is no longer provided for any of the old trivia versions.
  
  
• Q: When will SnapNJacks be out of Beta?
• A: This may take a while, the beta must be fully functional before it's officialy out of beta. Although it may take a while, it probably wont take as long as 2.7 has been in beta. lol
  
  
  
  - Not up to date.
  
• Q: What are the HintStartOdds and HintDecOdds settings? / How can I make hints easier/more difficult?
• A: Here's a little explanation of the hint system:
  • The hint subroutine loops through each letter in the answer. For each letter there is a [HintStartOdds] probability that that specific letter will be "uncovered". So, at the default of .25, there is a 25% chance of any specific letter being uncovered. Note that this probability value is modified slightly according to the length of the answer, so it will NOT be exactly what you set it at for each hint set.
  • For each successive hint (the 2nd and 3rd hints), the HintStartOdds value is decreased by a factor of [HintDecOdds]. This is done so that for each successive hint there is less of a chance of letters being uncovered.
  If none of that really made sense to you, just keep this in mind:
  • If you want easier hints, you should increase the HintStartOdds value.
  • If you want more difficult hints, you should decrease the HintStartOdds value.
  Note that since it's a probability, the value of HintStartOdds must a decimal between 0 and 1. Also, if you choose to change it's value, the amount you increase/decrease it should be small! For example, changing it from .25 to .4 will make a huge difference, and the hints may become too easy.
  
  
  
  
• Q: What's the config.ini?
• A: The ST_Config.ini stores all your settings, to customize it just for you.
  Powerful customizations can be made using this. The entire script is built around the settings in it.
  There are comments explaining each one, - but if you have any more questions feel free to post it, and i'll add it to this FAQ
  

  [main]
  ; How much access required for basic commands?
  Access=40
  ; Download questions from SnapNJacks.com a constantly growing database of questions.
  ; If false, A question file will be used
  UseServer=True
  ; Amount of hints the bot will give
  Hints=5
  ; Starting probability of a certain chararacter being uncovered in each hint
  HintStartOdds=.25
  ; Decrease factor of probability in each successive hint
  HintDecOdds=.85
  ; Amount of seconds between hints (must be above 5)
  Askrate=9
  ; Delay after a question has been answered, to ask again.
  AnswerDelay=7
  ; Consecutive unanswered questions before shutdown. 0 to disable.
  AutoDisableQ=10
  ; Less than amount of people in channel for shutdown. 0 to disable.
  AutoDisableP=0
  ; Greater than amount of people in channel for startup. 0 to disable.
  AutoEnableP=0
  ; Categorical Selection String:
  ; Leave blank to not confine results
  Category=warcraft,-dota
  ; Difficulty limit, 0-5 downloads all questions.
  ; 3 downloads only questions with a difficulty level of 3
  ; 4-6 downloads only questions with a difficulty of 4, 5 or 6
  Difficulty=0-5
  ; Question Format
  ; How a normal question is displayed. Note: You MUST have %q
  QFormat=%sk(%ct) $%vl: %q
  ; Hint Format
  ; How a hint is displayed. Note: You MUST have %h
  HFormat=Hint: %h
  ; How many unanswered questions before shutting down
  autodisableq=15
  ; Profile doesn't work yet
  ; Display last question last answer. And Current question in the bots profile. (Also displays latest Hot-Shot)
  UseProfile=False
  ; ProfileTemplate - (Comming soon maybe?)
  ProfileTemp=current question: %question&& Current score leader: %Hotshot
  ; Uflist thingy here (Unsupported ATM)
  ; //Use /f m to display questions to those only in the channel. Note: This requires use of your friends list. Your friends may be deleted from the list.
  ; These must be in the bots folder (or sub directory).
  Questions=
  Scores=plugins\ST_users.txt
  QuestionFile=warcraft.txt
  debug=false
  

  
  
  
  
• Q: What's the name of SnapNJacks Trivia?
• A: Well, it's not called:
  JackSpot's
  SnapShots
  SnapNCracks
  SnappleJacks
  SnappinJumps
  SlapJacks
  SnapsJacks
  SnapNHacks
  While I'll admit some of those are a lot funnier.
  It's SnapNJacks > Snap And Jacks < Because Jack and I came up with the idea for this.

This guide was last updated 11/08/07 For Version 0.82

This post has been edited by Snap: Apr 4 2009, 05:02 PM