DOCUMENTATION: Better npm run doc, plus minor folder reorganization (#693)

2026-04-23 17:53:00 +02:00 · 2023-08-01 00:59:33 -04:00
parent e624db5238
commit 83b7c380ff
44 changed files with 40 additions and 30 deletions
@@ -0,0 +1,113 @@
+# Stats
+
+The player has several stats that can be increased in order to progress in the game.
+
+## Hacking
+
+Represents the player's ability to code and hack.
+
+Affects:
+
+- Time it takes to hack a server
+- Time it takes to execute the `grow()` and `weaken()` function
+- Chance to successfully hack a server
+- Percent of money stolen when hacking a server
+- Success rate of certain [crimes](crimes.md)
+- Time it takes to create a program
+- [Faction](factions.md) [Reputation](reputation.md) gain when carrying out Hacking Contracts or Field Work
+- [Company](companies.md) [Reputation](reputation.md) gain for certain jobs
+
+Gain experience by:
+
+- Manually hacking servers through [Terminal](terminal.md)
+- Executing `hack()`, `grow()`, or `weaken()` through a script
+- Committing certain [crimes](crimes.md)
+- Carrying out Hacking Contracts or doing Field work for [Factions](factions.md)
+- Working certain jobs at a [Company](companies.md)
+- Studying at a university
+
+## Strength
+
+Represents the player's physical offensive power
+
+Affects:
+
+- Success rate of certain [crimes](crimes.md)
+- [Faction](factions.md) [Reputation](reputation.md) gain for Security and Field Work
+- [Company](companies.md) [Reputation](reputation.md) gain for certain jobs
+
+Gain experience by:
+
+- Committing certain [crimes](crimes.md)
+- Working out at a gym
+- Doing Security/Field Work for a [Faction](factions.md)
+- Working certain jobs at a [Company](companies.md)
+
+## Defense
+
+Represents the player's ability to withstand damage
+
+Affects:
+
+- Success rate of certain [crimes](crimes.md)
+- The player's HP
+- [Faction](factions.md) [Reputation](reputation.md) gain for Security and Field Work
+- [Company](companies.md) [Reputation](reputation.md) gain for certain jobs
+
+Gain experience by:
+
+- Committing certain [crimes](crimes.md)
+- Working out at a gym
+- Doing Security/Field Work for a [Faction](factions.md)
+- Working certain jobs at a [Company](companies.md)
+
+## Dexterity
+
+Represents the player's skill and adeptness in performing certain tasks
+
+Affects:
+
+- Success rate of certain [crimes](crimes.md)
+- [Faction](factions.md) [Reputation](reputation.md) gain for Security and Field Work
+- [Company](companies.md) [Reputation](reputation.md) gain for certain jobs
+
+Gain experience by:
+
+- Committing certain [crimes](crimes.md)
+- Working out at a gym
+- Doing Security/Field Work for a [Faction](factions.md)
+- Working certain jobs at a [Company](companies.md)
+
+## Agility
+
+Represents the player's speed and ability to move
+
+Affects:
+
+- Success rate of certain [crimes](crimes.md)
+- [Faction](factions.md) [Reputation](reputation.md) gain for Security and Field Work
+- [Company](companies.md) [Reputation](reputation.md) gain for certain jobs
+
+Gain experience by:
+
+- Committing certain [crimes](crimes.md)
+- Working out at a gym
+- Doing Security/Field Work for a [Faction](factions.md)
+- Working certain jobs at a [Company](companies.md)
+
+## Charisma
+
+Represents the player's social abilities
+
+Affects:
+
+- Success rate of certain [crimes](crimes.md)
+- [Faction](factions.md) [Reputation](reputation.md) gain for Field Work
+- [Company](companies.md) [Reputation](reputation.md) gain for most jobs
+
+Gain experience by:
+
+- Committing certain [crimes](crimes.md)
+- Studying at a university
+- Working a relevant job at a [Company](companies.md)
+- Doing Field work for a [Faction](factions.md)