diff --git a/changelog.md b/changelog.md index c650942..56e8577 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,7 @@ #The Modding Tree changelog: ##v2.0 +Added Progress bars, which are highly customizable and can be horizontal or vertical. Added clickables, a more generalized variant of buyables! Support for multiple completions of challenges. Added getter/setter functions for buyable amount and such @@ -93,4 +94,19 @@ parameters. - Lots of minor good things. #v1.0: -- First release. \ No newline at end of file +- First release. + + +Make it clear that anything can be a function + +buyables.md: cost is a Decimal + +Define "CSS Object" clearly in the first instance in each file + +Explain automagical assignments better + + + +Change all "chall", "unl", "desc", "res_ceil", "incr_order", + +Challenges: "chall", "desc", reward -> rewardDescription, effect -> reward, effectDisplay -> rewardDisplay, \ No newline at end of file diff --git a/docs/basic-layer-breakdown.md b/docs/basic-layer-breakdown.md index 8846a90..0e330d1 100644 --- a/docs/basic-layer-breakdown.md +++ b/docs/basic-layer-breakdown.md @@ -18,7 +18,7 @@ This is a very minimal layer with minimal features. Most things will require add baseResource: "points", // The name of the resource your prestige gain is based on baseAmount() {return player.points}, // A function to return the current value of that resource - requires: new Decimal(200)}, // The amount of the base needed to gain 1 of the prestige currency. + requires: new Decimal(200), // The amount of the base needed to gain 1 of the prestige currency. // Also the amount required to unlock the layer. type: "normal", // Determines the formula used for calculating prestige currency. diff --git a/docs/challenges.md b/docs/challenges.md index ad715a6..b92a2b1 100644 --- a/docs/challenges.md +++ b/docs/challenges.md @@ -39,7 +39,7 @@ Individual Challenges can have these features: - effectDisplay(): **optional**, A function that returns a display of the current effects of the reward with formatting. Default behavior is to just display the a number appropriately formatted. -- goal: A Decimal for the cost of the upgrade. By default, the goal is in basic Points. +- goal: A Decimal for the amount of currency required to beat the challenge. By default, the goal is in basic Points. The goal can also be a function if its value changes. - unl(): A function returning a bool to determine if the challenge is visible or not. diff --git a/docs/getting-started.md b/docs/getting-started.md index 93eeacb..464e353 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -43,10 +43,11 @@ The benefits of using Github: 2. To edit your project, click "open in VSCode" in Github Desktop. -3. Open index.html, and look at the top part where it says "modInfo". On the lines below that, change - the mod's name to whatever you want, and change the id as well. (The id is important, it determines where the game looks for your saves. It should be different from other mods, and shouldn't be changed once set.) +3. Open game.js in VSCode, and look at the top part where it says "modInfo". On the lines below that, change + the mod's name to whatever you want, and change the id as well. (It can be any string value, and it's used to determine + where the savefile is. Make it something that's probably unique, and don't change it again later.) -4. Reload index.html. The title on the tab, as well as on the info page, will now be the new ones! +4. Save game.js, and then reload index.html. The title on the tab, as well as on the info page, will now be the new ones! 5. Go back to Github Desktop. It's time to save your changes into the git system by making a "commit".