krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-18 15:17:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(FAQ): Static FAQ page

Browse Source 
Introduces a new static page for Frequently Asked Questions, linked from the Help menu. Fixes #5773.
This commit is contained in:
Sabe Jones
2015-09-04 15:05:15 -04:00
parent b5124e6cd8
commit 869651f5a2
5 changed files with 189 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
common/locales/en/faq.json
View File

@@ -1,4 +1,51 @@
{
"wiki": "Wiki"
"frequentlyAskedQuestions": "Frequently Asked Questions",
"FAQheaderOverview": "I'm confused. Where do I get an overview?",
"FAQbodyOverview-1": "First, you'll set up tasks that you want to do in your everyday life. Then, as you complete the tasks in real life and check them off, you'll earn Experience and Gold. Gold is used to buy equipment and some items, as well as custom rewards. Experience causes your character to level up and unlock content such as pets, skills, and quests! For more detail, the wiki has an excellent step-by-step overview of the game <a href='http://habitica.wikia.com/wiki/Habitica_Wiki' target='_blank'>right here</a>.",
"FAQheaderSetUpTasks": "How do I set up my tasks?",
"FAQbodySetUpTasks-1": "Good Habits (the ones with a <span class='glyphicon glyphicon-plus'></span>) are tasks that you can do many times a day, such as eating vegetables. Bad Habits (the ones with a <span class='glyphicon glyphicon-minus'></span>) are tasks that you should avoid, like biting nails. Habits with a <span class='glyphicon glyphicon-plus'></span> and a <span class='glyphicon glyphicon-minus'></span> have a good choice and a bad choice, like taking the stairs vs. taking the elevator. Good Habits award Experience and Gold. Bad Habits subtract Health.",
"FAQbodySetUpTasks-2": "Dailies are tasks that you have to do every day, like brushing your teeth or checking your email. You can adjust the days that a Daily is due by clicking the pencil item to edit it. If you skip a Daily that is due, your avatar will take damage overnight. Be careful not to add too many Dailies at once!",
"FAQbodySetUpTasks-3": "To-Dos are your To-Do list. Completing a To-Do earns you Gold and Experience. You never lose Health from To-Dos. You can add a due date to a To-Do by clicking the pencil icon to edit.",
"FAQheaderSampleTasks": "What are some sample tasks?",
"FAQbodySampleTasks-1": "The wiki has four lists of sample tasks to use as inspiration:",
"FAQlistSampleTasks-1": "<a href='http://habitica.wikia.com/wiki/Sample_Habits#Business' target='_blank'>Sample Habits</a>",
"FAQlistSampleTasks-2": "<a href='http://habitica.wikia.com/wiki/Sample_Dailies#Business' target='_blank'>Sample Dailies</a>",
"FAQlistSampleTasks-3": "<a href='http://habitica.wikia.com/wiki/Sample_To-Dos#Finances' target='_blank'>Sample To-Dos</a>",
"FAQlistSampleTasks-4": "<a href='http://habitica.wikia.com/wiki/Sample_Custom_Rewards#Play.2FRest_.28work.29' target='_blank'>Sample Custom Rewards</a>",
"FAQheaderTaskColor": "Why do my tasks change color?",
"FAQbodyTaskColor-1": "Your tasks change color based on how well you are currently accomplishing them! Each new task starts out as a neutral yellow. Perform Dailies or positive Habits more frequently and they move toward blue. Miss a Daily or give in to a bad Habit and the task moves toward red. The redder a task, the more rewards it will give you, but if it’s a Daily or bad Habit, the more it will hurt you! This helps motivate you to complete the tasks that are giving you trouble.",
"FAQheaderHealth": "Why did my avatar lose Health, and how do I regain it?",
"FAQbodyHealth-1": "There are several things that can cause you to take damage. First, if you left Dailies incomplete overnight, they will damage you. Second, if you click a bad Habit, it will damage you. Finally, if you are in a Boss Battle with your party and one of your party mates did not complete all their Dailies, the Boss will attack you.",
"FAQbodyHealth-2": "The main way to heal is to gain a level, which restores all your Health. You can also buy a Health Potion with Gold from the Rewards column. Plus, at level 10 or above, you can choose to become a Healer, and then you will learn healing skills. If you are in a party (under Social > Party) with a Healer, they can heal you as well.",
"FAQheaderPartyWithFriends": "How do I play Habitica with my friends?",
"FAQbodyPartyWithFriends-1": "The best way is to invite them to a party with you, under Social > Party! Parties can go on quests, battle monsters, and cast skills to support each other. You can also join guilds together (Social > Guilds). Guilds are chat rooms focusing on a shared interest or the pursuit of a common goal, and can be public or private. You can join as many guilds as you'd like, but only one party.",
"FAQbodyPartyWithFriends-2": "For more detailed info, check out the wiki pages on <a href='http://habitrpg.wikia.com/wiki/Party' target='_blank'>Parties</a> and <a href='http://habitrpg.wikia.com/wiki/Guilds' target='_blank'>Guilds</a>.",
"FAQheaderPetsMounts": "How do I get a Pet or Mount?",
"FAQbodyPetsMounts-1": "At level 3, you will unlock the Drop System. Every time you complete a task, you'll have a random chance at receiving an egg, a hatching potion, or a piece of food. They will be stored in Inventory > Market.",
"FAQbodyPetsMounts-2": "To hatch a Pet, you'll need an egg and a hatching potion. Click on the egg to determine the species you want to hatch, and then click on the hatching potion to determine its color! Go to Inventory > Pets to equip it to your avatar by clicking on it.",
"FAQbodyPetsMounts-3": "You can also grow your Pets into Mounts by feeding them under Inventory > Pets. Click on a Pet, and then click on a piece of food from the right-hand menu to feed it! You'll have to feed a pet many times before it becomes a Mount, but if you can figure out its favorite food, it will grow more quickly. Use trial and error, or <a href='http://habitica.wikia.com/wiki/Food#Food_Preferences' target='_blank'>see the spoilers here</a>. Once you have a Mount, go to Inventory > Mounts and click on it to equip it to your avatar.",
"FAQbodyPetsMounts-4": "You can also get eggs for Quest Pets by completing certain Quests. (See below to learn more about Quests.)",
"FAQheaderCharacterClasses": "How do I become a Warrior, Mage, Rogue, or Healer?",
"FAQbodyCharacterClasses-1": "At level 10, you can choose to become a Warrior, Mage, Rogue, or Healer. (All players start as Warriors by default.) Each Class has different equipment options, different Skills that they can cast after level 11, and different advantages. Warriors can easily damage Bosses, withstand more damage from their tasks, and help make their party tougher. Mages can also easily damage Bosses, as well as level up quickly and restore Mana for their party. Rogues earn the most Gold and find the most item drops, and they can help their party do the same. Finally, Healers can heal themselves and their party members.",
"FAQbodyCharacterClasses-2": "If you don't want to choose a Class immediately -- for example, if you are still working to buy all the gear of your current class -- you can click \"Opt Out\" and re-enable it later under User > Stats.",
"FAQheaderBlueManaBar": "What is the blue stat bar that appears in the header after level 10?",
"FAQbodyBlueManaBar-1": "The blue bar that appeared when you hit level 10 and chose a Class is your Mana bar. As you continue to level up, you will unlock special Skills that cost Mana to use. Each Class has different Skills, which appear after level 11 in a special section in the Rewards Column. Unlike your Health bar, your Mana bar does not reset when you gain a level. Instead, Mana is gained when you complete Good Habits, Dailies, and To-Dos, and lost when you indulge bad Habits. You’ll also regain some Mana overnight -- the more Dailies you completed, the more you will gain.",
"FAQheaderMonstersQuests": "How do I fight monsters and go on quests?",
"FAQbodyMonstersQuests-1": "First, you need to join or start a party (under Social > Party). Although you can battle monsters alone, we recommend playing in a group, because this will make quests much easier. Plus, having a friend to cheer you on as you accomplish your tasks is very motivating!",
"FAQbodyMonstersQuests-2": "Next, you need a Quest Scroll, which are stored under Inventory > Quests. There are three ways to get a scroll:",
"FAQlistMonstersQuests-1": "When you invite people to your party, you’ll be rewarded with the Basi-List Scroll!",
"FAQlistMonstersQuests-2": "At level 15, you get a Quest-line, i.e., three linked quests. More Quest-lines unlock at levels 30, 40, and 60 respectively.",
"FAQlistMonstersQuests-3": "You can buy Quests from the Quests Page (Inventory > Quests) for Gold and Gems.",
"FAQbodyMonstersQuests-3": "To battle the Boss or collect items for a Collection Quest, simply complete your tasks normally, and they will be tallied into damage overnight. (Reloading may be required to see the Boss's Health bar go down.) If you are fighting a Boss and you missed any Dailies, the Boss will damage your party at the same time that you damage the Boss.",
"FAQbodyMonstersQuests-4": "After level 11 Mages and Warriors will gain Skills that allow them to deal additional damage to the Boss, so these are excellent classes to choose at level 10 if you want to be a heavy hitter.",
"FAQheaderGems": "What are Gems, and how do I get them?",
"FAQbodyGems-1": "Gems are <a href='https://habitica.com/#/options/settings/subscription' target='_blank'>purchased with real money</a>, although <a href='https://habitica.com/#/options/settings/subscription' target='_blank'>subscribers</a> can purchase them with Gold. When people subscribe or buy Gems, they are helping us to keep the site running. We're very grateful for their support!",
"FAQbodyGems-2": "In addition to buying Gems directly or becoming a subscriber, there are two other ways players can gain Gems:",
"FAQlistGems-1": "Win a Challenge that has been set up by another player under Social > Challenges.",
"FAQlistGems-2": "Contribute your skills to the Habitica project. See this wiki page for more details: <a href='http://habitica.wikia.com/wiki/Contributing_to_Habitica' target='_blank'>Contributing to Habitica</a>.",
"FAQbodyGems-3": "Keep in mind that items purchased with Gems do not offer any statistical advantages, so players can still make use of the site without them!",
"FAQheaderBugsFeatures": "How do I report a bug or request a feature?",
"FAQbodyBugsFeatures-1": "Bug reports are collected on GitHub. Go to <a href='https://github.com/HabitRPG/habitrpg/issues/2760' target='_blank'>Help > Report a Bug</a> and follow the instructions. Don't worry, we'll get you fixed up soon!",
"FAQbodyBugsFeatures-2": "Feature requests are collected on Trello. Go to <a href='https://trello.com/c/odmhIqyW/440-read-first-table-of-contents' target='_blank'>Help > Request a Feature</a> and follow the instructions. Ta-da!",
"FAQcloser": "If you have a question that isn't on this list, come ask in the <a href='https://habitica.com/#/options/groups/guilds/5481ccf3-5d2d-48a9-a871-70a7380cee5a' target='_blank'>Newbies Guild</a>! We're happy to help."
}

