Compare commits

..

2 Commits

Author SHA1 Message Date
Ceda EI 2196d1b49f Add index.html generated from help.md, splendor.min.css 2018-11-06 03:39:41 +05:30
Ceda EI d7769e60d9 Add contents for help.md 2018-11-06 03:39:01 +05:30
3 changed files with 108 additions and 0 deletions

50
help.md Normal file
View File

@ -0,0 +1,50 @@
# Questable
## General guidelines
Questable is an RPG-like bot for maintaining events in real life. Main Tasks
are Quests while other tasks are Side Quests. You can use the bot to maintain
a list of things you need to do.
`/me` shows the player stats and takes you back to the main menu. XP is the
amount of experience gained by completing quests and side quests. To cancel
anything run `/cancel` or `/me`.
## Steps to add Quests/Side Quests
+ From the main menu, press `Add Quests` or `Add Side Quests`.
+ The bot will now ask for name of the quest. Enter a name.
+ Next, choose a difficulty from Low, Medium, High
+ Repeat with priority.
Note: The difficulty and importance of a Quest/Side Quest determine the XP
recieved for the quest.
## Steps to check and edit a Quest/Side Quest
+ From the main menu, press `List Quests` or `List Side Quests`
+ This will bring up a list like this
```
/Q_3 Read Documentation
/Q_1 Learn that thing
/Q_2 Write Documentation
/Q_4 Do that thing
/Q_6 Try that program
```
+ To see the details of a quests/side quest, press the command in front of it.
For instance, to see the details of `Try that program` in the above list, press
`/Q_6`
+ Commands for quests start with `/Q_` whereas commands for side quests start
with `/SQ_`
+ The bot will show the details of the quest/side quest. It will also provide
options to modify it.
+ To mark the quest as done, press `Mark as done`
+ To change the name of the Quest/Side Quest
+ Press `Edit Name`
+ The bot will now ask for a new name
+ Send the new name
+ To change the difficulty of the Quest/Side Quest
+ Press `Change Difficulty`
+ Choose a difficulty from Low, Medium, High
+ To change the priority of the Quest/Side Quest
+ Press `Change Priority`
+ Choose a difficulty from Low, Medium, High

57
index.html Normal file
View File

@ -0,0 +1,57 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Questable Bot</title>
<link rel="stylesheet" href="splendor.min.css">
</head>
<body>
<h1 id="questable">Questable</h1>
<h2 id="general-guidelines">General guidelines</h2>
<p>Questable is an RPG-like bot for maintaining events in real life. Main Tasks are Quests while other tasks are Side Quests. You can use the bot to maintain a list of things you need to do.</p>
<p><code>/me</code> shows the player stats and takes you back to the main menu. XP is the amount of experience gained by completing quests and side quests. To cancel anything run <code>/cancel</code> or <code>/me</code>.</p>
<h2 id="steps-to-add-questsside-quests">Steps to add Quests/Side Quests</h2>
<ul>
<li>From the main menu, press <code>Add Quests</code> or <code>Add Side Quests</code>.</li>
<li>The bot will now ask for name of the quest. Enter a name.</li>
<li>Next, choose a difficulty from Low, Medium, High</li>
<li>Repeat with priority. Note: The difficulty and importance of a Quest/Side Quest determine the XP recieved for the quest.</li>
</ul>
<h2 id="steps-to-check-and-edit-a-questside-quest">Steps to check and edit a Quest/Side Quest</h2>
<ul>
<li>From the main menu, press <code>List Quests</code> or <code>List Side Quests</code></li>
<li>This will bring up a list like this</li>
</ul>
<pre><code> /Q_3 Read Documentation
/Q_1 Learn that thing
/Q_2 Write Documentation
/Q_4 Do that thing
/Q_6 Try that program</code></pre>
<ul>
<li>To see the details of a quests/side quest, press the command in front of it. For instance, to see the details of <code>Try that program</code> in the above list, press <code>/Q_6</code>
<ul>
<li>Commands for quests start with <code>/Q_</code> whereas commands for side quests start with <code>/SQ_</code></li>
</ul></li>
<li>The bot will show the details of the quest/side quest. It will also provide options to modify it.</li>
<li>To mark the quest as done, press <code>Mark as done</code></li>
<li>To change the name of the Quest/Side Quest
<ul>
<li>Press <code>Edit Name</code></li>
<li>The bot will now ask for a new name</li>
<li>Send the new name</li>
</ul></li>
<li>To change the difficulty of the Quest/Side Quest
<ul>
<li>Press <code>Change Difficulty</code></li>
<li>Choose a difficulty from Low, Medium, High</li>
</ul></li>
<li>To change the priority of the Quest/Side Quest
<ul>
<li>Press <code>Change Priority</code></li>
<li>Choose a difficulty from Low, Medium, High</li>
</ul></li>
</ul>
</body>
</html>

1
splendor.min.css vendored Normal file
View File

@ -0,0 +1 @@
@media print{*,:after,:before{background:0 0!important;color:#000!important;box-shadow:none!important;text-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}}@media screen and (min-width:32rem) and (max-width:48rem){html{font-size:15px}}@media screen and (min-width:48rem){html{font-size:16px}}body{line-height:1.85}.splendor-p,p{font-size:1rem;margin-bottom:1.3rem}.splendor-h1,.splendor-h2,.splendor-h3,.splendor-h4,h1,h2,h3,h4{margin:1.414rem 0 .5rem;font-weight:inherit;line-height:1.42}.splendor-h1,h1{margin-top:0;font-size:3.998rem}.splendor-h2,h2{font-size:2.827rem}.splendor-h3,h3{font-size:1.999rem}.splendor-h4,h4{font-size:1.414rem}.splendor-h5,h5{font-size:1.121rem}.splendor-h6,h6{font-size:.88rem}.splendor-small,small{font-size:.707em}canvas,iframe,img,select,svg,textarea,video{max-width:100%}@import url(http://fonts.googleapis.com/css?family=Merriweather:300italic,300);html{font-size:18px;max-width:100%}body{color:#444;font-family:Merriweather,Georgia,serif;margin:0;max-width:100%}:not(div):not(img):not(body):not(html):not(li):not(blockquote):not(p),p{margin:1rem auto;max-width:36rem;padding:.25rem}div,div img{width:100%}blockquote p{font-size:1.5rem;font-style:italic;margin:1rem auto;max-width:48rem}li{margin-left:2rem}h1{padding:4rem 0!important}p{color:#555;height:auto;line-height:1.45}code,pre{font-family:Menlo,Monaco,"Courier New",monospace}pre{background-color:#fafafa;font-size:.8rem;overflow-x:scroll;padding:1.125em}a,a:visited{color:#3498db}a:active,a:focus,a:hover{color:#2980b9}