Skip to content

Commit be6a085

Browse files
authored
docs: symbols of files (#18)
* feat: config symbols * chore: remove temp * feat: config symbols * feat: updates symbols * feat: player spire symbols * wip: updates symbols * featL updates symbols * feat: group references by files
1 parent 810ee70 commit be6a085

File tree

7 files changed

+1566
-334
lines changed

7 files changed

+1566
-334
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@ gabengar.github.io/trimps-x
44

55
## Development
66

7-
First, run the development server:
7+
1. Run the development server:
88

99
```sh
1010
npm run dev
1111
```
1212

13-
Open [http://localhost:5173/trimps-x/](http://localhost:5173/trimps-x/) with your browser to see the result.
13+
2. Open [http://localhost:5173/trimps-x/](http://localhost:5173/trimps-x/) with your browser to see the result.
14+
15+
16+
## Symbol mappings
17+
18+
`()` after the name means it's a function/class.

public/config.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# `config.js`
2+
3+
## Declared Symbols
4+
- `newGame()`
5+
- `game`
6+
7+
## Referenced Symbols
8+
### unknown
9+
- `nw`
10+
11+
### `main.js`
12+
- `getCurrentMapObject()`
13+
- `getEmpowerment()`
14+
- `getUberEmpowerment()`
15+
- `Fluffy`
16+
- `heliumOrRadon()`
17+
- `createVoidMap()`
18+
- `needAnS()`
19+
- `formatMinutesForDescriptions()`
20+
- `simpleSeconds()`
21+
- `scaleLootBonuses()`
22+
- `getPerkLevel()`
23+
- `calcHeirloomBonus()`
24+
- `calculatePercentageBuildingCost()`
25+
- `usingScreenReader`
26+
- `save()`
27+
- `isNumberBad()`
28+
- `updateTalentNumbers()`
29+
- `handlePauseMessage()`
30+
- `addMapModifier()`
31+
- `log10()`
32+
- `getHighestLevelCleared()`
33+
- `setGather()`
34+
- `getLastPortal()`
35+
- `mutations`
36+
- `countChallengeSquaredReward()`
37+
- `updateAntiStacks()`
38+
- `getGameTime()`
39+
- `getPerkLevel()`
40+
- `manageStacks()`
41+
- `getRandomIntSeeded()`
42+
- `isSaving`
43+
- `getDailyChallenge()`
44+
- `portalUniverse`
45+
- `startDaily()`
46+
- `abandonDaily()`
47+
- `getDailyHeliumValue()`
48+
- `countDailyWeight()`
49+
- `getTotalPerkResource()`
50+
- `unlockPerk()`
51+
- `updateBalanceStacks()`
52+
- `addHelium()`
53+
- `getScientistLevel()`
54+
- `getScientistInfo()`
55+
- `toggleAutoPrestiges()`
56+
- `toggleAutoUpgrades()`
57+
- `updateElectricityStacks()`
58+
- `updateLivingStacks()`
59+
- `updateMapCredits()`
60+
- `startTheMagma()`
61+
- `portalWindowOpen`
62+
63+
### `updates.js`
64+
- `prettify()`
65+
- `refreshMaps()`
66+
- `swapClass()`
67+
- `message()`
68+
- `lastTooltipTitle`
69+
- `displayEfficientEquipment()`
70+
- `drawAllUpgrades()`
71+
- `drawAllEquipment()`
72+
- `updateMazPreset()`
73+
- `cancelTooltip()`
74+
- `tooltip()`
75+
- `verticalCenterTooltip()`
76+
- `readNiceCheckbox()`
77+
- `toggleSetting()`
78+
- `autoBattle`
79+
- `screenReaderAssert()`
80+
- `tooltipUpdateFunction`
81+
- `romanNumeral()`
82+
- `getZoneMinutes()`
83+
- `formatMultAsPercent()`
84+
- `giveSingleAchieve()`
85+
- `unlockUpgrade()`
86+
- `addNewSetting()`
87+
- `updateDecayStacks()`
88+
- `unlockEquipment()`
89+
90+
### `objects.js`
91+
- `u2Mutations`
92+
- `holidayObj`
93+
- `alchObj`
94+
95+
### `playerSpire.js`
96+
- `playerSpire`

0 commit comments

Comments
 (0)