Create new wiki folder which will be mirrored to repo wiki via github…

… action (foundryvtt#2330)

.github/workflows/publish-wiki.yml

@@ -0,0 +1,18 @@
+name: Publish wiki
+on:
+  push:
+    branches: [master]
+    paths:
+      - wiki/**
+      - .github/workflows/publish-wiki.yml
+concurrency:
+  group: publish-wiki
+  cancel-in-progress: true
+permissions:
+  contents: write
+jobs:
+  publish-wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: Andrew-Chen-Wang/github-wiki-action@v4

README.md

@@ -26,6 +26,9 @@ If you wish to manually install the system, you must clone or extract it into th
 may do this by cloning the repository or downloading a zip archive from the
 [Releases Page](https://github.com/foundryvtt/dnd5e/releases).
 
+## Frequently Asked Questions  
+Check the [Wiki](../../wiki) for answers to our most [frequently asked questions](../../wiki/faq)
+
 ## Community Contribution
 
 See the [CONTRIBUTING](/CONTRIBUTING.md) file for information about how you can help this project.

wiki/Advancement-Type:-Hit-Points.md

@@ -0,0 +1,46 @@
+![Up to date as of 2.0.3](https://img.shields.io/static/v1?label=dnd5e&message=1.6.3&color=informational)
+
+The Hit Points advancement type keeps track of hit point choices for each level of a class. This advancement can only be added to classes and each class can only have a single advancement of this type.
+
+## Configuration
+
+![Hit Point Configuration](https://github.com/foundryvtt/dnd5e/assets/86370342/f7f21d1c-7160-4139-8f79-5a9f403fba59)
+
+The Hit Points advancement requires no configuration. It will take a custom title and icon like all other advancement types, but everything else is handled automatically including fetching the hit dice type from the class to which it was added.
+
+## Usage
+
+![Hit Points - Usage, Initial Level](https://github.com/foundryvtt/dnd5e/assets/86370342/1b5b6218-2fe0-4468-845c-4b75f3286417)
+
+Using the Hit Points advancement is almost as simple as setting it up. At the character's first level there are no options to choose because all level one characters get the maximum hit points allowed by their hit dice. The character's constitution modifier will automatically be added with the hit points, so be sure it is set before adding the first class.
+
+![Hit Points - Usage, Higher Level](https://github.com/foundryvtt/dnd5e/assets/86370342/7e520414-c503-459f-b2c5-510802768c94)
+
+At higher levels you are given an option between taking the average hit points (half the max + 1) or rolling for hit points. If the "Take Average" option is selected, it will be remembered at future levels but can be changed at any point.
+
+## API
+
+The original proposal for the Hit Points advancement can be [found here](https://github.com/foundryvtt/dnd5e/issues/1402).
+
+### Configuration Schema
+
+None
+
+### Value Schema
+
+The Hit Points advancement stores decisions as an object with an entry for each class level. For the initial character level it will store `max` indicating the maximum hit points were awarded automatically. For other levels it stores either `avg` indicating that the average was taken or a number indicating what was rolled.
+
+```javascript
+{
+  1: "max",
+  2: 5,
+  3: "avg",
+  4: 2
+}
+```
+
+*Note:* The advancement does not keep track of the constitution modifier added at any given level.
+
+### Methods
+
+- `HitPointsAdvancement#total`: Total hit points provided by this advancement across all awarded levels.

wiki/Advancement-User-Guide.md

@@ -0,0 +1,126 @@
+# Class Items
+
+1.6 has added the ability to easily define what items should be granted to an actor when it is levelled up in a given class or subclass. This initial release covers a majority of users' needs for streamlining the level up process, however it does not cover all use cases currently, and improvements will be made with subsequent releases. This guide will assist you in creating your own custom classes, as well as provide tips and tricks for navigating the current state of the implementation.
+
+There is a new option in the System Settings to disable this feature for all players in a world by using the "Disable level-up automation" option in the 5e system settings. To avoid running advancements on an individual character, any advancements should be removed from the class, subclass, or background before it is dropped on the character sheet.
+
+Note that once the Advancement process has been started, any manual changes to the actor or items added to the actor manually will be reverted once the Advancement workflow is completed.
+
+# Class Item Updates
+The following section will discuss changes made to the Class item type.
+## The Details tab
+- **Identifier field**: this will allow you to configure the name of the class that can be used to reference it in roll formulas (useful for classes with spaces, or localizing the class to other languages). The class identifier may only contain letters, numbers, hyphens (`-`), and underscores (`_`).
+- **Level field**: has been removed, class levels will be managed from the actor sheet, see the second screenshot below.
+
+![Class Details](https://github.com/foundryvtt/dnd5e/assets/86370342/1dfac30f-cdcb-4d3e-a71a-694f119b0dc7)
+
+![Class Level Dropdown](https://github.com/foundryvtt/dnd5e/assets/86370342/57d98381-8eaf-40e1-914c-402926bd54f6)
+
+## The Advancement tab
+This is where you will configure the Advancement items for this class. 
+- Add a new Advancement item with the + button, edit an existing item with the [pen] icon, or delete an existing advancement item with the [trash] icon. 
+    - (Note: deleting one Hit Point or Scale Value advancement item will delete all of that type for the class).
+- **Configuration Disabled/Enabled** - This will only display when the class is placed on an actor, it can be toggled to enable or disable making modifications to the advancement items.
+- **Modify Choices** - This will only display when the class is placed on an actor, and if Configuration is disabled, this allows a user to change any choices they made for that level.
+- Advancement items are sorted within each level alphabetically by type in the following order: Hit Points, Item Grant, Scale Value.
+
+![Advancement Example](https://github.com/foundryvtt/dnd5e/assets/86370342/4b2dbd4d-01fa-4015-9253-54fc3a682776)
+
+# Advancement Item Types
+There are currently 3 types of Advancement Items that can be added to a Class item: Hit Points, Item Grant, and Scale Value.
+All Advancement Items have the following fields:
+* **Custom Title**: Choose what you would like the title of this advancement item to display on the Advancement tab.
+* **Custom Icon**: Choose an icon to represent this item on the Advancement tab.
+* **Class Restriction**: 
+    * All Classes - These items should be granted in any case.
+    * Original Class Only - Only if this class is the initial class.
+    * Multiclass Only - Only if this class is chosen as a multiclass.
+
+![Basic Advancement Configuration](https://github.com/foundryvtt/dnd5e/assets/86370342/e89f215e-8048-4aa1-a051-1632fbcd970f)
+
+## Hit Points
+This advancement item will prompt for the user to Roll for HP or use the average, using the Hit Die noted in the Details tab of the Class item.
+
+![Hit Points Advancement Configuration](https://github.com/foundryvtt/dnd5e/assets/86370342/36435978-2bb9-4098-b992-c2dcecc1535e)
+
+## Item Grant
+This advancement can grant another item on level up (e.g. Class Features, Equipment). It should not be used for Class Spellcasting as a separate Advancement type is planned for that. It can be used for Racial Spellcasting, however.
+
+This Advancement Type also contains the following options:
+* **Level**: Select the level that these features should be granted at.
+* **Optional**: If you want to give the user the option to decline any items granted by this Advancement, check this box, otherwise all items will be granted automatically.
+* **Items**: Drag and drop an item into this section for that item to be granted when an actor has reached the appropriate level in this class.
+
+![Item Grant Advancement Configuration](https://github.com/foundryvtt/dnd5e/assets/86370342/0121c15c-6a3d-4f16-957f-3c9b81b9674d)
+
+## Scale Value
+This can be used to track when features get extra uses (e.g. Wild Shape or Channel Divinity), or the die value of a feature increases (e.g. Sneak Attack or Martial Arts)
+This Advancement Type also contains the following options:
+* **Scale Type**: This determines the values accepted on the Level sections on the right hand side
+* Anything - Allows an arbitrary input including text and numbers
+
+![Scale Value: Anything](https://github.com/foundryvtt/dnd5e/assets/86370342/3d20ec17-a88d-4398-b60a-bc7dda5a9fc0)
+
+* Dice - Allows a configuration of number of die and die size (options include d2, d3, d4, d6, d8, d10, d12, and d20). It is recommended for features that can use a variable number of these dice to leave the count blank, and define the number used in the feature, (e.g. `[email protected]`, `[email protected]`) this will ensure accurate values if used in the damage field and critical damage is rolled. Values that are a consistent number of die can have the value column populated (e.g. Sneak Attack)
+
+![Scale Value: Dice](https://github.com/foundryvtt/dnd5e/assets/86370342/80e49db5-8128-4edc-b2a9-3277ad7d8144)
+
+* Numeric - Allows a configuration of a number value in the level options
+
+![Scale Value: Numeric](https://github.com/foundryvtt/dnd5e/assets/86370342/f687de1a-c92e-4834-ac00-3170451b7129)
+
+* Distance - Allows for numerical values in the level options, you can choose the units of Feet, Miles, Meters, and Kilometers
+
+![Scale Value: Distance](https://github.com/foundryvtt/dnd5e/assets/86370342/496109c8-caa7-4185-97f4-bb84ab3a12eb)
+
+* **Identifier**: Defines the identifier to be used in a formula.
+* **1-20**: Used to define the scale value at a given level
+
+# Managing Class Levels on an Actor
+## Adding a Class to an Actor
+
+https://github.com/foundryvtt/dnd5e/assets/86370342/7c6004a3-d13d-4c5b-8385-160538115345
+
+
+1. Drag a Class item onto your Actor's Features tab. 
+    - Note: You can cancel the advancement process at any time by clicking the dialog's `X Close` button.
+2. You will be prompted to first accept the Hit Points advancement (HP for your original class at level one is always the maximum hit die value plus your Constitution modifier). Click the Next button to advance to the next advancement item.
+3. You will then be prompted for any additional advancement items, clicking on the name of the feature will allow you to preview the item that will be added to the actor, if an advancement item is set to optional, the user will be able to select the check box to determine if that item should be added or not. Once the user is ready to advance, click Continue.
+4. On any subsequent step you will have a Restart button, this will return you to the beginning of the Advancement process.
+5. On the final advancement item you will have a Complete button, click it to apply the changes to your actor. The HP values will adjust, and the items will be added to your character at this time.
+
+## Leveling Up
+
+https://github.com/foundryvtt/dnd5e/assets/86370342/ca2669ac-acbb-4b60-a33f-b425a2ca099f
+
+1. On your Actor's Features tab, find the Level option for your class, click it to open the drop down and select the level you would like to advance to.
+2. The appropriate advancement items will be presented to you, use the steps as described above to move through the process.
+
+## Modifying a previous advancement choice
+
+https://github.com/foundryvtt/dnd5e/assets/86370342/5e2cae50-1012-4f8e-b2b4-1b25e02798ff
+
+1. If you made a mistake on a previous level up, such as selecting the wrong item or accidentally deselecting an item, navigate to the Features tab of your actor, and click the Edit icon for their Class item.
+2. In the Advancements tab, make sure the Configuration is disabled, then find the level to modify and click the Modify Choices button
+3. The system will walk you through all of the advancement items for that level to adjust any choices made for that level.
+
+## Leveling Down or Removing a Class
+
+https://github.com/foundryvtt/dnd5e/assets/86370342/ef5a3522-ffcf-4628-ae23-6b3ce0ea4de0
+
+1. On your Actor's Features tab, find the Level option for your class, click it and select the level you would like to revert to from the drop down, or click the Trash can icon to completely remove the class or subclass.
+2. The system will display a dialog to confirm the change and provide a toggle to remove any advancement items that have been earned up to this level, leaving the box checked will ensure items granted from previous level ups will be removed from the actor. 
+
+# Managing Subclasses 
+Presently the Subclass advancement type is not available in this release, and will be introduced in a later release. This advancement type will allow the triggering of the advancement workflow if an added item has advancement items attached to it.
+
+The current recommended process is to manually drag and drop the subclass onto the actor after completing the Advancement process for the given level, which will prompt for the appropriate advancements for the character's level in the parent class. 
+
+https://github.com/foundryvtt/dnd5e/assets/86370342/dc961225-38f6-4272-9595-17a79425d1ca
+
+# Updating Advancements for an owned Class item
+If you are building your own custom class, or modifying an existing class record, once a class is added to an actor it is owned by that actor and is separate from the parent class item in the items sidebar or compendium. For example, if you built a class item with advancements to level 5 and added it to an actor, then later updated the class in the compendium to add advancements to level 10, dragging and dropping that class item onto the actor will not provide the new advancement items to the owned class item.
+
+You will need to manually update the owned class item with the new advancement items, separate from the compendium class item.
+
+In an upcoming release, a process to update advancement items from the 'master copy' class item to an owned class item will be added to the system.

wiki/Advancement.md

@@ -0,0 +1,100 @@
+![Up to date as of 1.6.3](https://img.shields.io/static/v1?label=dnd5e&message=1.6.3&color=informational)
+
+## Advancement System
+
+The advancement system is a new system in 5e that allows classes, subclasses, and backgrounds to make modifications to the character when they are added and when a character levels up.
+
+This page provides an overview of the system and its API. For more specific guides, please visit one of the following pages:
+
+- [Advancement User Guide](Advancement-User-Guide)
+- [Custom Class Example](Custom-Class-Example)
+
+#### Disabling Advancements
+
+The advancement system can be disabled for all players in a world by using the `"Disable level-up automation"` option in the 5e system settings. To avoid running advancements on an individual character, any advancements should be removed from the class, subclass, or background before it is dropped on the character sheet.
+
+
+## Advancement Types
+### Grant Items
+The [[grant items advancement|Advancement-Type:-Grant-Items]] defines a list of features, spells, or other items that are added to the actor at a certain level.
+
+### Hit Points *(class only)*
+The [[hit points advancement|Advancement-Type:-Hit-Points]] keeps track of hit point values for each level of a class. The player will have an option for rolling their hit points or taking the average value.
+
+### Scale Value *(class or subclass only)*
+[[Scale values|Advancement-Type:-Scale-Value]] are formula values that change arbitrarily depending on the level of the class or subclass to which they belong. These values are then made available to be used in roll formulas or elsewhere in the system. A few examples of this include a Bard's inspiration die size, a Rogue's sneak attack value, or a Cleric's channel divinity uses.
+
+### Proposed Types
+These advancement types are still under development, links point to the proposal pages for each type:
+- [Ability Score Improvement](https://github.com/foundryvtt/dnd5e/issues/1403)
+- [Choose Items](https://github.com/foundryvtt/dnd5e/issues/1401)
+- [Equipment](https://github.com/foundryvtt/dnd5e/issues/1871)
+- [Subclass](https://github.com/foundryvtt/dnd5e/issues/1407)
+- [Trait](https://github.com/foundryvtt/dnd5e/issues/1405)
+
+
+## Advancement Hooks
+
+Details of the hooks that the advancement system provides can be found on [the hooks page](Hooks#advancement).
+
+
+## Custom Advancement Types
+
+For module authors who want to expand beyond the advancement types offered in the system, it is a simple task to create and register custom advancement types.
+
+**Note**: The advancement API is brand new and some changes may be made in upcoming releases of 5e. Be aware that changes to the API in 1.7 may break any custom advancements in future versions.
+
+### Authoring
+
+#### `Advancement` Class
+
+All custom types should subclass the abstract `Advancement` type. This class contains all of the base configuration of the advancement, details on its data structure, and methods for displaying it within the advancement list on items and performing changes to the actor when the advancement is applied.
+
+##### Ordering
+
+The `order` value in the `Advancement#metadata` object determines in which order this advancement type appears. Here are the values for built-in types:
+
+* `10` - Hit Points
+* `20` - Ability Score Improvement *(in progress)*
+* `30` - Traits *(in progress)*
+* `40` - Grant Items
+* `50` - Item Choice *(in progress)*
+* `60` - Scale Value
+* `70` - Subclass *(in progress)*
+* `100` - (base advancement class)
+
+You can set your ordering value between any of these numbers to position your advancement in the list.
+
+#### `AdvancementConfig` Class
+
+A subclass of `AdvancementConfig` is needed when a custom advancement type needs to present custom configuration options to the user. If no custom config application is provided, the default config window will be shown to allow for customization of the advancement's base settings.
+
+Any custom config templates should contain the base advancement controls partial so those controls are always available:
+
+```html
+{{> "systems/dnd5e/templates/advancement/parts/advancement-controls.html"}}
+```
+
+#### `AdvancementFlow` Class
+
+The controls presented within the advancement process are defined within a subclass of `AdvancementFlow`. This will always be rendered as a sub-application of the surrounding `AdvancementManager`.
+
+#### Namespacing
+
+Custom advancements introduced by modules should be uniquely namespaced for that module to ensure that future advancement types introduced by the system or other modules do not conflict.
+
+### Registering
+
+The only step required to register a custom advancement type with 5e is to add the new `Advancement` class to the `game.dnd5e.advancement.types` object.
+
+```javascript
+Hooks.once("init", () => {
+  game.dnd5e.advancement.types.MyModuleCustomAdvancement = MyModuleCustomAdvancement;
+});
+```
+
+Advancements are looked up by their type. For example, an advancement of type 'MyModuleCustom' will be loaded by the `MyModuleCustomAdvancement` class, if it can be found.
+
+Advancement registration should be done during a module's `"init"` or `"setup"` hooks to ensure that the custom type is available during item preparation.
+
+If at any point a module that introduces a custom advancement is disabled, the system will simply skip preparing that advancement while retaining the underlying data in case the advancement is ever re-added.