Improved help content and help menu (#59)

* Added help for the gameplay Current the help covers the following things - about working - about learning - companies - about investing and shares - shop - jobs * Added help for jobs - Introduction for jobs - How to create a job * ui: removed page naviagators for cmd help menu * Restyled by whitespace
Seniru · Dec 26, 2019 · 579aef6 · 579aef6
1 parent f8b5467
commit 579aef6
Showing 1 changed file with 78 additions and 4 deletions.
diff --git a/game.lua b/game.lua
@@ -50,8 +50,79 @@ local cmds = [[
     <b><u>Learning:</u></b> Learning is the only way to get qualifications for some jobs. Higher educational qualifications would result in better jobs.
     <b><u>Companies:</u></b>  You can buy a company when you have enough money for it. You can use your company to create jobs and recruit workers. (And that will increase your profit more and more!!).
     ]]
--- todo: add the help    
-local gameplay = {"<p align='center'><font size='20'><b><J>Game Play</J></b></font></p>GAMEPLAY HELP TODO"}
+-- todo: add the help
+local gameplay = {[[
+    <p align='center'><font size='20'><b><J>Gameplay Overview</J></b></font></p>
+    <font size='12'>This is a <b>Clicker</b> which is largely based on businesses we see everywhere. You start as a little mouse with a basic job, but with a great story to write! Your goal is to earn money, buy companis, hire workers and be the best businessman in transformice!
+    Click each title to know more about each thing in depth:
+    <b><BV>
+            <a href='event:page:help:2'>• Working</a>                       <a href='event:page:help:6'>• Shop</a>
+            <a href='event:page:help:3'>• Learning</a>                      <a href='event:page:help:7'>• Jobs</a>
+            <a href='event:page:help:4'>• Companies</a>
+            <a href='event:page:help:5'>• Investing and Shares</a>
+    </BV></b></font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Working</J></b></font></p>
+    <font size='12'>This is the starting point for many players in this game. Working gives you money, and also it increases our XP level. To work, simply click the button in the bottom-right corner saying <b>Work!</b>
+    As you work, your energy reduces. The amount of energy depends on the job you are doing currently. There are lots of jobs available (and you can create as well) and all of them have varying salaries and energy levels.
+    If you do a good job, then surely you will get lot of money with minimum effort. Please read the page at <a href='event:page:help:7'><b><BV>jobs</BV></b></a> to know more about them.
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Learning</J></b></font></p>
+    <font size='12'>Learning makes a person better, so do here.
+    <b><u>Why learning?</u></b>
+    When you learn, you'd get qualifications to do many jobs with many benefits. Also according to the level of your education, the amount of energy you spend on jobs decreases. So why not learning?
+    <b><u>How?</u></b>
+    You can learn by entering the school. Then enroll a course of your choice and start learning. Your learning progress is displayed on top of the school, so you can plan things accordingly
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Companies</J></b></font></p>
+    <font size='12'>Companies are the most important things in this game; and it's the fastest way to become rich! You can view information about a company using the <i><font color='#6A7495'>!company COMPANY_NAME</font></i> command.
+    There are 2 ways to own a company: By buying shares of an existing company or buying a new company for money.
+    To buy a company you need to spend $5000 in your hand. Click 'Company' button and follow the instructions. If you already own companies, click the 'Create a new company' button in companies menu. To buy shares of a company of a company, simply view the desired company and do 'Buy shares' if the company has issued shares). After that you'd get the ownership of that company and you can do anything.         <i><font color='#6A7495'>(to be  continued...)</font></i>
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Companies - Investing, Issuing and buying shares</J></b></font></p>
+    <font size='12'>Share is based on the ownership for a ceratain company. Sometimes you may need more money to grow your business. In such cases issuing shares is a good idea. Buy doing so you'll improve the capital and also share the ownership of your company. Click the 'Issue Shares' button in the company's menu and follow the instructions. 1 share worths $100 in this game.
+    When a certain company issue shares in the above manner, the public will be able to buy some shares to get more profit. You can buy shares buy following the instructions mentioned in the previous section.
+    You can also increase the capital without issuing any sharing. That's by investing into your own company. Click the invest button and follow the instructions to invest!
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Shop</J></b></font></p>
+    <font size='12'>
+    Shop includes healthpacks which can be used to increase your health. After buying things in shop, they will get stored in your inventory temporarily. So check your inventory and use the things you bought according to your choice!
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Jobs</J></b></font></p>
+    <font size='12'>You need a job to work. Each job has different salaries and energies. You can apply for a job by visiting the job menu (NOTE: You can only see jobs that you are qualified). To become qualified for a certain job, your level should be higher than the minimum level required for that job. You may also need to complete some degrees by learning, to apply for some jobs. Jobs with higher level and educational level usually have low energy consumption and higher salaries. Also if you have achieved a certain educational level, you will spend less energy when working. So keep in mind that learning is always good!
+    Jobs are offered by company owners, so doing a job means you are working for a particular company. When you work both you, company owners and company get profit...
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Creating Jobs</J></b></font></p>
+    <font size='12'>You need to become an owner to create a job. You can start creating a job by clicking the 'Create job' button in the company. You would see a dialogue asking some information about the job
+        • Job Name (required): The name of the job
+        • Salary (required): The salary. For a company, there's a maximum limit of salary that could be assigned to a job, which depends on the amount of invested capital. It will cost more energy if you created the job with a salary close to the minimum amount, and vice-versa.
+        • Energy (required): The amount of energy spend. Energy depends on the salary, minimum level of the job and the qualifications for it.  <i><font color='#6A7495'>(to be  continued...)</font></i>
+    </font>
+    ]],
+    [[
+    <p align='center'><font size='20'><b><J>Creating Jobs</J></b></font></p>
+    <font size='12'><i><font color='#6A7495'>(from the last page...)</font></i>
+        • Minimum level (required): The minimum level of a player to apply for this job. Increasing the level would decrease the energy
+        • Qualifications (optional): The educational qualifications required for this job. Increasing this would decrease the energy further!
+    Salary and the energy consumed is the factor that many workers are looking for. So be careful when choosing this!
+
+    <b><J>GOOD LUCK!</J></b>
+    </font>
+    ]]
+}
 
 local ab = {"A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z"}
 local latestLotto = {}
