From a28327410e882d014cea1485cc13d22176e927a6 Mon Sep 17 00:00:00 2001 From: Xatres Date: Mon, 2 Dec 2013 19:01:17 -0500 Subject: [PATCH 1/4] Updated Beginner's Tour As requested by SabreCat, I've done some editing on the Beginner's Tour. Mostly I just flesh out the guide to how the game works and try to contextualize everything on the page with the user avatar. If we implement these changes, there may need to be a few edits to the starting task descriptions to prevent overlap. Definitely check to make sure I didn't mess up any of the coding. I'm a writer, not a programmer. --- public/js/services/guideServices.js | 33 ++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/public/js/services/guideServices.js b/public/js/services/guideServices.js index ebb9cadb36..df7624c242 100644 --- a/public/js/services/guideServices.js +++ b/public/js/services/guideServices.js @@ -19,35 +19,52 @@ angular.module('guideServices', []). { element: ".main-herobox", title: "Welcome to HabitRPG", - content: "Welcome to HabitRPG, a habit-tracker which treats your goals like a Role Playing Game. I'm Justin, your guide! " + content: "Welcome to HabitRPG, a habit-tracker which treats your goals like a Role Playing Game. I'm Justin, your guide!", + }, { + element: ".main-herobox", + title: "Your Avatar", + content: "This is your avatar. He represents you in the world of Habitica. As you accomplish goals, this little guy will gain levels, earn gold, and equip himself for further challenges ahead.", + }, { + element: ".main-herobox", + title: "Avatar Customization", + content: "You can customize your avatar by clicking on him when the tour is complete. Change your sex, hair color, skin color, and more from this menu. You can also find a number of HabitRPG's exciting social features by clicking through tabs on the customization page.", }, { element: "#bars", - title: "Achieve goals and level up", - content: "As you accomplish goals, you level up. If you fail your goals, you lose hit points. Lose all your HP and you die." + title: "Hit Points", + content: "The red bar tracks your avatar's hit points. Whenever you fail to meet a goal, you take damage and lose HP. If your HP bar reaches zero, you die. Dying results in the loss of one level, all your gold, and a piece of equipment.", + }, { + element: "#bars", + title: "Experience Points", + content: "The yellow bar tracks your avatar's experience points. Whenever you succeed in achieving a goal, you gain both gold and EXP. When your EXP bar maxes out, you gain a level. Gaining levels is how you unlock new and exciting features on HabitRPG.", + }, { + element: "ul.habits", + title: "Types of Goals", + content: "HabitRPG allows you to track your goals in three different ways. These goals are categorized in columns as Habits, Dailies, or To-Dos.", + placement: "bottom" }, { element: "ul.habits", title: "Habits", - content: "Habits are goals that you constantly track.", + content: "Habits are goals that you constantly track. They can be given plus or minus values, allowing you to gain EXP and gold for good habits or lose HP for bad ones.", placement: "bottom" }, { element: "ul.dailys", title: "Dailies", - content: "Dailies are goals that you want to complete once a day.", + content: "Dailies are goals that you want to complete once a day. Checking off a daily reaps EXP and gold. Failing to check off your daily by midnight results in a loss of HP.", placement: "bottom" }, { element: "ul.todos", title: "Todos", - content: "Todos are one-off goals which need to be completed eventually.", + content: "Todos are one-off goals which have no set deadline. They make for a quick and easy way to gain experience.", placement: "bottom" }, { element: "ul.rewards", title: "Rewards", - content: "As you complete goals, you earn gold to buy rewards. Buy them liberally - rewards are integral in forming good habits.", + content: "All that gold you earned will allow you to reward yourself with either custom or in-game prizes. Buy them liberally – rewarding yourself is integral in forming good habits.", placement: "bottom" }, { element: "ul.habits li:first-child", title: "Hover over comments", - content: "Different task-types have special properties. Hover over each task's comment for more information. When you're ready to get started, delete the existing tasks and add your own.", + content: "You can add comments to your tasks by clicking the edit icon. Hover over each task's comment for more details about how HabitRPG works. When you're ready to get started, you can delete the existing tasks and add your own.", placement: "right" } ]; From d2a0fb073fffaffcfb1f58efa7586d804a679027 Mon Sep 17 00:00:00 2001 From: Xatres Date: Fri, 6 Dec 2013 15:46:39 -0500 Subject: [PATCH 2/4] Updated Beginner's Tour, Mk 2 Fixed issues proposed by SabreCat, including gender neutral language, general terminology, and adding a note about unlockable features at the end. --- public/js/services/guideServices.js | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/public/js/services/guideServices.js b/public/js/services/guideServices.js index df7624c242..d7035fce00 100644 --- a/public/js/services/guideServices.js +++ b/public/js/services/guideServices.js @@ -23,19 +23,19 @@ angular.module('guideServices', []). }, { element: ".main-herobox", title: "Your Avatar", - content: "This is your avatar. He represents you in the world of Habitica. As you accomplish goals, this little guy will gain levels, earn gold, and equip himself for further challenges ahead.", + content: "This is your avatar. It represents you in the world of Habitica. As you accomplish goals, your avatar will gain levels, earn gold, and equip itself for further challenges ahead.", }, { element: ".main-herobox", title: "Avatar Customization", - content: "You can customize your avatar by clicking on him when the tour is complete. Change your sex, hair color, skin color, and more from this menu. You can also find a number of HabitRPG's exciting social features by clicking through tabs on the customization page.", + content: "You can customize your avatar by clicking anywhere in this box. Change your sex, hair color, skin color, and more from this menu. You can also find a number of HabitRPG's exciting social features by clicking through tabs on the customization page.", }, { element: "#bars", title: "Hit Points", - content: "The red bar tracks your avatar's hit points. Whenever you fail to meet a goal, you take damage and lose HP. If your HP bar reaches zero, you die. Dying results in the loss of one level, all your gold, and a piece of equipment.", + content: "The red bar tracks your avatar's health points. Whenever you fail to meet a goal, you take damage and lose health. If your health bar reaches zero, you die. Dying results in the loss of one level, all your gold, and a piece of equipment.", }, { element: "#bars", title: "Experience Points", - content: "The yellow bar tracks your avatar's experience points. Whenever you succeed in achieving a goal, you gain both gold and EXP. When your EXP bar maxes out, you gain a level. Gaining levels is how you unlock new and exciting features on HabitRPG.", + content: "The yellow bar tracks your avatar's experience points. Whenever you succeed in achieving a goal, you gain both gold and experience. When your experience bar maxes out, you gain a level. Gaining levels is how you unlock new and exciting features on HabitRPG.", }, { element: "ul.habits", title: "Types of Goals", @@ -44,17 +44,17 @@ angular.module('guideServices', []). }, { element: "ul.habits", title: "Habits", - content: "Habits are goals that you constantly track. They can be given plus or minus values, allowing you to gain EXP and gold for good habits or lose HP for bad ones.", + content: "Habits are goals that you constantly track. They can be given plus or minus values, allowing you to gain experience and gold for good habits or lose health for bad ones.", placement: "bottom" }, { element: "ul.dailys", title: "Dailies", - content: "Dailies are goals that you want to complete once a day. Checking off a daily reaps EXP and gold. Failing to check off your daily by midnight results in a loss of HP.", + content: "Dailies are goals that you want to complete once a day. Checking off a daily reaps experience and gold. Failing to check off your daily before the day resets results in a loss of health. You can change your day start settings from the options menu.", placement: "bottom" }, { element: "ul.todos", - title: "Todos", - content: "Todos are one-off goals which have no set deadline. They make for a quick and easy way to gain experience.", + title: "To-Dos", + content: "To-Dos are one-off goals that you can get to eventually. While it is possible to set a deadline on a to-do, they are not required. To-Dos make for a quick and easy way to gain experience.", placement: "bottom" }, { element: "ul.rewards", @@ -66,6 +66,11 @@ angular.module('guideServices', []). title: "Hover over comments", content: "You can add comments to your tasks by clicking the edit icon. Hover over each task's comment for more details about how HabitRPG works. When you're ready to get started, you can delete the existing tasks and add your own.", placement: "right" + }, { + element: "ul.habits li:first-child", + title: "Unlock New Features", + content: "That's all you need to know for now, but I'll be back as you level up to let you know about new features you've unlocked. Each new feature will give you more incentives to accomplish your goals. Find out more at the HabitRPG Wiki or let yourself be surprised. Good luck!", + placement: "right" } ]; _.each(tourSteps, function(step){ From 2d6fb9127328015851b2c1cd6d3573d7a35f884b Mon Sep 17 00:00:00 2001 From: Xatres Date: Sat, 7 Dec 2013 11:59:08 -0500 Subject: [PATCH 3/4] Updated Beginner's Tour, Mk 3 Quickfix to changed "sex" to "body type," in anticipation of coming customization updates. --- public/js/services/guideServices.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/js/services/guideServices.js b/public/js/services/guideServices.js index d7035fce00..438cb9112e 100644 --- a/public/js/services/guideServices.js +++ b/public/js/services/guideServices.js @@ -27,7 +27,7 @@ angular.module('guideServices', []). }, { element: ".main-herobox", title: "Avatar Customization", - content: "You can customize your avatar by clicking anywhere in this box. Change your sex, hair color, skin color, and more from this menu. You can also find a number of HabitRPG's exciting social features by clicking through tabs on the customization page.", + content: "You can customize your avatar by clicking anywhere in this box. Change your body type, hair color, skin color, and more from this menu. You can also find a number of HabitRPG's exciting social features by clicking through tabs on the customization page.", }, { element: "#bars", title: "Hit Points", From 8283eca0d49d89a4c63f9e2e80296d447a9b4862 Mon Sep 17 00:00:00 2001 From: Xatres Date: Sun, 8 Dec 2013 09:54:36 -0500 Subject: [PATCH 4/4] Updated Beginner's Tour, Mk 4 Added link to HabitRPG wiki. --- public/js/services/guideServices.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/js/services/guideServices.js b/public/js/services/guideServices.js index 438cb9112e..c876f0aa04 100644 --- a/public/js/services/guideServices.js +++ b/public/js/services/guideServices.js @@ -69,7 +69,7 @@ angular.module('guideServices', []). }, { element: "ul.habits li:first-child", title: "Unlock New Features", - content: "That's all you need to know for now, but I'll be back as you level up to let you know about new features you've unlocked. Each new feature will give you more incentives to accomplish your goals. Find out more at the HabitRPG Wiki or let yourself be surprised. Good luck!", + content: "That's all you need to know for now, but I'll be back as you level up to let you know about new features you've unlocked. Each new feature will give you more incentives to accomplish your goals. Find out more at the HabitRPG Wiki or let yourself be surprised. Good luck!", placement: "right" } ];