19
website/public/css/global-modules.styl
View File

@@ -382,3 +382,22 @@ $hrpg-tag-master
min-height:2em;
background-color: #fff
z-index: 2
// Accordion tweaks for FAQ
a.h2.accordion
display: block
text-decoration: none
a.h2.accordion:before
font-family: 'Glyphicons Halflings'
color: grey
content: "\e114"
margin-right: 0.5em
a.h2.accordion.collapsed:before
font-family: 'Glyphicons Halflings'
color: grey
content: "\e080"
margin-right: 0.5em

2
website/src/routes/pages.js
View File

@@ -20,7 +20,7 @@ router.get('/', i18n.getUserLanguage, locals, function(req, res) {
// -------- Marketing --------
var pages = ['front', 'privacy', 'terms', 'api', 'features', 'videos', 'contact', 'plans', 'new-stuff', 'community-guidelines', 'old-news', 'press-kit'];
var pages = ['front', 'privacy', 'terms', 'api', 'features', 'videos', 'contact', 'plans', 'new-stuff', 'community-guidelines', 'old-news', 'press-kit', 'faq'];
_.each(pages, function(name){
router.get('/static/' + name, i18n.getUserLanguage, locals, function(req, res) {

11
website/views/shared/header/menu.jade
View File

@@ -55,6 +55,8 @@ nav.toolbar(ng-controller='MenuCtrl')
li
a(ui-sref='options.settings.export')=env.t('exportData')
ul.toolbar-submenu
li
a(target='_blank' href='http://habitica.com/static/faq/')=env.t('FAQ')
li
a(target='_blank' href='http://habitica.wikia.com/wiki/')=env.t('overview')
li
@@ -65,8 +67,6 @@ nav.toolbar(ng-controller='MenuCtrl')
a(target='_blank' href='https://trello.com/c/odmhIqyW/440-read-first-table-of-contents')=env.t('requestAF')
li
a(target='_blank' href='http://habitica.wikia.com/wiki/Contributing_to_Habitica')=env.t('contributeToHRPG')
li
a(target='_blank' href='http://habitica.wikia.com/wiki/FAQ')=env.t('FAQ')
ul.toolbar-controls
li.toolbar-subscribe-button
button(ng-if='!user.purchased.plan.customerId',ui-sref='options.settings.subscription',popover-trigger='mouseenter',popover-placement='bottom',popover-title=env.t('subscriptions'),popover=env.t('subDescription'),popover-append-to-body='true')=env.t('subscribe')
@@ -154,6 +154,8 @@ nav.toolbar(ng-controller='MenuCtrl')
span &#9776;
div(ng-show='_expandedMenu.menu === "help"', data-close-menu)
ul.toolbar-submenu
li
a(target='_blank' href='http://habitica.com/static/faq/')=env.t('FAQ')
li
a(target='_blank' href='http://habitica.wikia.com/wiki/')=env.t('overview')
li
@@ -164,8 +166,6 @@ nav.toolbar(ng-controller='MenuCtrl')
a(target='_blank' href='https://trello.com/c/odmhIqyW/440-read-first-table-of-contents')=env.t('requestAF')
li
a(target='_blank' href='http://habitica.wikia.com/wiki/Contributing_to_Habitica')=env.t('contributeToHRPG')
li
a(target='_blank' href='http://habitica.wikia.com/wiki/FAQ')=env.t('FAQ')
ul.toolbar-subscribe(ng-if='!user.purchased.plan.customerId')
li.toolbar-subscribe-button
button.highlight(ui-sref='options.settings.subscription',popover-trigger='mouseenter',popover-placement='bottom',popover-title=env.t('subscriptions'),popover=env.t('subDescription'),popover-append-to-body='true')=env.t('subscribe')
@@ -252,7 +252,7 @@ nav.toolbar(ng-controller='MenuCtrl')
a(ui-sref='options.settings.notifications')=env.t('notifications')
ul.toolbar-submenu
li
a(href='http://habitica.wikia.com/wiki/FAQ', target='_blank')=env.t('FAQ')
a(href='https://habitica.com/static/faq', target='_blank')=env.t('FAQ')
li
a(href='https://vimeo.com/57654086', target='_blank')=env.t('tutorials')
ul.toolbar-controls
@@ -261,7 +261,6 @@ nav.toolbar(ng-controller='MenuCtrl')
ul.toolbar-wallet
li.toolbar-gems(popover-trigger='mouseenter', popover-title=env.t('gemsPopoverTitle'), popover=env.t('gemsWhatFor'), popover-placement='bottom',popover-append-to-body='true')
a.gem-wallet(ng-click='openModal("buyGems",{track:"Gems > Toolbar"})')
//-span.task-action-btn.tile.flush.bright.add-gems-btn ＋
span.Pet_Currency_Gem2x.Gems
span.gem-text {{user.balance * 4 | number:0}}
li.toolbar-currency.gold(popover=env.t('gold') + ' ({{Shared.gold(user.stats.gp)}})', popover-placement='bottom',popover-trigger='mouseenter')

115
website/views/static/faq.jade Normal file
View File

@@ -0,0 +1,115 @@
extends ./layout
block vars
- var layoutEnv = env
block title
title Habitica &VerticalLine;&nbsp;
=env.t('FAQ')
block content
script(type='text/javascript').
function openHashAccordion() {
if (window.location.hash) {
var $target = $(window.location.hash.replace('/',''));
if ($target.hasClass('collapse')) {
$target.collapse('show');
$('html, body').animate({
scrollTop: $($target).offset().top - 100
});
}
}
}
$(document).ready(function(){
openHashAccordion();
});
.row
.col-md-12
.page-header
h1=env.t('frequentlyAskedQuestions')
p.pagemeta
=env.t('lastUpdated')
|&nbsp;
=env.t('September')
|&nbsp;4&comma; 2015
a.h2.accordion.collapsed(href='#overview' data-toggle='collapse')=env.t('FAQheaderOverview')
.clearfix.collapse#overview
p!=env.t('FAQbodyOverview-1')
a.h2.accordion.collapsed(href='#set-up-tasks' data-toggle='collapse')=env.t('FAQheaderSetUpTasks')
.clearfix.collapse#set-up-tasks
p!=env.t('FAQbodySetUpTasks-1')
br
p=env.t('FAQbodySetUpTasks-2')
br
p=env.t('FAQbodySetUpTasks-3')
a.h2.accordion.collapsed(href='#sample-tasks' data-toggle='collapse')=env.t('FAQheaderSampleTasks')
.clearfix.collapse#sample-tasks
p=env.t('FAQbodySampleTasks-1')
br
ul
li!=env.t('FAQlistSampleTasks-1')
li!=env.t('FAQlistSampleTasks-2')
li!=env.t('FAQlistSampleTasks-3')
li!=env.t('FAQlistSampleTasks-4')
a.h2.accordion.collapsed(href='#task-color' data-toggle='collapse')=env.t('FAQheaderTaskColor')
.clearfix.collapse#task-color
p=env.t('FAQbodyTaskColor-1')
a.h2.accordion.collapsed(href='#health' data-toggle='collapse')=env.t('FAQheaderHealth')
.clearfix.collapse#health
p=env.t('FAQbodyHealth-1')
br
p=env.t('FAQbodyHealth-2')
a.h2.accordion.collapsed(href='#party-with-friends' data-toggle='collapse')=env.t('FAQheaderPartyWithFriends')
.clearfix.collapse#party-with-friends
p=env.t('FAQbodyPartyWithFriends-1')
br
p!=env.t('FAQbodyPartyWithFriends-2')
a.h2.accordion.collapsed(href='#pets-mounts' data-toggle='collapse')=env.t('FAQheaderPetsMounts')
.clearfix.collapse#pets-mounts
p=env.t('FAQbodyPetsMounts-1')
br
p=env.t('FAQbodyPetsMounts-2')
br
p!=env.t('FAQbodyPetsMounts-3')
br
p=env.t('FAQbodyPetsMounts-4')
a.h2.accordion.collapsed(href='#character-classes' data-toggle='collapse')=env.t('FAQheaderCharacterClasses')
.clearfix.collapse#character-classes
p=env.t('FAQbodyCharacterClasses-1')
br
p=env.t('FAQbodyCharacterClasses-2')
a.h2.accordion.collapsed(href='#blue-mana-bar' data-toggle='collapse')=env.t('FAQheaderBlueManaBar')
.clearfix.collapse#blue-mana-bar
p=env.t('FAQbodyBlueManaBar-1')
a.h2.accordion.collapsed(href='#monsters-quests' data-toggle='collapse')=env.t('FAQheaderMonstersQuests')
.clearfix.collapse#monsters-quests
p=env.t('FAQbodyMonstersQuests-1')
br
p=env.t('FAQbodyMonstersQuests-2')
br
ul
li=env.t('FAQlistMonstersQuests-1')
li=env.t('FAQlistMonstersQuests-2')
li=env.t('FAQlistMonstersQuests-3')
br
p=env.t('FAQbodyMonstersQuests-3')
br
p=env.t('FAQbodyMonstersQuests-4')
a.h2.accordion.collapsed(href='#gems' data-toggle='collapse')=env.t('FAQheaderGems')
.clearfix.collapse#gems
p!=env.t('FAQbodyGems-1')
br
p=env.t('FAQbodyGems-2')
br
ol
li=env.t('FAQlistGems-1')
li!=env.t('FAQlistGems-2')
br
p=env.t('FAQbodyGems-3')
a.h2.accordion.collapsed(href='#bugs-features' data-toggle='collapse')=env.t('FAQheaderBugsFeatures')
.clearfix.collapse#bugs-features
p!=env.t('FAQbodyBugsFeatures-1')
br
p!=env.t('FAQbodyBugsFeatures-2')
h3!=env.t('FAQcloser')