Add help pages to detail how artigen is different from roll20
This commit is contained in:
parent
d989e9d473
commit
bddf7c6fdb
|
@ -4,6 +4,7 @@ import { HelpPage } from 'commands/helpLibrary/helpLibrary.d.ts';
|
||||||
import { DecoratorsHelpPages } from 'commands/helpLibrary/decorators.ts';
|
import { DecoratorsHelpPages } from 'commands/helpLibrary/decorators.ts';
|
||||||
import { DiceOptionsHelpPages } from 'commands/helpLibrary/diceOptions.ts';
|
import { DiceOptionsHelpPages } from 'commands/helpLibrary/diceOptions.ts';
|
||||||
import { DiceTypesHelpPages } from 'commands/helpLibrary/diceTypes.ts';
|
import { DiceTypesHelpPages } from 'commands/helpLibrary/diceTypes.ts';
|
||||||
|
import { DifferencesHelpPages } from 'commands/helpLibrary/differences.ts';
|
||||||
import { FormattingHelpPages } from 'commands/helpLibrary/formatting.ts';
|
import { FormattingHelpPages } from 'commands/helpLibrary/formatting.ts';
|
||||||
import { LegalMathComplexFuncsHelpPages } from 'commands/helpLibrary/legalMathComplexFuncs.ts';
|
import { LegalMathComplexFuncsHelpPages } from 'commands/helpLibrary/legalMathComplexFuncs.ts';
|
||||||
import { LegalMathConstsHelpPages } from 'commands/helpLibrary/legalMathConsts.ts';
|
import { LegalMathConstsHelpPages } from 'commands/helpLibrary/legalMathConsts.ts';
|
||||||
|
@ -15,12 +16,13 @@ import { MiscFeaturesHelpPages } from 'commands/helpLibrary/miscFeatures.ts';
|
||||||
const name = `${config.name}'s Roll Command Details`;
|
const name = `${config.name}'s Roll Command Details`;
|
||||||
const description = `You can chain as many of these options as you want, as long as the option does not disallow it. This command also can fully solve math equations with parenthesis.
|
const description = `You can chain as many of these options as you want, as long as the option does not disallow it. This command also can fully solve math equations with parenthesis.
|
||||||
|
|
||||||
The help options in this group use the notation \`xdy\` to indicate the basic/required dice notation for die count and size as detailed in the \`Basic/Standard Dice Options\` page.
|
The help options in this group use the notation \`xdy\` to indicate the basic/required dice notation for die count and size as detailed in the \`Dice Options/Basic Dice Options\` page.
|
||||||
|
|
||||||
As this supports the [Roll20 formatting](${config.links.roll20Formatting}) syntax fully, more details and examples can be found [here](${config.links.roll20Formatting}).
|
As this supports the [Roll20 formatting](${config.links.roll20Formatting}) syntax fully, more details and examples can be found [here](${config.links.roll20Formatting}).
|
||||||
|
|
||||||
Please use the dropdown/select menus to search through the provided documentation.`;
|
Please use the dropdown/select menus to search through the provided documentation.`;
|
||||||
const dict = new Map<string, HelpPage>([
|
const dict = new Map<string, HelpPage>([
|
||||||
|
['differences', DifferencesHelpPages],
|
||||||
['dice-types', DiceTypesHelpPages],
|
['dice-types', DiceTypesHelpPages],
|
||||||
['dice-options', DiceOptionsHelpPages],
|
['dice-options', DiceOptionsHelpPages],
|
||||||
['decorators', DecoratorsHelpPages],
|
['decorators', DecoratorsHelpPages],
|
||||||
|
|
|
@ -0,0 +1,34 @@
|
||||||
|
import config from '~config';
|
||||||
|
|
||||||
|
import { HelpContents, HelpPage } from 'commands/helpLibrary/helpLibrary.d.ts';
|
||||||
|
|
||||||
|
const name = 'Differences from Roll20';
|
||||||
|
const description = `This section details anything ${config.name} implements differently from Roll20.`;
|
||||||
|
const dict = new Map<string, HelpContents>([
|
||||||
|
[
|
||||||
|
'diff',
|
||||||
|
{
|
||||||
|
name: 'Features Differences',
|
||||||
|
description: `The following features are implemented slightly different in ${config.name}:
|
||||||
|
- **GM Rolls:** Instead of doing \`/gmroll\`, use the regular inline syntax, but tack on \`-gm @user\`. More details can be found on the \`Roll Command Decorators/GM Roll\` page.
|
||||||
|
- **Computed Dice Rolls:** As ${config.name} supports implicit multiplication, computed dice rolls use the Nested Rolls syntax. More details can be found on the \`Miscellaneous Features/Nested Rolls\` page.`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'miss',
|
||||||
|
{
|
||||||
|
name: 'Features Missing',
|
||||||
|
description: `The following features are not implemented in ${config.name}:
|
||||||
|
- As ${config.name} does not have access to your character sheet or to Roll20, \`&{tracker}\` and \`@{attribute}\` are not supported.
|
||||||
|
- **Roll queries (**\`?{Prompt Message}\`**):** Not supported to keep interactions with ${config.name} quick and simple.
|
||||||
|
- **Inline Labels:** As all rolls must be inline dice rolls with ${config.name}, inline labels are not supported.`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
|
||||||
|
export const DifferencesHelpPages: HelpPage = {
|
||||||
|
name,
|
||||||
|
description,
|
||||||
|
isPage: true,
|
||||||
|
dict,
|
||||||
|
};
|
Loading…
Reference in New Issue