Skip to content

Commit

Permalink
add info for forum
Browse files Browse the repository at this point in the history
  • Loading branch information
Mara-Li committed Aug 15, 2024
1 parent 6f1d79a commit b7c8029
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The following columns are necessary for the import:

Theses columns are optional:
- `avatar` : The link to the character's avatar. If you don't use an avatar, you can leave this column empty. The avatar used in the display will be the player's.
- `channel` : Allows you to set a channel to send the sheet to, rather than using the default channels set when registering the template.
- `channel` : Allows you to set a channel (also supporting thread and forum[^1]) to send the sheet to, rather than using the default channels set when registering the template.
- `dice` : Specific dice for the `/dbd` command. If you don't use this command, you can leave this column empty (or delete it).


Expand All @@ -69,4 +69,6 @@ This command allows you to export the list of characters and statistics into a C
- If `true`, it will include **only** characters whose sheets are **private**.
- If omitted, it will include **all** characters, regardless of the sheet status.

The exported CSV file uses a semicolon as the separator.
The exported CSV file uses a semicolon as the separator.

[^1]: It is possible to use a forum, which will automatically create a post for the character. The player (and administrators) will be mentioned in the post.
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Statistics are based on a name, but you will notice that after generating the fi
Once the template is ready, use `/register [#channel] [file] (#user_chan) (#private_character)`.
- `#channel` is the channel where the template will be sent. It will then be used for sheet creation.
- `file` is the previously created `JSON` file.
- `#user_chan` is the channel where the sheets will be published.
- `#user_chan` is the channel where the sheets will be published.[^1]
- `#private_character` works similarly to `#user_chan`, but the sheets published in this channel will only be visible to the user who registered the sheet or to those who have access to this channel (as well as people with the `MANAGE ROLES` permission). If this channel is not defined, the private sheet function will be disabled.
The embed will be pinned for easy access.

Expand All @@ -100,4 +100,6 @@ If the sheet is not marked as private but is published in a channel that users d
:::warning About default channel
You need to re-register the template if you want to change the default channel for private and public sheet. But, saved user doesn't needs to be re-registered as the channel & messageID are saved in the database.
If you need to move all the sheets to another channel, you need to use the [`/export`](../config/import_export.md) command.
:::
:::

[^1]: It is possible to use a forum, which will automatically create a post for the character. The player (and administrators) will be mentioned in the post.
6 changes: 4 additions & 2 deletions en/docusaurus-plugin-content-docs/current/admin/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The first modal will always be the same regardless of the template:
- The user's name, which must be either their ID or their username. This data is mandatory and will be pre-filled by the bot with the username of the person who clicked.
- If you have enabled the use of private sheets (see [here](../admin/model/index.md#whats-next)), you will have a third field to choose whether the sheet should be private or not. If the sheet is private, simply put `x` in the field. Leave it empty otherwise!
- You can provide a link to an image (an avatar) that will serve as the image in the sheet's embed. If left blank, the image used will be the player's avatar.
- Finally, it is possible to send the character sheet to a channel other than those defined in the template by `private_channel` and `public_channel`. If you don't want to send the form to a specific channel, leave the field empty.
- Finally, it is possible to send the character sheet to a channel other than those defined in the template by `private_channel` and `public_channel`.[^1] If you don't want to send the form to a specific channel, leave the field empty.

:::warning
The form can only be hidden **if** the form is private. Even if the record is sent to a channel inaccessible to other users, they will be able to view it without this option.
Expand All @@ -36,4 +36,6 @@ Each die must be registered manually.

![fin](/assets/register/fin_embed.png)

Once all of this is done, simply click "Validate" and the sheet will be reposted in the channel chosen during registration (or in a thread named `📝 • [STATS]` if no channel was chosen during template registration).
Once all of this is done, simply click "Validate" and the sheet will be reposted in the channel chosen during registration (or in a thread named `📝 • [STATS]` if no channel was chosen during template registration).

[^1]: It is possible to use a forum, which will automatically create a post for the character. The player (and administrators) will be mentioned in the post.

0 comments on commit b7c8029

Please sign in to comment.