diff --git a/README.md b/README.md index 7ce2584..d7693ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Prestige-Tree +# The-Modding-Tree How to add layers: You can either add a layer directly into the layers object in layers.js, or declare it separately and then do "addLayer(layername, layerdata)" (good for breaking things up into smaller files) @@ -98,7 +98,7 @@ cost: A Decimal for the cost of the upgrade. currencyDisplayName: Optional, if using a currency other than the main one for this layer, the name to display for that currency currencyInternalName: The internal name for that currency -currencyLayer: The internal name of the layer for that currency. If it's not in a layer, omit. +currencyLayer: The internal name of the layer for that currency. If it's not in a layer (like Points), omit. unl() - Return a bool to determine if the upgrade is unlocked or not. @@ -127,3 +127,37 @@ toggles: Creates toggle buttons on the milestone when it is unlocked. An array o -----Challenges----- +Challenges are stored in the following format: + +challs: { + rows: # of rows + cols: # of columns + 11: { + [insert challenge info here] + } + etc +} + +Each challenge should have an id where the first digit is the row and the second digit is the column. Individual upgrades can have these features: + +name: Name of the challenge + +desc: A description of what makes the challenge a challenge + +reward: A description of the reward's effect + +effect() - Optional, calculate and return the values of this upgrade's effects or effects. + +effectDisp(x) - Optional, returns a display of the current effects of the upgrade with formatting. Default behavior is to just display the number appropriately formatted. + +goal: A Decimal for the goal of the challenge's value. + +currencyDisplayName: Optional, if using a goal currency other than basic Points, the name to display for that currency +currencyInternalName: The internal name for that currency +currencyLayer: The internal name of the layer for that currency. If it's not in a layer, omit. + +unl() - Return a bool to determine if the challenge is unlocked or not. + +onComplete() - Optional, this function will be called when the challenge is newly completed. + +countsAs: An array of ids of other challenges in this layer that being in this challenge "counts as" being in.