bitburner-src/src/Constants.js

CONSTANTS = {
	//Max level for any skill. Determined by max numerical value in javascript and the skill level
	//formula in Player.js
	MaxSkillLevel: 			975,
    
    //How much reputation is needed to join a megacorporation's faction
    CorpFactionRepRequirement: 250000,
	
    /* Script related things */
	//Time (ms) it takes to run one operation in Netscript.  
	CodeInstructionRunTime:	1500, 
	
	//Time (seconds) it takes to run one operation in Netscript OFFLINE
	CodeOfflineExecutionTime: 10,
    
    //Maximum number of log entries for a script
    MaxLogCapacity: 20,
    
    //Text that is displayed when the 'help' command is ran in Terminal
    HelpText:   "analyze                Get statistics and information about current machine <br>" + 
                "clear                  Clear all text on the terminal <br>" +
                "cls                    See 'clear' command <br>" +
                "connect [ip/hostname]  Connects to the machine given by its IP or hostname <br>" + 
                "free                   Check the machine's memory (RAM) usage<br>" + 
                "hack                   Hack the current machine<br>" +
                "help                   Display this list<br>" + 
                "hostname               Displays the hostname of the machine<br>" + 
                "ifconfig               Displays the IP address of the machine<br>" +
                "kill [script name]     Stops a script that is running<br>" +
                "ls                     Displays all programs and scripts on the machine<br>" + 
                "nano [script name]     Text editor - Open up and edit a script<br>" + 
                "netstat                Displays all available network connections<br>" +  
                "ps                     Display all scripts that are currently running<br>" + 
                "rm                     Delete a script/program from the machine. (WARNING: Permanent)<br>" + 
                "run [script/program]   Execute a program or a script<br>" + 
                "scan                   See 'netstat' command<br>" +
                "tail [script]          Display script logs (logs contain details about active scripts)" +
                "telnet [ip/hostname]   See 'connect' command<br>" +
                "top                    Display all running scripts and their RAM usage<br>",
                
    /* Tutorial related things */
	TutorialGettingStartedText: "Todo...",
    
    TutorialNetworkingText: "Servers are a central part of the game. You start with a single personal server (your home computer) " + 
                            "and you can purchase additional servers as you progress through the game. Connecting to other servers " + 
                            "and hacking them can be a major source of income and experience. Servers can also be used to run " + 
                            "scripts which can automatically hack servers for you. <br><br>" + 
                            "In order to navigate between machines, use the 'scan' or 'netstat' commands to see all servers " +
                            "that are reachable from your current server. Then, you can use the 'connect [hostname/ip]' or " + 
                            "'telnet [hostname/ip]' commands to connect to one of the available machines. <br><br>" + 
                            "The 'hostname' and 'ifconfig' commands can be used to display the hostname/IP of the " +
                            "server you are currently connected to.",
                            
    TutorialHackingText: "In the year 2077, currency has become digital and decentralized. People and corporations " + 
                         "store their money on servers. By hacking these servers, you can steal their money and gain " + 
                         "experience. <br><br>" + 
                         "Gaining root access <br>" + 
                         "The key to hacking a server is to gain root access to that server. This can be done using " + 
                         "the NUKE virus (NUKE.exe). You start the game with a copy of the NUKE virus on your home " + 
                         "computer. The NUKE virus attacks the target server's open ports using buffer overflow " + 
                         "exploits. When successful, you are granted root administrative access to the machine. <br>" + 
                         "Typically, in order for the NUKE virus to succeed, the target server needs to have at least " + 
                         "one of its ports opened. Some servers have no security and will not need any ports opened. Some " +
                         "will have very high security and will need many ports opened. In order to open ports on another " + 
                         "server, you will need to run programs that attack the server to open specific ports. These programs " +
                         "can be coded once your hacking skill gets high enough, or they can be purchased if you can find " + 
                         "a seller. <br><br>" +
                         "In order to determine how many ports need to be opened to successfully NUKE a server, connect to " + 
                         "that server and run the 'analyze' command. This will also show you which ports have already been " + 
                         "opened. <br>" +
                         "Once you have enough ports opened and have ran the NUKE virus to gain root access, the server " + 
                         "can then be hacked by simply calling the 'hack' command through terminal, or by using a script.<br><br>" + 
                         "Hacking mechanics <br>" + 
                         "When you execute the hack command, either manually through the terminal or automatically through " + 
                         "a script, you attempt to hack the server. This action takes time. The more advanced a server's " + 
                         "security is, the more time it will take. Your hacking skill level also affects the hacking time, " + 
                         "with a higher hacking skill leading to shorter hacking times. Also, running the hack command " + 
                         "manually through terminal is faster than hacking from a script. <br>" + 
                         "Your attempt to hack a server will not always succeed. The chance you have to successfully hack a " + 
                         "server is also determined by the server's security and your hacking skill level. Even if your " + 
                         "hacking attempt is unsuccessful, you will still gain experience points. <br>" + 
                         "When you successfully hack a server. You steal a certain percentage of that server's total money. This " + 
                         "percentage is determined by the server's security and your hacking skill level. The amount of money " + 
                         "on a server is not limitless. So, if you constantly hack a server and deplete its money, then you will " +
                         "encounter diminishing returns in your hacking (since you are only hacking a certain percentage). A server " + 
                         "will regain money at a slow rate over time. ",
                         
    TutorialScriptsText: "Scripts can be used to automate the hacking process. Scripts must be written in the Netscript language " + 
                         "and are saved as a file. Running a script requires RAM. The more complex a script is, the more RAM " + 
                         "it requires to run. Scripts can be run on any server you have root access to. <br><br>" + 
                         "Here are some commands that are useful when working with scripts: <br>" + 
                         "free - Shows the current server's RAM usage <br>" + 
                         "kill [script] - Stops a script that is running <br>" + 
                         "nano [script] - Edit a script <br>" + 
                         "ps - Displays all scripts that are actively running on the current server<br>" + 
                         "run [script] - Run a script <br>" + 
                         "tail [script] - Displays a script's logs<br>" + 
                         "top - Displays all active scripts and their RAM usage <br><br>",
    TutorialTravelingText:"There are six major cities in the world that you are able to travel to: <br> "  +
                           "    Aevum<br>" + 
                           "    Chongqing<br>" + 
                           "    Sector-12<br>" + 
                           "    New Tokyo<br>" + 
                           "    Ishima<br>" + 
                           "    Volhaven<br>" + 
                           "To travel between cities, visit your current city's travel agency through the 'World' page. " + 
                           "From the travel agency you can travel to any other city. Doing so costs money. <br>" + 
                           "Each city has its own set of companies and unique locations. ",
    TutorialJobsText: "Hacking is not the only way to gain money and experience! Located around the world are many " + 
                      "different companies which you can work for. By working for a company you can earn money, " + 
                      "train your various labor skills, and unlock powerful passive perks. <br> " +
                      "To apply for a job, visit the company you want to work for through the 'World' menu. The company " + 
                      "page will have options that let you apply to positions in the company. There might be several different" + 
                      "positions you can apply for, ranging from software engineer to business analyst to security officer. <br> " + 
                      "When you apply for a job, you will get the offer if your stats are high enough. Your first position at " + 
                      "a company will be an entry-level position such as 'intern'. Once you get the job, an button will appear on " + 
                      "the company page that allows you to work for the company. Click this button to start working. <br>" + 
                      "Working occurs in 8 hour shifts. Once you start working, you will begin earning money, experience, " + 
                      "and reputation. The rate at which you money and experience depends on the company and your position. " + 
                      "The amount of reputation you gain for your company is based on your job performance, which is affected by " +
                      "your stats. Different positions value different stats. When you are working, you are unable to perform any " +
                      "other actions such as using your terminal or visiting other locations (However, note that any scripts you have " + 
                      "running on servers will continue to run as you work!). It is possible to cancel your work shift before the " + 
                      "8 hours is up, but doing so will result in you gaining only half of all of the money, experience, and reputation " +
                      "that you had earned up to that point. <br>" +
                      "As you continue to work at a company, you will gain more and more reputation at that company. When your stats " + 
                      "and reputation are high enough, you can get a promotion. You can apply for a promotion on the company page, just like " + 
                      "you applied for the job originally. Higher positions at a company provide better salaries and stat gains",
    TutorialFactionsText: "Throughout the game you may receive invitations from factions. There are many different factions, and each faction " +
                          "has different criteria for determining its potential members. Joining a faction and furthering its cause is crucial " + 
                          "to progressing in the game and unlocking endgame content. <br> " + 
                          "It is possible to join multiple factions if you receive invitations from them. However, note that joining a faction " +
                          "may prevent you from joining other rival factions. <br> " + 
                          "The 'Factions' link on the menu brings up a list of all factions that you have joined. " + 
                          "You can select a Faction on this list to go to that Faction page. This page displays general " + 
                          "information about the Faction and also lets you perform work for the faction. " + 
                          "Working for a Faction is similar to working for a company except that you don't get paid a salary. " + 
                          "You will only earn reputation in your Faction and train your stats. Also, cancelling work early " + 
                          "when working for a Faction does not result in reduced experience/reputation earnings. <br>" + 
                          "Earning reputation for a Faction unlocks powerful upgrades. These upgrades vary from faction to faction. ",
    TutorialAugmentationsText: "Advances in science and medicine have lead to powerful new technologies that allow people to augment themselves " + 
                               "beyond normal human capabilities. There are many different types of Augmentations, ranging from cybernetic to " + 
                               "genetic to biological. Acquiring these Augmentations enhances the user's physical and mental faculties. <br>" + 
                               "Because of how powerful these Augmentations are, the technology behind them is kept private and secret by the " + 
                               "corporations and organizations that create them. Therefore, the only way for the player to obtain Augmentations is " + 
                               "through Factions. After joining a Faction and earning enough reputation in it, you will be able to purchase " + 
                               "its Augmentations. Different Factions offer different Augmentations. Augmentations must be purchased in order to be installed, " + 
                               "and they are fairly expensive. <br>" +
                               "Unfortunately, installing an Augmentation has side effects. All of your stats and experience will be reset to 1. " +
                               "You will lose all of your digital assets as well, such as your money, programs, scripts, and purchased servers. " + 
                               "You will lose all of the reputation you have earned from every company and faction and will no longer be an employee " + 
                               "or member of any. The only thing you will keep when you install an Augmentation is all of the past Augmentations " + 
                               "you have installed. ",	
	
}