@@ -539,7 +610,7 @@ function displayProfile(name, target)
     local up = upper(name)
     local p = players[name] or players[up] or players[up .. "#0000"] or players[target]
     if p then
-        ui.addTextArea(900, closeButton .. 
+        ui.addTextArea(900, closeButton ..
         "<p align='center'><font size='15'><b><BV>" .. p:getName() .."</BV></b></font><br>« " .. p:getTitle() .. " »</p><br><b>Level:</b> " .. tostring(p:getLevel()) .. "<BL><font size='12'> [" .. tostring(p:getXP()) .. "XP / " .. tostring(calculateXP(p:getLevel() + 1)) .. "XP]</font></BL><br><b>Money:</b> $" .. formatNumber(p:getMoney()) .. "<br><br><b>Working as a</b> " .. p:getJob()
         , target, 300, 100, 200, 130, nil, nil, 1, true)
     end
@@ -805,6 +876,9 @@ function eventTextAreaCallback(id, name, evt)
     elseif evt == "tips" then
         displayTips(name)
     elseif evt == "cmds" then
+        ui.removeTextArea(953, name)
+        ui.removeTextArea(954, name)
+        ui.removeTextArea(955, name)
         displayHelp(name, "cmds")
     elseif evt == "game" then
         displayHelp(name, "game")
@@ -970,7 +1044,7 @@ function eventChatCommand(name, msg)
         if string.sub(msg, 7) == "" then
             displayTitleList(name)
         else
-            players[name]:setTitle(string.sub(msg, 7))    
+            players[name]:setTitle(string.sub(msg, 7))
         end
     end
 end