diff --git a/docusaurus.config.js b/docusaurus.config.ts similarity index 79% rename from docusaurus.config.js rename to docusaurus.config.ts index 7c4e3ed2..aa166e11 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.ts @@ -1,26 +1,15 @@ -// @ts-check -// Note: type annotations allow type checking and IDEs autocompletion +import {themes} from 'prism-react-renderer'; +import remarkCrafting from './src/remark/crafting'; +import autoprefixer from 'autoprefixer'; +import tailwindcss from 'tailwindcss'; + +import type {Config} from '@docusaurus/types'; +import type * as Preset from '@docusaurus/preset-classic'; -const {themes} = require('prism-react-renderer'); -const remarkCrafting = require('./src/remark/crafting') const lightCodeTheme = themes.github; const darkCodeTheme = themes.dracula; -/** @type {import('@docusaurus/types').Config} */ -const config = { - plugins: [ - 'docusaurus-plugin-sass', - async function tailwind(context, options) { - return { - name: "docusaurus-tailwind", - configurePostCss(postcssOptions) { - postcssOptions.plugins.push(require("tailwindcss")); - postcssOptions.plugins.push(require("autoprefixer")); - return postcssOptions; - }, - }; - } - ], +const config: Config = { title: 'Feed The Beast Docs', tagline: 'Documentation for FTB Modpacks, Mods, the FTB App and Support topics', favicon: 'img/favicon.png', @@ -54,8 +43,7 @@ const config = { presets: [ [ 'classic', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ + { docs: { sidebarPath: require.resolve('./sidebars.js'), // Please change this to your repo. @@ -69,13 +57,45 @@ const config = { theme: { customCss: require.resolve('./src/css/custom.css'), }, - }), + } satisfies Preset.Options, ], ], - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ + plugins: [ + 'docusaurus-plugin-sass', + async function tailwind() { + return { + name: "docusaurus-tailwind", + configurePostCss(postcssOptions) { + postcssOptions.plugins.push(tailwindcss); + postcssOptions.plugins.push(autoprefixer); + return postcssOptions; + }, + }; + }, + ['@docusaurus/plugin-content-docs', + { + id: 'mods', + path: 'mod-docs', + routeBasePath: 'mod-docs', + sidebarPath: './sidebarsMods.ts', + includeCurrentVersion: false, + }], + ['@docusaurus/plugin-client-redirects', + { + createRedirects(existingPath) { + if (existingPath.includes('/mod-docs/mods')) { + // Redirect from /docs/team/X to /community/X and /docs/support/X to /community/X + return [ + existingPath.replace('/mod-docs/mods', '/docs/mods'), + ]; + } + return undefined; // Return a falsy value: no redirect created + }, + }], + ], + + themeConfig: { colorMode: { defaultMode: 'dark', respectPrefersColorScheme: true @@ -95,12 +115,6 @@ const config = { position: 'left', label: 'FTB App', }, - // { - // type: 'docSidebar', - // sidebarId: 'modpacks', - // position: 'left', - // label: 'Modpacks', - // }, { type: 'docSidebar', sidebarId: 'marketplace', @@ -113,6 +127,7 @@ const config = { sidebarId: 'mods', position: 'left', label: 'Mods', + docsPluginId: 'mods', }, { type: 'docSidebar', @@ -120,6 +135,11 @@ const config = { position: 'left', label: 'Support', }, + { + type: 'docsVersionDropdown', + docsPluginId: 'mods', + position: 'right', + }, { href: 'https://github.com/ftbTeam/docs/', label: 'GitHub', @@ -137,13 +157,9 @@ const config = { label: 'FTB App', to: '/docs/app', }, - // { - // label: 'Modpacks', - // to: '/docs/modpacks', - // }, { label: 'Mods', - to: '/docs/mods', + to: '/mod-docs/mods', }, { label: 'Support', @@ -206,7 +222,7 @@ const config = { // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default) insights: false, }, - }), + } satisfies Preset.ThemeConfig, }; -module.exports = config; +export default config; diff --git a/docs/mods/_assets/ftb-config-screen-example.png b/mod-docs/_assets/ftb-config-screen-example.png similarity index 100% rename from docs/mods/_assets/ftb-config-screen-example.png rename to mod-docs/_assets/ftb-config-screen-example.png diff --git a/docs/mods/_assets/ftb-library-nbt-editor.png b/mod-docs/_assets/ftb-library-nbt-editor.png similarity index 100% rename from docs/mods/_assets/ftb-library-nbt-editor.png rename to mod-docs/_assets/ftb-library-nbt-editor.png diff --git a/docs/mods/_assets/ftb-library-sidebar-buttons.png b/mod-docs/_assets/ftb-library-sidebar-buttons.png similarity index 100% rename from docs/mods/_assets/ftb-library-sidebar-buttons.png rename to mod-docs/_assets/ftb-library-sidebar-buttons.png diff --git a/docs/mods/_assets/ftb-teams-example-gui.png b/mod-docs/_assets/ftb-teams-example-gui.png similarity index 100% rename from docs/mods/_assets/ftb-teams-example-gui.png rename to mod-docs/_assets/ftb-teams-example-gui.png diff --git a/docs/mods/_assets/ftb-ultimine-shapeless-example.png b/mod-docs/_assets/ftb-ultimine-shapeless-example.png similarity index 100% rename from docs/mods/_assets/ftb-ultimine-shapeless-example.png rename to mod-docs/_assets/ftb-ultimine-shapeless-example.png diff --git a/docs/mods/_assets/images/backups3/backups-3-client-config.webp b/mod-docs/_assets/images/backups3/backups-3-client-config.webp similarity index 100% rename from docs/mods/_assets/images/backups3/backups-3-client-config.webp rename to mod-docs/_assets/images/backups3/backups-3-client-config.webp diff --git a/docs/mods/_assets/images/backups3/backups-3-config-select.webp b/mod-docs/_assets/images/backups3/backups-3-config-select.webp similarity index 100% rename from docs/mods/_assets/images/backups3/backups-3-config-select.webp rename to mod-docs/_assets/images/backups3/backups-3-config-select.webp diff --git a/docs/mods/_assets/images/backups3/backups-3-server-config.webp b/mod-docs/_assets/images/backups3/backups-3-server-config.webp similarity index 100% rename from docs/mods/_assets/images/backups3/backups-3-server-config.webp rename to mod-docs/_assets/images/backups3/backups-3-server-config.webp diff --git a/docs/mods/_assets/images/chunks/chunks-claiming.webp b/mod-docs/_assets/images/chunks/chunks-claiming.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-claiming.webp rename to mod-docs/_assets/images/chunks/chunks-claiming.webp diff --git a/docs/mods/_assets/images/chunks/chunks-config-modal.webp b/mod-docs/_assets/images/chunks/chunks-config-modal.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-config-modal.webp rename to mod-docs/_assets/images/chunks/chunks-config-modal.webp diff --git a/docs/mods/_assets/images/chunks/chunks-in-game-config-buttons.webp b/mod-docs/_assets/images/chunks/chunks-in-game-config-buttons.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-in-game-config-buttons.webp rename to mod-docs/_assets/images/chunks/chunks-in-game-config-buttons.webp diff --git a/docs/mods/_assets/images/chunks/chunks-loading.webp b/mod-docs/_assets/images/chunks/chunks-loading.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-loading.webp rename to mod-docs/_assets/images/chunks/chunks-loading.webp diff --git a/docs/mods/_assets/images/chunks/chunks-minimap-info-button.webp b/mod-docs/_assets/images/chunks/chunks-minimap-info-button.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-minimap-info-button.webp rename to mod-docs/_assets/images/chunks/chunks-minimap-info-button.webp diff --git a/docs/mods/_assets/images/chunks/chunks-minimap-info.png b/mod-docs/_assets/images/chunks/chunks-minimap-info.png similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-minimap-info.png rename to mod-docs/_assets/images/chunks/chunks-minimap-info.png diff --git a/docs/mods/_assets/images/chunks/chunks-unclaim.webp b/mod-docs/_assets/images/chunks/chunks-unclaim.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-unclaim.webp rename to mod-docs/_assets/images/chunks/chunks-unclaim.webp diff --git a/docs/mods/_assets/images/chunks/chunks-unload.webp b/mod-docs/_assets/images/chunks/chunks-unload.webp similarity index 100% rename from docs/mods/_assets/images/chunks/chunks-unload.webp rename to mod-docs/_assets/images/chunks/chunks-unload.webp diff --git a/docs/mods/_assets/images/quests/chapter-rightclick.webp b/mod-docs/_assets/images/quests/chapter-rightclick.webp similarity index 100% rename from docs/mods/_assets/images/quests/chapter-rightclick.webp rename to mod-docs/_assets/images/quests/chapter-rightclick.webp diff --git a/docs/mods/_assets/images/quests/chapter-settings.webp b/mod-docs/_assets/images/quests/chapter-settings.webp similarity index 100% rename from docs/mods/_assets/images/quests/chapter-settings.webp rename to mod-docs/_assets/images/quests/chapter-settings.webp diff --git a/docs/mods/_assets/images/quests/chapter-sidebar-min.webp b/mod-docs/_assets/images/quests/chapter-sidebar-min.webp similarity index 100% rename from docs/mods/_assets/images/quests/chapter-sidebar-min.webp rename to mod-docs/_assets/images/quests/chapter-sidebar-min.webp diff --git a/docs/mods/_assets/images/quests/chapter-sidebar-pin.webp b/mod-docs/_assets/images/quests/chapter-sidebar-pin.webp similarity index 100% rename from docs/mods/_assets/images/quests/chapter-sidebar-pin.webp rename to mod-docs/_assets/images/quests/chapter-sidebar-pin.webp diff --git a/docs/mods/_assets/images/quests/claim-all-rewards.webp b/mod-docs/_assets/images/quests/claim-all-rewards.webp similarity index 100% rename from docs/mods/_assets/images/quests/claim-all-rewards.webp rename to mod-docs/_assets/images/quests/claim-all-rewards.webp diff --git a/docs/mods/_assets/images/quests/claim-rewards.webp b/mod-docs/_assets/images/quests/claim-rewards.webp similarity index 100% rename from docs/mods/_assets/images/quests/claim-rewards.webp rename to mod-docs/_assets/images/quests/claim-rewards.webp diff --git a/docs/mods/_assets/images/quests/create-a-quest.webp b/mod-docs/_assets/images/quests/create-a-quest.webp similarity index 100% rename from docs/mods/_assets/images/quests/create-a-quest.webp rename to mod-docs/_assets/images/quests/create-a-quest.webp diff --git a/docs/mods/_assets/images/quests/creating-a-chapter.webp b/mod-docs/_assets/images/quests/creating-a-chapter.webp similarity index 100% rename from docs/mods/_assets/images/quests/creating-a-chapter.webp rename to mod-docs/_assets/images/quests/creating-a-chapter.webp diff --git a/docs/mods/_assets/images/quests/empty-questbook.webp b/mod-docs/_assets/images/quests/empty-questbook.webp similarity index 100% rename from docs/mods/_assets/images/quests/empty-questbook.webp rename to mod-docs/_assets/images/quests/empty-questbook.webp diff --git a/docs/mods/_assets/images/quests/key-reference.webp b/mod-docs/_assets/images/quests/key-reference.webp similarity index 100% rename from docs/mods/_assets/images/quests/key-reference.webp rename to mod-docs/_assets/images/quests/key-reference.webp diff --git a/docs/mods/_assets/images/quests/moving-around-quests.webp b/mod-docs/_assets/images/quests/moving-around-quests.webp similarity index 100% rename from docs/mods/_assets/images/quests/moving-around-quests.webp rename to mod-docs/_assets/images/quests/moving-around-quests.webp diff --git a/docs/mods/_assets/images/quests/opening-a-quest.webp b/mod-docs/_assets/images/quests/opening-a-quest.webp similarity index 100% rename from docs/mods/_assets/images/quests/opening-a-quest.webp rename to mod-docs/_assets/images/quests/opening-a-quest.webp diff --git a/docs/mods/_assets/images/quests/opening-questbook-inv.webp b/mod-docs/_assets/images/quests/opening-questbook-inv.webp similarity index 100% rename from docs/mods/_assets/images/quests/opening-questbook-inv.webp rename to mod-docs/_assets/images/quests/opening-questbook-inv.webp diff --git a/docs/mods/_assets/images/quests/pinning-a-quest.webp b/mod-docs/_assets/images/quests/pinning-a-quest.webp similarity index 100% rename from docs/mods/_assets/images/quests/pinning-a-quest.webp rename to mod-docs/_assets/images/quests/pinning-a-quest.webp diff --git a/docs/mods/_assets/images/quests/quest-add-reward.webp b/mod-docs/_assets/images/quests/quest-add-reward.webp similarity index 100% rename from docs/mods/_assets/images/quests/quest-add-reward.webp rename to mod-docs/_assets/images/quests/quest-add-reward.webp diff --git a/docs/mods/_assets/images/quests/quest-add-task.webp b/mod-docs/_assets/images/quests/quest-add-task.webp similarity index 100% rename from docs/mods/_assets/images/quests/quest-add-task.webp rename to mod-docs/_assets/images/quests/quest-add-task.webp diff --git a/docs/mods/_assets/images/quests/quest-convert-to-tag-filter.webp b/mod-docs/_assets/images/quests/quest-convert-to-tag-filter.webp similarity index 100% rename from docs/mods/_assets/images/quests/quest-convert-to-tag-filter.webp rename to mod-docs/_assets/images/quests/quest-convert-to-tag-filter.webp diff --git a/docs/mods/_assets/images/quests/quest-notification-1.png b/mod-docs/_assets/images/quests/quest-notification-1.png similarity index 100% rename from docs/mods/_assets/images/quests/quest-notification-1.png rename to mod-docs/_assets/images/quests/quest-notification-1.png diff --git a/docs/mods/_assets/images/quests/quest-notification-2.webp b/mod-docs/_assets/images/quests/quest-notification-2.webp similarity index 100% rename from docs/mods/_assets/images/quests/quest-notification-2.webp rename to mod-docs/_assets/images/quests/quest-notification-2.webp diff --git a/docs/mods/_assets/images/quests/quest-unclaimed.webp b/mod-docs/_assets/images/quests/quest-unclaimed.webp similarity index 100% rename from docs/mods/_assets/images/quests/quest-unclaimed.webp rename to mod-docs/_assets/images/quests/quest-unclaimed.webp diff --git a/docs/mods/_assets/images/quests/questbook-chapters.webp b/mod-docs/_assets/images/quests/questbook-chapters.webp similarity index 100% rename from docs/mods/_assets/images/quests/questbook-chapters.webp rename to mod-docs/_assets/images/quests/questbook-chapters.webp diff --git a/docs/mods/_assets/images/quests/questbook-dependency-buttons.webp b/mod-docs/_assets/images/quests/questbook-dependency-buttons.webp similarity index 100% rename from docs/mods/_assets/images/quests/questbook-dependency-buttons.webp rename to mod-docs/_assets/images/quests/questbook-dependency-buttons.webp diff --git a/docs/mods/_assets/images/quests/questbook-dependency-dropdown.webp b/mod-docs/_assets/images/quests/questbook-dependency-dropdown.webp similarity index 100% rename from docs/mods/_assets/images/quests/questbook-dependency-dropdown.webp rename to mod-docs/_assets/images/quests/questbook-dependency-dropdown.webp diff --git a/docs/mods/_assets/images/quests/questbook-dependency-hidden.png b/mod-docs/_assets/images/quests/questbook-dependency-hidden.png similarity index 100% rename from docs/mods/_assets/images/quests/questbook-dependency-hidden.png rename to mod-docs/_assets/images/quests/questbook-dependency-hidden.png diff --git a/docs/mods/_assets/images/quests/questbook-dependency-upstream.webp b/mod-docs/_assets/images/quests/questbook-dependency-upstream.webp similarity index 100% rename from docs/mods/_assets/images/quests/questbook-dependency-upstream.webp rename to mod-docs/_assets/images/quests/questbook-dependency-upstream.webp diff --git a/docs/mods/_assets/images/quests/questbook-item.webp b/mod-docs/_assets/images/quests/questbook-item.webp similarity index 100% rename from docs/mods/_assets/images/quests/questbook-item.webp rename to mod-docs/_assets/images/quests/questbook-item.webp diff --git a/docs/mods/_assets/images/quests/questbook-linked-quest.png b/mod-docs/_assets/images/quests/questbook-linked-quest.png similarity index 100% rename from docs/mods/_assets/images/quests/questbook-linked-quest.png rename to mod-docs/_assets/images/quests/questbook-linked-quest.png diff --git a/docs/mods/_assets/images/quests/questbook-unclaimed.webp b/mod-docs/_assets/images/quests/questbook-unclaimed.webp similarity index 100% rename from docs/mods/_assets/images/quests/questbook-unclaimed.webp rename to mod-docs/_assets/images/quests/questbook-unclaimed.webp diff --git a/docs/mods/_assets/images/quests/rewards/accept.png b/mod-docs/_assets/images/quests/rewards/accept.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/accept.png rename to mod-docs/_assets/images/quests/rewards/accept.png diff --git a/docs/mods/_assets/images/quests/rewards/advancement-isnt-iron-pick.png b/mod-docs/_assets/images/quests/rewards/advancement-isnt-iron-pick.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/advancement-isnt-iron-pick.png rename to mod-docs/_assets/images/quests/rewards/advancement-isnt-iron-pick.png diff --git a/docs/mods/_assets/images/quests/rewards/advancement-screen-iron-pick.png b/mod-docs/_assets/images/quests/rewards/advancement-screen-iron-pick.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/advancement-screen-iron-pick.png rename to mod-docs/_assets/images/quests/rewards/advancement-screen-iron-pick.png diff --git a/docs/mods/_assets/images/quests/rewards/all-table-reward.webp b/mod-docs/_assets/images/quests/rewards/all-table-reward.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/all-table-reward.webp rename to mod-docs/_assets/images/quests/rewards/all-table-reward.webp diff --git a/docs/mods/_assets/images/quests/rewards/choice-reward.webp b/mod-docs/_assets/images/quests/rewards/choice-reward.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/choice-reward.webp rename to mod-docs/_assets/images/quests/rewards/choice-reward.webp diff --git a/docs/mods/_assets/images/quests/rewards/command-claim-quest.webp b/mod-docs/_assets/images/quests/rewards/command-claim-quest.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/command-claim-quest.webp rename to mod-docs/_assets/images/quests/rewards/command-claim-quest.webp diff --git a/docs/mods/_assets/images/quests/rewards/command-dummy-quest.png b/mod-docs/_assets/images/quests/rewards/command-dummy-quest.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/command-dummy-quest.png rename to mod-docs/_assets/images/quests/rewards/command-dummy-quest.png diff --git a/docs/mods/_assets/images/quests/rewards/command-woodcutting.webp b/mod-docs/_assets/images/quests/rewards/command-woodcutting.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/command-woodcutting.webp rename to mod-docs/_assets/images/quests/rewards/command-woodcutting.webp diff --git a/docs/mods/_assets/images/quests/rewards/custom-claim-reward.webp b/mod-docs/_assets/images/quests/rewards/custom-claim-reward.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/custom-claim-reward.webp rename to mod-docs/_assets/images/quests/rewards/custom-claim-reward.webp diff --git a/docs/mods/_assets/images/quests/rewards/custom-copy-id.webp b/mod-docs/_assets/images/quests/rewards/custom-copy-id.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/custom-copy-id.webp rename to mod-docs/_assets/images/quests/rewards/custom-copy-id.webp diff --git a/docs/mods/_assets/images/quests/rewards/custom-lv-forty-three.png b/mod-docs/_assets/images/quests/rewards/custom-lv-forty-three.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/custom-lv-forty-three.png rename to mod-docs/_assets/images/quests/rewards/custom-lv-forty-three.png diff --git a/docs/mods/_assets/images/quests/rewards/custom-quest-complete.webp b/mod-docs/_assets/images/quests/rewards/custom-quest-complete.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/custom-quest-complete.webp rename to mod-docs/_assets/images/quests/rewards/custom-quest-complete.webp diff --git a/docs/mods/_assets/images/quests/rewards/custom-receive-diamond.webp b/mod-docs/_assets/images/quests/rewards/custom-receive-diamond.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/custom-receive-diamond.webp rename to mod-docs/_assets/images/quests/rewards/custom-receive-diamond.webp diff --git a/docs/mods/_assets/images/quests/rewards/custom-reward-creation.webp b/mod-docs/_assets/images/quests/rewards/custom-reward-creation.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/custom-reward-creation.webp rename to mod-docs/_assets/images/quests/rewards/custom-reward-creation.webp diff --git a/docs/mods/_assets/images/quests/rewards/edit_reward_tables.webp b/mod-docs/_assets/images/quests/rewards/edit_reward_tables.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/edit_reward_tables.webp rename to mod-docs/_assets/images/quests/rewards/edit_reward_tables.webp diff --git a/docs/mods/_assets/images/quests/rewards/item-reward-fluid-tank.png b/mod-docs/_assets/images/quests/rewards/item-reward-fluid-tank.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/item-reward-fluid-tank.png rename to mod-docs/_assets/images/quests/rewards/item-reward-fluid-tank.png diff --git a/docs/mods/_assets/images/quests/rewards/item-reward-inventory-mode.webp b/mod-docs/_assets/images/quests/rewards/item-reward-inventory-mode.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/item-reward-inventory-mode.webp rename to mod-docs/_assets/images/quests/rewards/item-reward-inventory-mode.webp diff --git a/docs/mods/_assets/images/quests/rewards/item-reward-list-mode.png b/mod-docs/_assets/images/quests/rewards/item-reward-list-mode.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/item-reward-list-mode.png rename to mod-docs/_assets/images/quests/rewards/item-reward-list-mode.png diff --git a/docs/mods/_assets/images/quests/rewards/item-reward-two-axe.webp b/mod-docs/_assets/images/quests/rewards/item-reward-two-axe.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/item-reward-two-axe.webp rename to mod-docs/_assets/images/quests/rewards/item-reward-two-axe.webp diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-common.png b/mod-docs/_assets/images/quests/rewards/loot-crate-common.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-common.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-common.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-epic.png b/mod-docs/_assets/images/quests/rewards/loot-crate-epic.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-epic.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-epic.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-id.png b/mod-docs/_assets/images/quests/rewards/loot-crate-id.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-id.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-id.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-igneous-rocks.png b/mod-docs/_assets/images/quests/rewards/loot-crate-igneous-rocks.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-igneous-rocks.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-igneous-rocks.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-legendary.webp b/mod-docs/_assets/images/quests/rewards/loot-crate-legendary.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-legendary.webp rename to mod-docs/_assets/images/quests/rewards/loot-crate-legendary.webp diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-rare.png b/mod-docs/_assets/images/quests/rewards/loot-crate-rare.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-rare.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-rare.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-reach-config.webp b/mod-docs/_assets/images/quests/rewards/loot-crate-reach-config.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-reach-config.webp rename to mod-docs/_assets/images/quests/rewards/loot-crate-reach-config.webp diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-silverfish.png b/mod-docs/_assets/images/quests/rewards/loot-crate-silverfish.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-silverfish.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-silverfish.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-crate-uncommon.png b/mod-docs/_assets/images/quests/rewards/loot-crate-uncommon.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-crate-uncommon.png rename to mod-docs/_assets/images/quests/rewards/loot-crate-uncommon.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-reward-golden-apple.png b/mod-docs/_assets/images/quests/rewards/loot-reward-golden-apple.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-reward-golden-apple.png rename to mod-docs/_assets/images/quests/rewards/loot-reward-golden-apple.png diff --git a/docs/mods/_assets/images/quests/rewards/loot-reward-preview.png b/mod-docs/_assets/images/quests/rewards/loot-reward-preview.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/loot-reward-preview.png rename to mod-docs/_assets/images/quests/rewards/loot-reward-preview.png diff --git a/docs/mods/_assets/images/quests/rewards/nesting-add-common.webp b/mod-docs/_assets/images/quests/rewards/nesting-add-common.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-add-common.webp rename to mod-docs/_assets/images/quests/rewards/nesting-add-common.webp diff --git a/docs/mods/_assets/images/quests/rewards/nesting-all-five.webp b/mod-docs/_assets/images/quests/rewards/nesting-all-five.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-all-five.webp rename to mod-docs/_assets/images/quests/rewards/nesting-all-five.webp diff --git a/docs/mods/_assets/images/quests/rewards/nesting-five-crates-inv.webp b/mod-docs/_assets/images/quests/rewards/nesting-five-crates-inv.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-five-crates-inv.webp rename to mod-docs/_assets/images/quests/rewards/nesting-five-crates-inv.webp diff --git a/docs/mods/_assets/images/quests/rewards/nesting-five-types.png b/mod-docs/_assets/images/quests/rewards/nesting-five-types.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-five-types.png rename to mod-docs/_assets/images/quests/rewards/nesting-five-types.png diff --git a/docs/mods/_assets/images/quests/rewards/nesting-loot-reward.webp b/mod-docs/_assets/images/quests/rewards/nesting-loot-reward.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-loot-reward.webp rename to mod-docs/_assets/images/quests/rewards/nesting-loot-reward.webp diff --git a/docs/mods/_assets/images/quests/rewards/nesting-parent.png b/mod-docs/_assets/images/quests/rewards/nesting-parent.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-parent.png rename to mod-docs/_assets/images/quests/rewards/nesting-parent.png diff --git a/docs/mods/_assets/images/quests/rewards/nesting-rename-loot-crate.png b/mod-docs/_assets/images/quests/rewards/nesting-rename-loot-crate.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/nesting-rename-loot-crate.png rename to mod-docs/_assets/images/quests/rewards/nesting-rename-loot-crate.png diff --git a/docs/mods/_assets/images/quests/rewards/random-reward.png b/mod-docs/_assets/images/quests/rewards/random-reward.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/random-reward.png rename to mod-docs/_assets/images/quests/rewards/random-reward.png diff --git a/docs/mods/_assets/images/quests/rewards/settings-cog.png b/mod-docs/_assets/images/quests/rewards/settings-cog.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/settings-cog.png rename to mod-docs/_assets/images/quests/rewards/settings-cog.png diff --git a/docs/mods/_assets/images/quests/rewards/stage-visited-nether.webp b/mod-docs/_assets/images/quests/rewards/stage-visited-nether.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/stage-visited-nether.webp rename to mod-docs/_assets/images/quests/rewards/stage-visited-nether.webp diff --git a/docs/mods/_assets/images/quests/rewards/stages-custom-pcb-task.webp b/mod-docs/_assets/images/quests/rewards/stages-custom-pcb-task.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/stages-custom-pcb-task.webp rename to mod-docs/_assets/images/quests/rewards/stages-custom-pcb-task.webp diff --git a/docs/mods/_assets/images/quests/rewards/stages-ftblib-nbtedit.png b/mod-docs/_assets/images/quests/rewards/stages-ftblib-nbtedit.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/stages-ftblib-nbtedit.png rename to mod-docs/_assets/images/quests/rewards/stages-ftblib-nbtedit.png diff --git a/docs/mods/_assets/images/quests/rewards/stages-got-diamonds.webp b/mod-docs/_assets/images/quests/rewards/stages-got-diamonds.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/stages-got-diamonds.webp rename to mod-docs/_assets/images/quests/rewards/stages-got-diamonds.webp diff --git a/docs/mods/_assets/images/quests/rewards/stages-zoom-tags.png b/mod-docs/_assets/images/quests/rewards/stages-zoom-tags.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/stages-zoom-tags.png rename to mod-docs/_assets/images/quests/rewards/stages-zoom-tags.png diff --git a/docs/mods/_assets/images/quests/rewards/toast-disable-popup.png b/mod-docs/_assets/images/quests/rewards/toast-disable-popup.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/toast-disable-popup.png rename to mod-docs/_assets/images/quests/rewards/toast-disable-popup.png diff --git a/docs/mods/_assets/images/quests/rewards/toast-edit-quest.webp b/mod-docs/_assets/images/quests/rewards/toast-edit-quest.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/toast-edit-quest.webp rename to mod-docs/_assets/images/quests/rewards/toast-edit-quest.webp diff --git a/docs/mods/_assets/images/quests/rewards/toast-edit-reward.webp b/mod-docs/_assets/images/quests/rewards/toast-edit-reward.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/toast-edit-reward.webp rename to mod-docs/_assets/images/quests/rewards/toast-edit-reward.webp diff --git a/docs/mods/_assets/images/quests/rewards/toast-edit-title-desc.png b/mod-docs/_assets/images/quests/rewards/toast-edit-title-desc.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/toast-edit-title-desc.png rename to mod-docs/_assets/images/quests/rewards/toast-edit-title-desc.png diff --git a/docs/mods/_assets/images/quests/rewards/toast-example-quest.png b/mod-docs/_assets/images/quests/rewards/toast-example-quest.png similarity index 100% rename from docs/mods/_assets/images/quests/rewards/toast-example-quest.png rename to mod-docs/_assets/images/quests/rewards/toast-example-quest.png diff --git a/docs/mods/_assets/images/quests/rewards/toast-show-up.webp b/mod-docs/_assets/images/quests/rewards/toast-show-up.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/toast-show-up.webp rename to mod-docs/_assets/images/quests/rewards/toast-show-up.webp diff --git a/docs/mods/_assets/images/quests/rewards/xp-levels.webp b/mod-docs/_assets/images/quests/rewards/xp-levels.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/xp-levels.webp rename to mod-docs/_assets/images/quests/rewards/xp-levels.webp diff --git a/docs/mods/_assets/images/quests/rewards/xp-points.webp b/mod-docs/_assets/images/quests/rewards/xp-points.webp similarity index 100% rename from docs/mods/_assets/images/quests/rewards/xp-points.webp rename to mod-docs/_assets/images/quests/rewards/xp-points.webp diff --git a/docs/mods/_assets/images/quests/viewing-a-task.webp b/mod-docs/_assets/images/quests/viewing-a-task.webp similarity index 100% rename from docs/mods/_assets/images/quests/viewing-a-task.webp rename to mod-docs/_assets/images/quests/viewing-a-task.webp diff --git a/docs/mods/_assets/images/ultimine/ultimine-sidebar.png b/mod-docs/_assets/images/ultimine/ultimine-sidebar.png similarity index 100% rename from docs/mods/_assets/images/ultimine/ultimine-sidebar.png rename to mod-docs/_assets/images/ultimine/ultimine-sidebar.png diff --git a/docs/mods/_assets/images/ultimine/ultimine-status-panel.png b/mod-docs/_assets/images/ultimine/ultimine-status-panel.png similarity index 100% rename from docs/mods/_assets/images/ultimine/ultimine-status-panel.png rename to mod-docs/_assets/images/ultimine/ultimine-status-panel.png diff --git a/docs/mods/others/index.md b/mod-docs/others/index.md similarity index 96% rename from docs/mods/others/index.md rename to mod-docs/others/index.md index 3b30619a..44f8cb75 100644 --- a/docs/mods/others/index.md +++ b/mod-docs/others/index.md @@ -10,7 +10,7 @@ Our documentation for FTB Mods is still under active development. We make quite a few mods for our modpacks, some modpacks have more custom mods than others but we do not consider our one off mods as part of our core suite of mods. This means, although we will continue to fix bugs and try and keep them stable, we won't necessarily be adding new features to them, nor porting them to newer versions of Minecraft. :::info -More information about our core suite of mods can be found [here](/docs/mods/suite). +More information about our core suite of mods can be found [here](/mod-docs/mods/suite). For now, please refer to our Mods github repository for more information on our other mods. ::: diff --git a/docs/mods/suite/Backups-2/config.md b/mod-docs/suite/Backups-2/config.md similarity index 100% rename from docs/mods/suite/Backups-2/config.md rename to mod-docs/suite/Backups-2/config.md diff --git a/docs/mods/suite/Backups-2/index.md b/mod-docs/suite/Backups-2/index.md similarity index 100% rename from docs/mods/suite/Backups-2/index.md rename to mod-docs/suite/Backups-2/index.md diff --git a/docs/mods/suite/Backups-3/config.mdx b/mod-docs/suite/Backups-3/config.mdx similarity index 99% rename from docs/mods/suite/Backups-3/config.mdx rename to mod-docs/suite/Backups-3/config.mdx index dbfe7de8..74b70668 100644 --- a/docs/mods/suite/Backups-3/config.mdx +++ b/mod-docs/suite/Backups-3/config.mdx @@ -10,7 +10,7 @@ sidebar_position: 2 import clientConfigScreen from '../../_assets/images/backups3/backups-3-client-config.webp'; import serverConfigScreen from '../../_assets/images/backups3/backups-3-server-config.webp'; import configSelector from '../../_assets/images/backups3/backups-3-config-select.webp'; -import {Slideshow} from '../../../../src/components/SlideShow/Slideshow'; +import {Slideshow} from '@site/src/components/SlideShow/Slideshow'; FTB Backups 3 can be configured either in-game by opening the FTB Backups 3 menu from the inventory screen or by editing the `ftbbackups3-server.toml` located in the config folder. diff --git a/docs/mods/suite/Backups-3/index.md b/mod-docs/suite/Backups-3/index.md similarity index 100% rename from docs/mods/suite/Backups-3/index.md rename to mod-docs/suite/Backups-3/index.md diff --git a/docs/mods/suite/Backups-3/restoring.mdx b/mod-docs/suite/Backups-3/restoring.mdx similarity index 100% rename from docs/mods/suite/Backups-3/restoring.mdx rename to mod-docs/suite/Backups-3/restoring.mdx diff --git a/docs/mods/suite/Chunks/claiming-loading.md b/mod-docs/suite/Chunks/claiming-loading.md similarity index 100% rename from docs/mods/suite/Chunks/claiming-loading.md rename to mod-docs/suite/Chunks/claiming-loading.md diff --git a/docs/mods/suite/Chunks/commands.md b/mod-docs/suite/Chunks/commands.md similarity index 100% rename from docs/mods/suite/Chunks/commands.md rename to mod-docs/suite/Chunks/commands.md diff --git a/docs/mods/suite/Chunks/config.md b/mod-docs/suite/Chunks/config.md similarity index 100% rename from docs/mods/suite/Chunks/config.md rename to mod-docs/suite/Chunks/config.md diff --git a/docs/mods/suite/Chunks/index.md b/mod-docs/suite/Chunks/index.md similarity index 100% rename from docs/mods/suite/Chunks/index.md rename to mod-docs/suite/Chunks/index.md diff --git a/docs/mods/suite/Chunks/maps-waypoints.md b/mod-docs/suite/Chunks/maps-waypoints.md similarity index 100% rename from docs/mods/suite/Chunks/maps-waypoints.md rename to mod-docs/suite/Chunks/maps-waypoints.md diff --git a/docs/mods/suite/Essentials/Commands.md b/mod-docs/suite/Essentials/Commands.md similarity index 92% rename from docs/mods/suite/Essentials/Commands.md rename to mod-docs/suite/Essentials/Commands.md index 92918bf8..7d8b6a86 100644 --- a/docs/mods/suite/Essentials/Commands.md +++ b/mod-docs/suite/Essentials/Commands.md @@ -11,7 +11,7 @@ title: Commands ## Homes -__Homes__ are player-specific saved teleport destinations. Players may have one or more saved locations, depending on server and (if installed) [FTB Ranks](/docs/mods/suite/Essentials/Ranks_Integration) configuration. +__Homes__ are player-specific saved teleport destinations. Players may have one or more saved locations, depending on server and (if installed) [FTB Ranks](/mod-docs/mods/suite/Essentials/Ranks_Integration) configuration. | Command |Op Required| Description | | ----------- | --------- | ------------ | @@ -67,7 +67,7 @@ All of these commands require `OP` to function |`/god [player]` | Enables God mode (Invulnerability) for you or the specified player.| |`/invsee ` | Opens the specified players inventory, allowing you to view and modify the inventory's contents.| |`/nicknamefor ` | Forces a nickname on a specific player.| -|`/mute [until]` | Mutes a player for a specified amount of time (`until`) or forever. The `until` is a duration time; omitting it mutes the player indefinitely. See [Duration](/docs/mods/suite/Essentials/Durations) for more information. Example: `/mute Slowpoke101 2h` mutes the player `Slowpoke101` for two hours.| +|`/mute [until]` | Mutes a player for a specified amount of time (`until`) or forever. The `until` is a duration time; omitting it mutes the player indefinitely. See [Duration](/mod-docs/mods/suite/Essentials/Durations) for more information. Example: `/mute Slowpoke101 2h` mutes the player `Slowpoke101` for two hours.| |`/unmute ` | Unmutes the specified player.| ### Offline Teleport @@ -81,7 +81,7 @@ _[New in Essentials 1.20.1+]_ Teleports a player to a given location when they'r ## Kits -Kits are a relatively new feature to Essentials and have more in-depth documentation on the [Kits](/docs/mods/suite/Essentials/Kits) page. All `/kit` commands require `OP` permissions to use. +Kits are a relatively new feature to Essentials and have more in-depth documentation on the [Kits](/mod-docs/mods/suite/Essentials/Kits) page. All `/kit` commands require `OP` permissions to use. | Command |Description | | ----------- | --------- | @@ -94,9 +94,9 @@ Kits are a relatively new feature to Essentials and have more in-depth documenta | Command |Description | | ----------- | --------- | |`/kit delete ` | Deletes the specified kit.| -|`/kit create_from_player_inv [cooldown]` | Creates a kit from the current player's inventory contents, with an optional cooldown [duration](/docs/mods/suite/Essentials/Durations).| -|`/kit create_from_player_hotbar [cooldown]` | Creates a kit from the current players hotbar contents, with an optional cooldown [duration](/docs/mods/suite/Essentials/Durations).| -|`/kit create_from_block_inv [cooldown]` | Creates a kit from the inventory contents of the block you're looking at, with an optional cooldown [duration](/docs/mods/suite/Essentials/Durations).| +|`/kit create_from_player_inv [cooldown]` | Creates a kit from the current player's inventory contents, with an optional cooldown [duration](/mod-docs/mods/suite/Essentials/Durations).| +|`/kit create_from_player_hotbar [cooldown]` | Creates a kit from the current players hotbar contents, with an optional cooldown [duration](/mod-docs/mods/suite/Essentials/Durations).| +|`/kit create_from_block_inv [cooldown]` | Creates a kit from the inventory contents of the block you're looking at, with an optional cooldown [duration](/mod-docs/mods/suite/Essentials/Durations).| ### Helper commands diff --git a/docs/mods/suite/Essentials/Configuration.md b/mod-docs/suite/Essentials/Configuration.md similarity index 85% rename from docs/mods/suite/Essentials/Configuration.md rename to mod-docs/suite/Essentials/Configuration.md index 5a1ef50a..8bb5b9a7 100644 --- a/docs/mods/suite/Essentials/Configuration.md +++ b/mod-docs/suite/Essentials/Configuration.md @@ -52,4 +52,4 @@ home: { } ``` -The `/home` command can be disabled (as all commmands can), but in addition, the default [warmup and cooldown](/docs/mods/suite/Essentials/Warmups_Cooldowns) can be changed, as well the default maximum number of homes that players can have. As per the comments, these defaults can be [overridden with FTB Ranks](/docs/mods/suite/Essentials/Ranks_Integration). +The `/home` command can be disabled (as all commmands can), but in addition, the default [warmup and cooldown](/mod-docs/mods/suite/Essentials/Warmups_Cooldowns) can be changed, as well the default maximum number of homes that players can have. As per the comments, these defaults can be [overridden with FTB Ranks](/mod-docs/mods/suite/Essentials/Ranks_Integration). diff --git a/docs/mods/suite/Essentials/Durations.md b/mod-docs/suite/Essentials/Durations.md similarity index 100% rename from docs/mods/suite/Essentials/Durations.md rename to mod-docs/suite/Essentials/Durations.md diff --git a/docs/mods/suite/Essentials/Kits.md b/mod-docs/suite/Essentials/Kits.md similarity index 100% rename from docs/mods/suite/Essentials/Kits.md rename to mod-docs/suite/Essentials/Kits.md diff --git a/docs/mods/suite/Essentials/Ranks_Integration.md b/mod-docs/suite/Essentials/Ranks_Integration.md similarity index 90% rename from docs/mods/suite/Essentials/Ranks_Integration.md rename to mod-docs/suite/Essentials/Ranks_Integration.md index 75cab848..cbdbf045 100644 --- a/docs/mods/suite/Essentials/Ranks_Integration.md +++ b/mod-docs/suite/Essentials/Ranks_Integration.md @@ -7,7 +7,7 @@ title: Ranks Integration FTB Essentials integrates with the FTB Ranks mod to provide the following additional configurability: * Commands which normally require OP permissions to run can be made available to players by giving them the corresponding command node permission. -* Commands which have configurable [warm-ups and cool-downs](/docs/mods/suite/Essentials/Warmups_Cooldowns) can use FTB Ranks permission nodes to override the default warmup and cooldown times, as defined in the [mod configuration](/docs/mods/suite/Essentials/Configuration). +* Commands which have configurable [warm-ups and cool-downs](/mod-docs/mods/suite/Essentials/Warmups_Cooldowns) can use FTB Ranks permission nodes to override the default warmup and cooldown times, as defined in the [mod configuration](/mod-docs/mods/suite/Essentials/Configuration). ## Command Nodes @@ -48,7 +48,7 @@ Run `/ftbranks reload` after making changes to this file, and check your server ## Warmups and Cooldowns -See [warm-ups and cool-downs](/docs/mods/suite/Essentials/Warmups_Cooldowns) for general information. +See [warm-ups and cool-downs](/mod-docs/mods/suite/Essentials/Warmups_Cooldowns) for general information. Several teleport-related commands allow their default warmup and cooldown to be overridden by FTB Ranks. To check which commands support this, see the `serverconfig/ftbessentials.snbt` configuration file; look for comments mentioning `You can override this with FTB Ranks`. diff --git a/docs/mods/suite/Essentials/Warmups_Cooldowns.md b/mod-docs/suite/Essentials/Warmups_Cooldowns.md similarity index 80% rename from docs/mods/suite/Essentials/Warmups_Cooldowns.md rename to mod-docs/suite/Essentials/Warmups_Cooldowns.md index c361fc2d..712f17c2 100644 --- a/docs/mods/suite/Essentials/Warmups_Cooldowns.md +++ b/mod-docs/suite/Essentials/Warmups_Cooldowns.md @@ -10,7 +10,7 @@ Command _warmups_ enforce a delay between the player entering a command, and the Command _cooldowns_ enforce a delay between subsequent runs of a command, on a per-player basis. Most teleport-related commands have a default cooldown of 10 seconds, with the exception of `/back` (30 seconds), and `/rtp` (600 seconds). -These values can be changed in the [configuration file](/docs/mods/suite/Essentials/Configuration). E.g. to give the `/home` command a 5-second cooldown and a 5-second warmup time: +These values can be changed in the [configuration file](/mod-docs/mods/suite/Essentials/Configuration). E.g. to give the `/home` command a 5-second cooldown and a 5-second warmup time: ``` # Allows users to set 'homes', which they can then freely teleport to by using /home afterwards @@ -38,4 +38,4 @@ home: { } ``` -Note that default cooldowns can be overridden by [FTB Ranks](/docs/mods/suite/Essentials/Ranks_Integration#warmups-and-cooldowns), as the comments suggest. +Note that default cooldowns can be overridden by [FTB Ranks](/mod-docs/mods/suite/Essentials/Ranks_Integration#warmups-and-cooldowns), as the comments suggest. diff --git a/docs/mods/suite/Essentials/index.md b/mod-docs/suite/Essentials/index.md similarity index 80% rename from docs/mods/suite/Essentials/index.md rename to mod-docs/suite/Essentials/index.md index 27a6379b..9d8ab5d5 100644 --- a/docs/mods/suite/Essentials/index.md +++ b/mod-docs/suite/Essentials/index.md @@ -8,7 +8,7 @@ sidebar_position: 3 FTB Essentials is a server-side mod which adds a large collection of useful and convenient commands, both for players and server admins. -All commands can be individually disabled in the [mod configuration](/docs/mods/suite/Essentials/Configuration), and the [FTB Ranks mod](/docs/mods/suite/Essentials/Ranks_Integration) can optionally be used for more fine-grained access to commands and features. +All commands can be individually disabled in the [mod configuration](/mod-docs/mods/suite/Essentials/Configuration), and the [FTB Ranks mod](/mod-docs/mods/suite/Essentials/Ranks_Integration) can optionally be used for more fine-grained access to commands and features. ## Namespacing diff --git a/docs/mods/suite/Library/index.md b/mod-docs/suite/Library/index.md similarity index 97% rename from docs/mods/suite/Library/index.md rename to mod-docs/suite/Library/index.md index f44ef485..313ee0a1 100644 --- a/docs/mods/suite/Library/index.md +++ b/mod-docs/suite/Library/index.md @@ -11,7 +11,7 @@ FTB Library is one of our core mods / library mod that is a collection of common ## Features -- `SNBT`, our custom string based NBT format that is used by our config system and by most of our storage solutions for mod data. See [SNBT](/docs/mods/technical/SNBT/) for more information. +- `SNBT`, our custom string based NBT format that is used by our config system and by most of our storage solutions for mod data. See [SNBT](/mod-docs/mods/technical/SNBT/) for more information. - `Custom UI` system that is used to create GUI's in all of our mods - `Sidebar System` that is used to dynamically create sidebar icons for quick access for the user. This can do an array of different things, primarily run commands, open GUI's, or open a URL. - `Config system` that is used to create and manage config files for mods. This system is used by all of our mods to create and manage their config files. diff --git a/docs/mods/suite/Quests/Developer/Chapters/Settings.md b/mod-docs/suite/Quests/Developer/Chapters/Settings.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Chapters/Settings.md rename to mod-docs/suite/Quests/Developer/Chapters/Settings.md diff --git a/docs/mods/suite/Quests/Developer/Chapters/index.md b/mod-docs/suite/Quests/Developer/Chapters/index.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Chapters/index.md rename to mod-docs/suite/Quests/Developer/Chapters/index.md diff --git a/docs/mods/suite/Quests/Developer/Commands/index.md b/mod-docs/suite/Quests/Developer/Commands/index.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Commands/index.md rename to mod-docs/suite/Quests/Developer/Commands/index.md diff --git a/docs/mods/suite/Quests/Developer/Integrations/index.md b/mod-docs/suite/Quests/Developer/Integrations/index.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Integrations/index.md rename to mod-docs/suite/Quests/Developer/Integrations/index.md diff --git a/docs/mods/suite/Quests/Developer/Integrations/kube-js.md b/mod-docs/suite/Quests/Developer/Integrations/kube-js.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Integrations/kube-js.md rename to mod-docs/suite/Quests/Developer/Integrations/kube-js.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Reward_Tables.md b/mod-docs/suite/Quests/Developer/Quests/Reward_Tables.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Reward_Tables.md rename to mod-docs/suite/Quests/Developer/Quests/Reward_Tables.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Command_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Command_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Command_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Command_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Item_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Item_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Item_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Item_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Random_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Random_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Random_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Random_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Rewards/index.md b/mod-docs/suite/Quests/Developer/Quests/Rewards/index.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Rewards/index.md rename to mod-docs/suite/Quests/Developer/Quests/Rewards/index.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Settings.md b/mod-docs/suite/Quests/Developer/Quests/Settings.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Settings.md rename to mod-docs/suite/Quests/Developer/Quests/Settings.md diff --git a/docs/mods/suite/Quests/Developer/Quests/Types.md b/mod-docs/suite/Quests/Developer/Quests/Types.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/Types.md rename to mod-docs/suite/Quests/Developer/Quests/Types.md diff --git a/docs/mods/suite/Quests/Developer/Quests/index.md b/mod-docs/suite/Quests/Developer/Quests/index.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Quests/index.md rename to mod-docs/suite/Quests/Developer/Quests/index.md diff --git a/docs/mods/suite/Quests/Developer/Styling/index.md b/mod-docs/suite/Quests/Developer/Styling/index.md similarity index 100% rename from docs/mods/suite/Quests/Developer/Styling/index.md rename to mod-docs/suite/Quests/Developer/Styling/index.md diff --git a/docs/mods/suite/Quests/Player/Questbook/Navigating.md b/mod-docs/suite/Quests/Player/Questbook/Navigating.md similarity index 100% rename from docs/mods/suite/Quests/Player/Questbook/Navigating.md rename to mod-docs/suite/Quests/Player/Questbook/Navigating.md diff --git a/docs/mods/suite/Quests/Player/Questbook/Opening.md b/mod-docs/suite/Quests/Player/Questbook/Opening.md similarity index 100% rename from docs/mods/suite/Quests/Player/Questbook/Opening.md rename to mod-docs/suite/Quests/Player/Questbook/Opening.md diff --git a/docs/mods/suite/Quests/Player/Questbook/Tips_Tricks.md b/mod-docs/suite/Quests/Player/Questbook/Tips_Tricks.md similarity index 100% rename from docs/mods/suite/Quests/Player/Questbook/Tips_Tricks.md rename to mod-docs/suite/Quests/Player/Questbook/Tips_Tricks.md diff --git a/docs/mods/suite/Quests/index.md b/mod-docs/suite/Quests/index.md similarity index 100% rename from docs/mods/suite/Quests/index.md rename to mod-docs/suite/Quests/index.md diff --git a/docs/mods/suite/Ranks/API.md b/mod-docs/suite/Ranks/API.md similarity index 100% rename from docs/mods/suite/Ranks/API.md rename to mod-docs/suite/Ranks/API.md diff --git a/docs/mods/suite/Ranks/Advanced Conditions.md b/mod-docs/suite/Ranks/Advanced Conditions.md similarity index 100% rename from docs/mods/suite/Ranks/Advanced Conditions.md rename to mod-docs/suite/Ranks/Advanced Conditions.md diff --git a/mod-docs/suite/Ranks/Commands.md b/mod-docs/suite/Ranks/Commands.md new file mode 100644 index 00000000..88ae51d5 --- /dev/null +++ b/mod-docs/suite/Ranks/Commands.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 4 +--- + +All FTB Ranks commands start with `/ftbranks`. The following commands are defined: + +| Command | Op Required | Description | +| ---- | ---- | ---- | +| `/ftbranks reload` | Y | Reloads the `ranks.snbt` and `players.snbt` files. Check your server log for errors! | +| `/ftbranks refresh_readme` | Y | Regenerates the `serverconfig/ftbranks/README.txt` file. This file lists all known command nodes, determined from the commands which have been registered on this server. You should run this command after adding/removing any mods to/from your instance. | +| `/ftbranks list_all_ranks` | Y | Lists all the ranks currently defined in `ranks.snbt`. Those ranks listed in **cyan** have no condition attached, and must be explicitly added to a player via `/ftbranks add ..` | +| `/ftbranks create ` | Y | Creates a rank named `` with the given `` level. The new rank will have no condition attached, or other custom nodes added to it. | +| `/ftbranks delete ` | Y | Deletes the rank named ``. Take care: this operation can't be undone! | +| `/ftbranks add ` | Y | Adds the given `` to the given ``. Entity selectors can be used to add multiple players. | +| `/ftbranks remove ` | Y | Removes the given `` from the given ``. Entity selectors can be used to remove multiple players. | +| `/ftbranks list_ranks_of ` | Y | List all the ranks that the given `` currently has. | +| `/ftbranks list_players_with ` | Y | Lists all the players who currently have the given ``. | +| `/ftbranks node ` | Y | Adds or removes the given node to/from the given ``. | +| `/ftbranks condition ` | Y | Sets the condition for the given ranks. [Simple conditions](Simple Conditions.md) just need a condition name here, but [advanced conditions](Advanced Conditions.md) require a code block. A condition can be removed by specifying the empty string. See below for examples. | +| `/ftbranks show_rank ` | Y | Dumps the configuration information for the given `` | + +### Adding conditions + +Example command to set a simple condition on the `Near Spawn` rank: + +``` +/ftbranks condition "Near Spawn" spawn +``` + +Example command to set an advanced condition on the `Veteran` rank (player has walked at least 500000 cm and been playing for at least 3 weeks): + +``` +/ftbranks condition Veteran { type: "and", conditions: [ { type: "stat", stat: "minecraft:walk_one_cm", value: 500000, value_check: ">=" }, { type: "playtime", time: 3, time_unit: "weeks" } ] } +``` + +Example command to clear the condition from the `VIP` rank (after this, players can only have the `VIP` rank by direct assignment via `/ftbranks add ...`): + +``` +/ftbranks condition VIP "" +``` diff --git a/mod-docs/suite/Ranks/Configuration.md b/mod-docs/suite/Ranks/Configuration.md new file mode 100644 index 00000000..42cd46cc --- /dev/null +++ b/mod-docs/suite/Ranks/Configuration.md @@ -0,0 +1,104 @@ +--- +sidebar_position: 1 +--- +FTB Ranks is configured via two SNBT files, which can be found in `/serverconfig/ftbranks/` + +* `ranks.snbt` defines the ranks for the mod, along with the membership conditions for each rank, and the permissions granted by each rank. This file can be edited manually, and reloaded with `/ftbranks reload`. Many operations can also be carried out by commands, and where possible it is suggested to use commands rather than direct config file editing. See [Commands](Commands.md) for more information. +* `players.snbt` lists the players which have been explicitly added to ranks. While this file can also be edited manually, it is suggested to use the `/ftbranks add ` and `/ftbranks remove ` commands. + +:::warning +If you manually edit either file, check your server config for reported syntax errors! If errors are detected, the previous ranks configuration will remain in force. +::: + +
+An example ranks.snbt file + +```json +{ + member: { + name: "Member" + power: 1 + condition: "always_active" + ftbranks.name_format: "<{name}>" + ftbchunks.max_claimed: 40 + ftbchunks.max_force_loaded: 10 + } + vip: { + name: "VIP" + power: 50 + ftbranks.name_format: "<&bVIP {name}&r>" + ftbchunks.max_force_loaded: 15 + } + admin: { + name: "Admin" + power: 1000 + condition: "op" + command.ftbranks: true + ftbchunks.max_claimed: 100 + ftbchunks.max_force_loaded: 50 + } + alien: { + name: "Alien" + power: 100 + condition: { + type: "not" + condition: { + type: "dimension" + dimension: "minecraft:overworld" + } + } + command: false + command.say: true + command.msg: true + } + senior: { + name: "Senior" + power: 100 + ftbranks.name_format: "<&2Senior {name}&r>" + condition: { + type: "playtime" + time: 3 + time_unit: "weeks" + } + ftbchunks.max_claimed: 500 + } +} +``` +
+ +In the above .snbt file there are 5 total _ranks_ (the first three are added by default). Ranks may also be referred to as _roles_; the terms are interchangeable. + +
+An example players.snbt file + +```json +{ + 380df991-f603-344c-a090-369bad2a924a: { + name: "Dev" + ranks: { + vip: "2024-01-24T09:31:18.960345288Z" + } + } +} + +``` +
+ +In the above .snbt file one player ("Dev") has been added to the "VIP" rank (the timestamp shows when the player was added to the rank). Note that players are always keyed by UUID, not player name. The player name appears here only for clarity. + +## Rank Nodes + +Every rank contains a collection of _nodes_; this is basically just a key-value store. Nodes are fairly free-form, but it's suggested to stick to alphanumeric characters, along with `.` + +Some nodes have special meaning to FTB Ranks itself: `name`, `power` and `condition` and any node starting with `command.` + +All other nodes have a mod-specific meaning; it is up to that mod to determine how the node is used. E.g. FTB Chunks defines some nodes which control how many chunks and player can claim and/or force-load. + +| Name | Description | +| ---- | ---- | +| `name` | A human-readable name assigned to the role, for documentation and display purposes. This is freeform text, but should be kept brief, since it can be configured to appear with a player's name in chat. | +| `power` | Determines which rank has the highest priority; if more than one rank applies to the player, and those ranks have conflicting values for permission nodes, then the rank with the higher power level takes precedence.

This also applies to the rank's `name`; e.g. if a player only has the `member` rank, their name would be "Member". If they have only `vip`, their name would be "VIP". If they have both ranks, their name would be "VIP" as `vip`'s power level (50) is higher than `member`'s' (1). | +| `condition` | The rank condition determines whether a rank should be applied to a `player`. If no condition is specified for a rank, then players must be explicitly added to the rank via [command](Commands.md). Simple conditions can be applied by just a simple string; see [Simple Conditions](Simple Conditions.md) and [Advanced Conditions](Advanced Conditions.md) for more information.
In the example above, `member` and `admin` have simple conditions, `VIP` has no condition (so must be manually assigned to players), and `alien` and `senior` have advanced conditions.| +| Mod-specific nodes | Any other node which contains a `.` is one used by a particular mod. `ftbranks.name_format` is an example discussed below, and nodes added by FTB Chunks are also present in the above example. | +| `ftbranks.name_format` | This is a _mod-specific_ node, added by FTB Ranks itself. The name format determines how the player's name will look like in-game, in chat messages. You can use the [Minecraft wiki](https://minecraft.wiki/w/Talk:Formatting_codes) to see more about text formatting. Alternatively, you can use [this online tool](https://codepen.io/0biwan/pen/ggVemP) to customize your desired text. | +| Command nodes | Any node which starts with `command.` is a _command node_. These nodes configure a rank's access to that command (which could be a vanilla command, or one added by any mod), and can be used to allow access to admin-level commands that the player doesn't normally have access to. E.g. adding `command.give: true` to a rank would allow players who have that rank to use the `/give` command even if they are not server ops.
This can also be used to take away commands; in the example above, players in the "Alien" rank can't use any commands other than `/say` and `/msg`.
A list of all known command nodes can be found in `serverconfig/ftbranks/README.txt` (see also the `/ftbranks refresh_readme` [command](Commands.md)) | diff --git a/docs/mods/suite/Ranks/Integration/FTB Essentials.md b/mod-docs/suite/Ranks/Integration/FTB Essentials.md similarity index 66% rename from docs/mods/suite/Ranks/Integration/FTB Essentials.md rename to mod-docs/suite/Ranks/Integration/FTB Essentials.md index f599a287..83ffbdb8 100644 --- a/docs/mods/suite/Ranks/Integration/FTB Essentials.md +++ b/mod-docs/suite/Ranks/Integration/FTB Essentials.md @@ -1,7 +1,7 @@ FTB Essentials adds several commands with configurable warmup and cooldown delays; these delays can be overridden with FTB Ranks permission nodes. -See [the Essentials documentation page](/docs/mods/suite/Essentials/Ranks_Integration#warmups-and-cooldowns) for more details. +See [the Essentials documentation page](/mod-docs/mods/suite/Essentials/Ranks_Integration#warmups-and-cooldowns) for more details. :::info Note that FTB Essentials / FTB Ranks integration does not require FTB XMod Compat to be present. diff --git a/docs/mods/suite/Ranks/Integration/FTB XMod Compat.md b/mod-docs/suite/Ranks/Integration/FTB XMod Compat.md similarity index 100% rename from docs/mods/suite/Ranks/Integration/FTB XMod Compat.md rename to mod-docs/suite/Ranks/Integration/FTB XMod Compat.md diff --git a/docs/mods/suite/Ranks/Simple Conditions.md b/mod-docs/suite/Ranks/Simple Conditions.md similarity index 100% rename from docs/mods/suite/Ranks/Simple Conditions.md rename to mod-docs/suite/Ranks/Simple Conditions.md diff --git a/mod-docs/suite/Ranks/index.md b/mod-docs/suite/Ranks/index.md new file mode 100644 index 00000000..a88a3546 --- /dev/null +++ b/mod-docs/suite/Ranks/index.md @@ -0,0 +1,36 @@ +--- +date: 2024-01-17 +title: Ranks +description: FTB Ranks is a server-side mod for permission management. +tags: + - introduction +sidebar_position: 4 +--- + +# FTB Ranks + +FTB Ranks is a server-side mod which defines the concept of _ranks_ or _roles_; these are basically permission groups which one or more players may belong to, and which have one or more permission _nodes_. + +This provides a powerful system to control what players may do on a server, based on the their rank membership; FTB Ranks can provide access to commands that are normally only available to server ops, and can also deny access to commands that regular players normally have. + +In addition, other mods may use FTB Ranks to define their own nodes and the behaviour for those nodes (e.g. FTB Chunks defines nodes which control the number of chunks a player may claim or force-load, overriding the default values for players with specific ranks). + +## Nodes + +Ranks contain a collection of _nodes_, which are basically just a set of key/value pairs. Nodes can be of the following types: +* String +* Numeric (both integer and double) +* Boolean (all command nodes are boolean) + +Mods can use the [FTB Ranks API](API) to query the value of nodes and operate accordingly. +:::tip +It is strongly advised to prefix mod-specific node names with the mod id, e.g. `ftbchunks.max_claimed`, to avoid clashes! +::: + +## Conditions + +Each rank may have a _condition_, which determines whether or not the rank should apply to a given player (in other words, whether the player should be implicitly a member of that rank). Conditions are documented in [Simple Conditions](Simple Conditions.md) and [Advanced Conditions](Advanced Conditions.md). + +:::info +Ranks which do not have a condition must be explicitly granted to players, using the `/ftbranks add` command. +::: diff --git a/docs/mods/suite/Team_Bases/commands.md b/mod-docs/suite/Team_Bases/commands.md similarity index 100% rename from docs/mods/suite/Team_Bases/commands.md rename to mod-docs/suite/Team_Bases/commands.md diff --git a/docs/mods/suite/Team_Bases/config.md b/mod-docs/suite/Team_Bases/config.md similarity index 100% rename from docs/mods/suite/Team_Bases/config.md rename to mod-docs/suite/Team_Bases/config.md diff --git a/docs/mods/suite/Team_Bases/getting_started.md b/mod-docs/suite/Team_Bases/getting_started.md similarity index 100% rename from docs/mods/suite/Team_Bases/getting_started.md rename to mod-docs/suite/Team_Bases/getting_started.md diff --git a/docs/mods/suite/Team_Bases/index.md b/mod-docs/suite/Team_Bases/index.md similarity index 100% rename from docs/mods/suite/Team_Bases/index.md rename to mod-docs/suite/Team_Bases/index.md diff --git a/docs/mods/suite/Teams/index.md b/mod-docs/suite/Teams/index.md similarity index 94% rename from docs/mods/suite/Teams/index.md rename to mod-docs/suite/Teams/index.md index 59ed9d51..e7344163 100644 --- a/docs/mods/suite/Teams/index.md +++ b/mod-docs/suite/Teams/index.md @@ -55,4 +55,4 @@ command.ftbteams.party.invite command.ftbteams.party.leave ``` -It is also possible to override the Teams behavior via API. For example, [FTB Team Bases](/docs/mods/suite/Team_Bases) used in FTB Oceanblock 2 does this to manage the creation of teams and their base. +It is also possible to override the Teams behavior via API. For example, [FTB Team Bases](/mod-docs/mods/suite/Team_Bases) used in FTB Oceanblock 2 does this to manage the creation of teams and their base. diff --git a/docs/mods/suite/Ultimine/api.md b/mod-docs/suite/Ultimine/api.md similarity index 100% rename from docs/mods/suite/Ultimine/api.md rename to mod-docs/suite/Ultimine/api.md diff --git a/docs/mods/suite/Ultimine/index.md b/mod-docs/suite/Ultimine/index.md similarity index 92% rename from docs/mods/suite/Ultimine/index.md rename to mod-docs/suite/Ultimine/index.md index b02163d3..e58fc327 100644 --- a/docs/mods/suite/Ultimine/index.md +++ b/mod-docs/suite/Ultimine/index.md @@ -20,7 +20,7 @@ FTB Ultimine is our take on a vein miner like mod. It allows you to mine blocks ## Commands -See [In-game Config Screen](/docs/mods/technical/Config-Screen) for more information about the in-game config screen. +See [In-game Config Screen](/mod-docs/mods/technical/Config-Screen) for more information about the in-game config screen. | Command | Description | Requires OP | | --- | --- | --- | @@ -33,4 +33,4 @@ These config screens can also be accessed from the standard FTB sidebar: ## Mining Shapes -We support a variety of different mining shapes that can be switched on the fly in-game. To read more about these options, see [Mining Shapes](/docs/mods/suite/Ultimine/shapes). +We support a variety of different mining shapes that can be switched on the fly in-game. To read more about these options, see [Mining Shapes](/mod-docs/mods/suite/Ultimine/shapes). diff --git a/docs/mods/suite/Ultimine/ranks-integration.md b/mod-docs/suite/Ultimine/ranks-integration.md similarity index 100% rename from docs/mods/suite/Ultimine/ranks-integration.md rename to mod-docs/suite/Ultimine/ranks-integration.md diff --git a/docs/mods/suite/Ultimine/shapes.md b/mod-docs/suite/Ultimine/shapes.md similarity index 100% rename from docs/mods/suite/Ultimine/shapes.md rename to mod-docs/suite/Ultimine/shapes.md diff --git a/docs/mods/suite/Ultimine/tags.md b/mod-docs/suite/Ultimine/tags.md similarity index 100% rename from docs/mods/suite/Ultimine/tags.md rename to mod-docs/suite/Ultimine/tags.md diff --git a/docs/mods/suite/XMod/index.md b/mod-docs/suite/XMod/index.md similarity index 100% rename from docs/mods/suite/XMod/index.md rename to mod-docs/suite/XMod/index.md diff --git a/docs/mods/suite/index.md b/mod-docs/suite/index.md similarity index 100% rename from docs/mods/suite/index.md rename to mod-docs/suite/index.md diff --git a/docs/mods/technical/Config-Screen.md b/mod-docs/technical/Config-Screen.md similarity index 100% rename from docs/mods/technical/Config-Screen.md rename to mod-docs/technical/Config-Screen.md diff --git a/docs/mods/technical/SNBT/index.md b/mod-docs/technical/SNBT/index.md similarity index 100% rename from docs/mods/technical/SNBT/index.md rename to mod-docs/technical/SNBT/index.md diff --git a/docs/mods/technical/index.md b/mod-docs/technical/index.md similarity index 79% rename from docs/mods/technical/index.md rename to mod-docs/technical/index.md index c6e975dc..530414cd 100644 --- a/docs/mods/technical/index.md +++ b/mod-docs/technical/index.md @@ -6,5 +6,5 @@ In this section you will find documentation on the more technical aspects of our ## Technical Documentation -- [Config Screen](/docs/mods/technical/Config-Screen) -- [SNBT](/docs/mods/technical/SNBT) \ No newline at end of file +- [Config Screen](/mod-docs/mods/technical/Config-Screen) +- [SNBT](/mod-docs/mods/technical/SNBT) diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-config-screen-example.png b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-config-screen-example.png new file mode 100644 index 00000000..cde774cd Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-config-screen-example.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-library-nbt-editor.png b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-library-nbt-editor.png new file mode 100644 index 00000000..c500fc85 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-library-nbt-editor.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-library-sidebar-buttons.png b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-library-sidebar-buttons.png new file mode 100644 index 00000000..c9eb8c58 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-library-sidebar-buttons.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-teams-example-gui.png b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-teams-example-gui.png new file mode 100644 index 00000000..8bee5a5a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-teams-example-gui.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-ultimine-shapeless-example.png b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-ultimine-shapeless-example.png new file mode 100644 index 00000000..e8af42d1 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/ftb-ultimine-shapeless-example.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-client-config.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-client-config.webp new file mode 100644 index 00000000..e6fd9b24 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-client-config.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-config-select.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-config-select.webp new file mode 100644 index 00000000..82bdba82 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-config-select.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-server-config.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-server-config.webp new file mode 100644 index 00000000..a536ba26 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/backups3/backups-3-server-config.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-claiming.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-claiming.webp new file mode 100644 index 00000000..276ad14b Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-claiming.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-config-modal.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-config-modal.webp new file mode 100644 index 00000000..d28ee390 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-config-modal.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-in-game-config-buttons.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-in-game-config-buttons.webp new file mode 100644 index 00000000..98ce98d6 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-in-game-config-buttons.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-loading.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-loading.webp new file mode 100644 index 00000000..4aa5306f Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-loading.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-minimap-info-button.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-minimap-info-button.webp new file mode 100644 index 00000000..38fc0066 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-minimap-info-button.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-minimap-info.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-minimap-info.png new file mode 100644 index 00000000..39c3c124 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-minimap-info.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-unclaim.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-unclaim.webp new file mode 100644 index 00000000..eeed9d79 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-unclaim.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-unload.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-unload.webp new file mode 100644 index 00000000..08192879 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/chunks/chunks-unload.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-rightclick.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-rightclick.webp new file mode 100644 index 00000000..9e9cd7d6 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-rightclick.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-settings.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-settings.webp new file mode 100644 index 00000000..79ae704e Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-settings.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-sidebar-min.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-sidebar-min.webp new file mode 100644 index 00000000..f6bc8619 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-sidebar-min.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-sidebar-pin.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-sidebar-pin.webp new file mode 100644 index 00000000..d01b0d4f Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/chapter-sidebar-pin.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/claim-all-rewards.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/claim-all-rewards.webp new file mode 100644 index 00000000..24901723 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/claim-all-rewards.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/claim-rewards.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/claim-rewards.webp new file mode 100644 index 00000000..b7b95ee5 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/claim-rewards.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/create-a-quest.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/create-a-quest.webp new file mode 100644 index 00000000..80fc684a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/create-a-quest.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/creating-a-chapter.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/creating-a-chapter.webp new file mode 100644 index 00000000..25886efd Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/creating-a-chapter.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/empty-questbook.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/empty-questbook.webp new file mode 100644 index 00000000..53b89f39 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/empty-questbook.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/key-reference.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/key-reference.webp new file mode 100644 index 00000000..8c3c76f6 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/key-reference.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/moving-around-quests.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/moving-around-quests.webp new file mode 100644 index 00000000..58506427 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/moving-around-quests.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/opening-a-quest.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/opening-a-quest.webp new file mode 100644 index 00000000..e39255d8 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/opening-a-quest.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/opening-questbook-inv.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/opening-questbook-inv.webp new file mode 100644 index 00000000..19785195 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/opening-questbook-inv.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/pinning-a-quest.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/pinning-a-quest.webp new file mode 100644 index 00000000..daec8b3b Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/pinning-a-quest.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-add-reward.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-add-reward.webp new file mode 100644 index 00000000..24a8f5f1 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-add-reward.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-add-task.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-add-task.webp new file mode 100644 index 00000000..b9548854 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-add-task.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-convert-to-tag-filter.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-convert-to-tag-filter.webp new file mode 100644 index 00000000..f6c7acc5 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-convert-to-tag-filter.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-notification-1.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-notification-1.png new file mode 100644 index 00000000..280934b5 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-notification-1.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-notification-2.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-notification-2.webp new file mode 100644 index 00000000..cf91db60 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-notification-2.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-unclaimed.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-unclaimed.webp new file mode 100644 index 00000000..3c5b23a7 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/quest-unclaimed.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-chapters.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-chapters.webp new file mode 100644 index 00000000..20b88dd0 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-chapters.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-buttons.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-buttons.webp new file mode 100644 index 00000000..265890f4 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-buttons.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-dropdown.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-dropdown.webp new file mode 100644 index 00000000..cc7db278 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-dropdown.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-hidden.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-hidden.png new file mode 100644 index 00000000..54d8d23d Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-hidden.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-upstream.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-upstream.webp new file mode 100644 index 00000000..d2204884 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-dependency-upstream.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-item.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-item.webp new file mode 100644 index 00000000..e732ecb8 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-item.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-linked-quest.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-linked-quest.png new file mode 100644 index 00000000..4a3f965e Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-linked-quest.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-unclaimed.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-unclaimed.webp new file mode 100644 index 00000000..87c56346 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/questbook-unclaimed.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/accept.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/accept.png new file mode 100644 index 00000000..5eebf3d3 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/accept.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/advancement-isnt-iron-pick.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/advancement-isnt-iron-pick.png new file mode 100644 index 00000000..055b80f0 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/advancement-isnt-iron-pick.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/advancement-screen-iron-pick.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/advancement-screen-iron-pick.png new file mode 100644 index 00000000..2c8b184b Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/advancement-screen-iron-pick.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/all-table-reward.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/all-table-reward.webp new file mode 100644 index 00000000..e6127a2f Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/all-table-reward.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/choice-reward.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/choice-reward.webp new file mode 100644 index 00000000..5fb29b16 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/choice-reward.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-claim-quest.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-claim-quest.webp new file mode 100644 index 00000000..fe501af4 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-claim-quest.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-dummy-quest.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-dummy-quest.png new file mode 100644 index 00000000..dd838835 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-dummy-quest.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-woodcutting.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-woodcutting.webp new file mode 100644 index 00000000..7eb42cc4 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/command-woodcutting.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-claim-reward.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-claim-reward.webp new file mode 100644 index 00000000..aa950f64 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-claim-reward.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-copy-id.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-copy-id.webp new file mode 100644 index 00000000..8691b4fa Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-copy-id.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-lv-forty-three.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-lv-forty-three.png new file mode 100644 index 00000000..a3d5b518 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-lv-forty-three.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-quest-complete.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-quest-complete.webp new file mode 100644 index 00000000..ac5d935a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-quest-complete.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-receive-diamond.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-receive-diamond.webp new file mode 100644 index 00000000..f46f4350 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-receive-diamond.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-reward-creation.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-reward-creation.webp new file mode 100644 index 00000000..c24ac456 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/custom-reward-creation.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/edit_reward_tables.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/edit_reward_tables.webp new file mode 100644 index 00000000..7b391b39 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/edit_reward_tables.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-fluid-tank.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-fluid-tank.png new file mode 100644 index 00000000..48b5e056 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-fluid-tank.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-inventory-mode.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-inventory-mode.webp new file mode 100644 index 00000000..b911b4b4 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-inventory-mode.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-list-mode.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-list-mode.png new file mode 100644 index 00000000..b5e93b03 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-list-mode.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-two-axe.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-two-axe.webp new file mode 100644 index 00000000..93f31817 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/item-reward-two-axe.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-common.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-common.png new file mode 100644 index 00000000..7b19e341 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-common.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-epic.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-epic.png new file mode 100644 index 00000000..f0b0afad Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-epic.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-id.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-id.png new file mode 100644 index 00000000..30d9c544 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-id.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-igneous-rocks.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-igneous-rocks.png new file mode 100644 index 00000000..ea49bc32 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-igneous-rocks.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-legendary.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-legendary.webp new file mode 100644 index 00000000..d1ebdb83 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-legendary.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-rare.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-rare.png new file mode 100644 index 00000000..91b4e2b5 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-rare.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-reach-config.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-reach-config.webp new file mode 100644 index 00000000..09ce6224 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-reach-config.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-silverfish.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-silverfish.png new file mode 100644 index 00000000..78a87275 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-silverfish.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-uncommon.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-uncommon.png new file mode 100644 index 00000000..77e2ecca Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-crate-uncommon.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-reward-golden-apple.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-reward-golden-apple.png new file mode 100644 index 00000000..c9e6f7b0 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-reward-golden-apple.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-reward-preview.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-reward-preview.png new file mode 100644 index 00000000..a1ae1598 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/loot-reward-preview.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-add-common.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-add-common.webp new file mode 100644 index 00000000..68fe6acf Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-add-common.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-all-five.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-all-five.webp new file mode 100644 index 00000000..6bb52d17 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-all-five.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-five-crates-inv.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-five-crates-inv.webp new file mode 100644 index 00000000..a53488a3 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-five-crates-inv.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-five-types.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-five-types.png new file mode 100644 index 00000000..65157c80 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-five-types.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-loot-reward.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-loot-reward.webp new file mode 100644 index 00000000..ffc9aea3 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-loot-reward.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-parent.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-parent.png new file mode 100644 index 00000000..fbdb4c6a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-parent.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-rename-loot-crate.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-rename-loot-crate.png new file mode 100644 index 00000000..6987c7df Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/nesting-rename-loot-crate.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/random-reward.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/random-reward.png new file mode 100644 index 00000000..b189a3bf Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/random-reward.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/settings-cog.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/settings-cog.png new file mode 100644 index 00000000..1884fbfc Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/settings-cog.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stage-visited-nether.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stage-visited-nether.webp new file mode 100644 index 00000000..c537fea7 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stage-visited-nether.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-custom-pcb-task.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-custom-pcb-task.webp new file mode 100644 index 00000000..c0ad0e1a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-custom-pcb-task.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-ftblib-nbtedit.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-ftblib-nbtedit.png new file mode 100644 index 00000000..048c97d5 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-ftblib-nbtedit.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-got-diamonds.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-got-diamonds.webp new file mode 100644 index 00000000..37eaf629 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-got-diamonds.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-zoom-tags.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-zoom-tags.png new file mode 100644 index 00000000..1d922626 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/stages-zoom-tags.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-disable-popup.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-disable-popup.png new file mode 100644 index 00000000..d474745b Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-disable-popup.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-quest.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-quest.webp new file mode 100644 index 00000000..ce8223ed Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-quest.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-reward.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-reward.webp new file mode 100644 index 00000000..be89cb51 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-reward.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-title-desc.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-title-desc.png new file mode 100644 index 00000000..7fe3bed5 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-edit-title-desc.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-example-quest.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-example-quest.png new file mode 100644 index 00000000..fba26e82 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-example-quest.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-show-up.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-show-up.webp new file mode 100644 index 00000000..fcad4f7f Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/toast-show-up.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/xp-levels.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/xp-levels.webp new file mode 100644 index 00000000..c9c229d1 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/xp-levels.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/xp-points.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/xp-points.webp new file mode 100644 index 00000000..133dc23a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/rewards/xp-points.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/viewing-a-task.webp b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/viewing-a-task.webp new file mode 100644 index 00000000..4aea7b7a Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/quests/viewing-a-task.webp differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/ultimine/ultimine-sidebar.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/ultimine/ultimine-sidebar.png new file mode 100644 index 00000000..b66a9875 Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/ultimine/ultimine-sidebar.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/_assets/images/ultimine/ultimine-status-panel.png b/mods_versioned_docs/version-1.21.1/mods/_assets/images/ultimine/ultimine-status-panel.png new file mode 100644 index 00000000..e343397c Binary files /dev/null and b/mods_versioned_docs/version-1.21.1/mods/_assets/images/ultimine/ultimine-status-panel.png differ diff --git a/mods_versioned_docs/version-1.21.1/mods/others/index.md b/mods_versioned_docs/version-1.21.1/mods/others/index.md new file mode 100644 index 00000000..44f8cb75 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/others/index.md @@ -0,0 +1,16 @@ +--- +title: Other FTB Mods +sidebar_position: 2 +--- + +:::caution +Our documentation for FTB Mods is still under active development. +::: + +We make quite a few mods for our modpacks, some modpacks have more custom mods than others but we do not consider our one off mods as part of our core suite of mods. This means, although we will continue to fix bugs and try and keep them stable, we won't necessarily be adding new features to them, nor porting them to newer versions of Minecraft. + +:::info +More information about our core suite of mods can be found [here](/mod-docs/mods/suite). + +For now, please refer to our Mods github repository for more information on our other mods. +::: diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Backups-2/config.md b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-2/config.md new file mode 100644 index 00000000..87ae4c8e --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-2/config.md @@ -0,0 +1,56 @@ +--- +title: Configuring +description: How to configure FTB Backups 2. +tags: + - FTB Suite + - FTB Mods + - Backups 2 +sidebar_position: 1 +--- + +FTB Backups 2 can be configured by opening the `ftbbackups2.json` located in the config folder of the modpack. + +## Configuration options + +| Name | Description | Default value | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| `auto` | Allow the creation of backups automatically | `true` | +| `command_permission_level` | Permission level to use the /backup command (0-4) | `3` | +| `notify_op_only` | Only send backup status to server ops | `true` | +| `do_not_notify` | Don't send backup status at all | `false` | +| `retention_mode` | Backup retention mode. Valid Modes:
  • `MAX_BACKUPS`
  • `TIERED`
Note: TIERED mode is an experimental and unsupported feature, Use at your own risk. | `MAX_BACKUPS` | +| `max_backups` | Sets the maximum number of backups to keep, only applies when `retention_mode` is set to `MAX_BACKUPS` | `5` | +| `keep_latest` | The latest x number of backups will be retained, only applies when `retention_mode` is set to `TIERED` | `5` | +| `keep_hourly` | Sets number of hourly backups to keep, only applies when `retention_mode` is set to `TIERED` | `1` | +| `keep_daily` | Sets number of daily backups to keep, only applies when `retention_mode` is set to `TIERED` | `1` | +| `keep_weekly` | Sets number of weekly backups to keep, only applies when `retention_mode` is set to `TIERED` | `1` | +| `keep_monthly` | Sets number of monthly backups to keep, only applies when `retention_mode` is set to `TIERED` | `1` | +| `backup_cron` | How frequently backups should be taken, this uses the Quartz cron format, for more information go [here](#cron-examples) | `0 */30 * * * ?` | +| `manual_backups_time` | Time between manual backups using the command, prevents spamming the backup command | `0` | +| `only_if_players_been_online` | Only run a backup if a player has been online since the last backup | `true` | +| `additional_directories` | Additional folder/directories to include in backup | `[]` | +| `additional_files` | Additional files and directories to include in backup. Can specify a file name, path relative to server directory or wildcard file path
Examples: - All file paths are relative to server root)
fileName.txt - Any/all file named "fileName.txt"
folder/file.txt - Exact file path
folder/ - Everything in this folder
path/starts/with* - Any files who's path starts with
*path/ends/with.txt - Any files who's path ends with
\*path/contains\* - Any files who's path contains | `[]` | +| `display_file_size` | Displays the backup file size in the backup message | `false` | +| `backup_location` | Where the backup folder containing the backups should be located, relative to the server | `.` | +| `backup_format` | Specify the backup format. Valid options are ZIP and DIRECTORY | `ZIP` | +| `minimum_free_space` | Minimum free disk space in MB. If a backup's creation would leave less than this amount of disk space remaining, the backup will be aborted. | `500` | +| `free_space_if_needed` | If the previous backup failed due to lack of space, the oldest backup will be deleted to free space. | `false` | +| `excluded` | Specify files or folders to be excluded. Can specify a file name, path relative to server directory or wildcard file path
Examples: - All file paths are relative to server root)
fileName.txt - Any/all file named "fileName.txt"
folder/file.txt - Exact file path
folder/ - Everything in this folder
path/starts/with* - Any files who's path starts with
*path/ends/with.txt - Any files who's path ends with
\*path/contains\* - Any files who's path contains | `[]` | +| `preview_dimension` | The dimension used when creating backup preview image, specify "all" to enable automatic detection of primary dimension (can be very slow)
Specify "none" to disable preview | `minecraft:overworld` | + +## Cron examples + +The cron format used is the Quartz cron format, you can find more information and examples here: https://www.quartz-scheduler.net/documentation/quartz-3.x/tutorial/crontrigger.html#examples + +The format is as follows: +``` +s i h dom m dow y +⎜ ⎜ ⎜ ⎜ ⎜ ⎜ ⎜ +'--+--+--+--+--+--+--> 1st: seconds + '--+--+--+--+--+--> 2nd: minutes + '--+--+--+--+--> 3rd: hours + '--+--+--+--> 4th: days of month ---\ + '--+--+--> 5th: months | mutually exclusive + '--+--> 6th: days of week ---/ + '--> 7th: years +``` diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Backups-2/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-2/index.md new file mode 100644 index 00000000..599460a7 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-2/index.md @@ -0,0 +1,46 @@ +--- +title: Backups 2 +description: FTB Backups 2 is a mod that creates backups of your world +tags: + - FTB Suite + - FTB Mods + - Backups 2 +sidebar_position: 7 +--- + +:::warning +⚠ LTS Notice! + +FTB Backups (2) is only available for Minecraft versions 1.18 -> 1.21.5 and is now on LTS. We will continue to bug fix the mod but no new features will be accepted in. + +For Minecraft 1.21.1+ please use [FTB Backups 3](../Backups-3). +::: + +[![Backups 2](https://cf.way2muchnoise.eu/title/622737.svg)](https://www.curseforge.com/minecraft/mc-mods/ftb-backups-2) ![Backups 2 Versions](https://cf.way2muchnoise.eu/versions/622737.svg) + + +# Features + +- Silent backups, messages only printed to operators or print to everyone +- Configurable amount of backups you can keep +- Backup only if a player has been online and data has been saved +- Configurable timer, uses cron notation to give you in-depth control of backup times +- Backup metadata stored in json file, allowing development of feature rich backup management GUI's +- Add additional directories to the backup +- Automatically select best compression level for backup +- Ensures enough disk space exists for a new backup, protecting you from running out of disk while making a backup and corrupting your world + +## Commands + +- `/backup start` - Create a backup now +- `/backup snapshot` - Create a protected backup now, not affected by the max backups setting + +## Restoring a Backup + +1. Stop and close your client/server +2. Rename the current world folder to something else (e.g. `world_old`) +3. Navigate to the `backups` folder in your server directory + - This folder may be different if you have configured a custom backup folder in the `ftbbackups2.json` config file +4. Extract the backup you want to restore, the backup files are named by the date and time they were created, so you can easily find the one you want `YYYY-MM-DD-HH-MM-SS` +5. Copy the extracted world folder into the saves folder or server directory if you are on a server and rename it to `world` (or whatever your singleplayer world was named/server is configured to use) +6. Start your client/server and enjoy your restored world! diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/config.mdx b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/config.mdx new file mode 100644 index 00000000..74b70668 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/config.mdx @@ -0,0 +1,57 @@ +--- +title: Configuring +description: How to configure FTB Backups 3. +tags: + - FTB Suite + - FTB Mods + - Backups 3 +sidebar_position: 2 +--- +import clientConfigScreen from '../../_assets/images/backups3/backups-3-client-config.webp'; +import serverConfigScreen from '../../_assets/images/backups3/backups-3-server-config.webp'; +import configSelector from '../../_assets/images/backups3/backups-3-config-select.webp'; +import {Slideshow} from '@site/src/components/SlideShow/Slideshow'; + +FTB Backups 3 can be configured either in-game by opening the FTB Backups 3 menu from the inventory screen or by editing the `ftbbackups3-server.toml` located in the config folder. + +## In-game configuration + +To open the FTB Backups 3 config menu, open your inventory then in the top left corner click on the save icon ( 💾 it looks like a floppy disk). This will open the FTB Backups 3 menu where you can configure the client and server settings for FTB Backups 3. + + + +### Server configuration + +The server configuration allows you to set the following options: + +| Name | Description | Default value | +|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| Command alias
`add_backup_command_alias` | Enables/Disables the `/backup` alias for the `/ftbbackups3` command | true | +| Archival plugin
`archival_plugin` | The archival method used to create the backup, Options are `ftbbackups3:zip` or `ftbbackups3:filecopy` more methods can be added through other mods (Docs on this coming soon) | ftbbackups3:zip | +| Automatic backups
`auto` | Enables/Disables automatic creation of backups | true | +| Backup folder
`folder` | Absolute path to backups folder. Default of "" means to use "ftbackups3" within the game instance folder. | "" | +| Backup timer
`backup_timer` | Backup frequency in minutes. Minimum value: `1`, maximum value: `43800` | 120 | +| Backups to keep
`backups_to_keep` | Number of backups to keep, More backups = more space used. Minimum value:`0`, maximum value: `32000` | 12 | +| Compression level
`compression_level` | Compression level for archived files. Note that this is dependent on the particular plugin in use. Higher values typically mean backups take longer to do but take less space on disk. Minimum value: `0`, maximum value: `9` | 5 | +| Display file size
`display_file_size` | Broadcasts to all online players a "(current size \| total size)" message when backup is done. | true | +| Extra files
`extra_files` | Add extra files/folders to be backed up, in addition to the world folder. These files *must* be within the game instance! Example of extra files that add configs, logs and the ops.json to the backup 
extra_files: [
"config/"
"logs"
"ops.json"
]
| [] | +| Force backup on shutdown
`force_on_shutdown` | Create a backup when server is stopped. | false | +| Maximum total size
`max_total_size` | Maximum total size that is allowed in backups folder. Older backups will be deleted to free space for newer ones. MB and GB can be used | 50 GB | +| Notify admins only
`notify_admins_only` | If true, only player with permission level >= 2 (or SSP integrated server owners) will be notified on-screen about backup progress | false | +| Only if players online
`only_if_players_online` | Only create backups when at least one player is online. | true | +| Run silently
`silent` | If set to true, no messages will be displayed in chat/status bar | false | + +### Client configuration + +The client configuration allows you to set the following options: + +| Name | Description | +|----------------------------|------------------------------------------------| +| Progress panel position | Sets the location of the backup progress panel | +| Progress panel x inset | X offset for the progress panel | +| Progress panel y inset | Y offset for the progress panel | +| Show backup progress panel | Enables/Disables the progress panel | diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/index.md new file mode 100644 index 00000000..fd403d5a --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/index.md @@ -0,0 +1,29 @@ +--- +title: Backups 3 +description: FTB Backups 3 is a mod that creates backups of your world which can be restored at any time if something goes wrong. +tags: + - FTB Suite + - FTB Mods + - Backups 3 +sidebar_position: 6 +--- + +:::info +FTB Backups 3 is required on both the client and server. +::: + +FTB Backups 3 is available on CurseForge + +[![Backups 3](https://cf.way2muchnoise.eu/title/1294188_Get_Today!.svg)](https://www.curseforge.com/minecraft/mc-mods/ftb-backups-3) ![Backups 3 Versions](https://cf.way2muchnoise.eu/versions/1294188.svg) + +Our simple but powerful backups solution for Minecraft 1.21.1+! + +### Features + +- In-game progress display of backups (configurable to just admins, all players, or not at all) +- Command triggered backups +- Simple, user friendly time config for specify how often to backup +- In-game backup restore & delete functionality (singleplayer only) +- Plugin system built-in for developers to add alternative backup methods (ZIP by default) + + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/restoring.mdx b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/restoring.mdx new file mode 100644 index 00000000..2c92524d --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Backups-3/restoring.mdx @@ -0,0 +1,40 @@ +--- +title: Restoring a Backup +description: How to restore a backup in FTB Backups 3. +tags: +- FTB Suite +- FTB Mods +- Backups 3 +sidebar_position: 1 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +So something went wrong and you need to restore a backup? No problem! FTB Backups 3 makes it easy to restore your world. + + + + If you are playing in singleplayer, you can restore a backup by using the in-game menu and following these steps: + + 1. Go to the Singleplayer menu + 2. Click on the `Restore World...` button in the top right corner next to the world search bar + 3. Select the backup you want to restore from the list + 4. Click the `Restore` button + + Now you can load your world and continue playing as if nothing happened! + + + On a server you will need to manually restore a backup by following these steps: + + 1. Stop the server if it's running + 2. Rename the current world folder to something else (e.g. `world_old`) + 3. Navigate to the `ftbbackups3` folder in your server directory + - This folder may be different if you have configured a custom backup folder in the `ftbbackups3-server.snbt` config file + 4. Extract the backup you want to restore, the backup files are named by the date and time they were created, so you can easily find the one you want `YYYY-MM-DD-HH-MM-SS` + 5. Copy the extracted world folder into the server directory and rename it to `world` (or whatever your server is configured to use) + 6. Start the server again + + Now you can join the server and continue playing as if nothing happened! + + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/claiming-loading.md b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/claiming-loading.md new file mode 100644 index 00000000..13601d95 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/claiming-loading.md @@ -0,0 +1,37 @@ +--- +title: Claiming & Loading Chunks +sidebar_position: 1 +--- + +## Chunk Claiming Reference + +You can view an in-game guide on how to claim and load chunks by opening your inventory and clicking on the blue tinted map icon. + +With the chunk map open a blue `i` icon will be shown in the upper left corner of the screen. Clicking on this icon will open the chunk claiming and loading guide. + +## Claiming Chunks + +Open up your inventory and click on the blue tinted map icon. This will open up the chunk map where you can see the surrounding chunks. + +To claim a chunk, simply click on the chunk you want to claim. You can also claim multiple chunks by clicking and dragging your mouse over the chunks you want to claim. + +![Claiming Chunks](../../_assets/images/chunks/chunks-claiming.webp) + +## Unclaiming Chunks + +Unclaiming chunks is just as easy as claiming them. Open up the chunk map and right-click on the chunk you want to unclaim. You can also unclaim multiple chunks by right-clicking and dragging your mouse over the chunks you want to unclaim. + +![Unclaiming Chunks](../../_assets/images/chunks/chunks-unclaim.webp) + +## Chunk loading + +Chunk loading is nearly identical to how you would claim or unclaim chunks. Open up the chunk map and shift click on the chunk you want to load. You can also load multiple chunks by holding shift and clicking and dragging your mouse over the chunks you want to load. + +You will see green lines appear on the chunk that have been chunk loaded. + +![Chunk Loading](../../_assets/images/chunks/chunks-loading.webp) + +## Unloading Chunks +Unloading chunks is just as easy as loading them. Open up the chunk map and shift right-click on the chunk you want to unload. You can also unload multiple chunks by holding shift and right-clicking and dragging your mouse over the chunks you want to unload. + +![Unloading Chunks](../../_assets/images/chunks/chunks-unload.webp) diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/commands.md b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/commands.md new file mode 100644 index 00000000..c755d192 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/commands.md @@ -0,0 +1,35 @@ +--- +title: Commands +sidebar_position: 3 +--- + +## Key + +- `< >` - Required argument. + - This means you must provide an argument for the command to work. +- `[ ]` - Optional argument. + - This means you can provide an argument for the command to work, but it is not required. + +## Commands +| Command | Op Required | Description | +|---------------------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------| +| `/ftbchunks block_color` | N | Gets the colour of the block you are looking at | +| `/ftbchunks claim [radius in blocks]` | N | Claim the chunk you are standing in, you can also pass in a radius | +| `/ftbchunks info [ ] [dimension]` | N | View the claim status of the chunk you are standing in or the one specified | +| `/ftbchunks load [radius in blocks]` | N | Load the claimed chunk(s) you are standing in | +| `/ftbchunks unclaim [radius in blocks]` | N | Unclaim the chunk you are standing in, you can pass in a radius in blocks to unclaim neighbouring chunks | +| `/ftbchunks unclaim_all` | N | Unclaim all chunks you have claimed | +| `/ftbchunks waypoint ` | N | Add a waypoint | + +## Admin Commands + +| Command | Op Required | Description | +|------------------------------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------| +| `/ftbchunks admin bypass_protection` | Y | Allows an admin to bypass a claimed chunk and interact with everything in the chunk. | +| `/ftbchunks admin claim_as [radius in blocks] [anchor(x y z)]` | Y | Claim a chunk as a specified team and optionally specify a radius and anchor point for the radius | +| `/ftbchunks admin extra_claim_chunks ` | Y | This command allows an admin to set, add or view any extra number of claims a team/player can claim | +| `/ftbchunks admin extra_force_load_chunks ` | Y | This command allows an admin to set, add or view any extra number of force loaded chunks a team/player can set | +| `/ftbchunks admin unclaim_as [radius in blocks] [anchor(x y z)]` | Y | Unclaim a claimed area as a given user | +| `/ftbchunks admin unclaim_everything` | Y | Unclaim every claimed chunk in the world | +| `/ftbchunks admin unload_everything` | Y | Unload every force loaded chunk in the world | +| `/ftbchunks admin view_loaded_chunks [dimension]` | Y | This command show all loaded chunks in the map | diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/config.md b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/config.md new file mode 100644 index 00000000..6995f5a1 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/config.md @@ -0,0 +1,25 @@ +--- +title: Configuring +description: Configuring FTB Chunks +sidebar_position: 4 +--- + +## Overview + +FTB Chunks comes with 2 configuration files, one for the server and one for the client. Both files are located in the config folder of your Minecraft instance `/config/ftbchunks-(client/server).snbt` + +These 2 config files can be overridden on modpack updates so it also possible to locally overwrite these configs by making a copy `ftbchunks-client.snbt` to `/local/ftbchunks-client.snbt` and for the client and for the server copy `ftbchunks-world.snbt` to `/world/serverconfig/ftbchunks-world.snbt` + +The config file is heavily-commented, so each individual subsection will not be documented here. + +## Editing the config + +It's possible to edit the config for both client and server in-game by opening the FTB Chunks map (M by default) then to edit the client config click on the gear icon in the bottom left corner of the map, and to edit the server config click on the purple gear icon in the bottom right corner of the map. + +This will open a GUI where you can edit the config values, to get a description of the config value hover over the config value and a tooltip will show up with a description of the config value. After you have edited the config values click on the Accept button in the bottom right corner of the GUI to save the config values. + +![Editing the config in-game](../../_assets/images/chunks/chunks-in-game-config-buttons.webp) + +![Editing the config in-game](../../_assets/images/chunks/chunks-config-modal.webp) + +If you prefer to edit the config files manually you can do so by opening the config files in a text editor. The config files are in a SNBT format, which is a human-readable format that is easy to edit and located in the folders mentioned above diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/index.md new file mode 100644 index 00000000..5c4b6810 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/index.md @@ -0,0 +1,32 @@ +--- +title: Chunks +description: FTB Chunks allows for mapping, claiming, and protecting chunks. +tags: + - FTB Suite + - FTB Mods +sidebar_position: 1 +--- + +## What is FTB Chunks? + +FTB Chunks is a mod that allows players to claim chunks to protect their blocks/builds/resources from other players, FTB Chunks also comes with the ability to keep chunks loaded when the player is not online, allowing machines to run and resources to be farmed even when the player is offline, it also comes with a mini map and a large fullscreen map. + +Features: +- Claim chunks to protect your builds + - Integrates with FTB Teams + - Allow players in your team to access/build in your claimed chunks + - Ally with other players/teams to allow them to access/build in your claimed chunks +- Keep chunks loaded when you are not online (configurable) +- Mini map and fullscreen map + - Create waypoints + - Death points + - Teleport to waypoints (admin only) +- FTB XMod Compat compatibility + - Allows you to have KubeJS, FTB Ranks / Luckperms, Waystones, Game Stages integration with FTB Chunks. + +## Guides +- [Claiming & loading chunks](./claiming-loading.md) +- [Maps & Waypoints](./maps-waypoints.md) +- [Command list](./commands.md) +- [Configuring FTB Chunks](./config.md) + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/maps-waypoints.md b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/maps-waypoints.md new file mode 100644 index 00000000..efd6a61b --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Chunks/maps-waypoints.md @@ -0,0 +1,50 @@ +--- +title: Maps & Waypoints +sidebar_position: 2 +--- + +## Overview +FTB Chunks comes with a mini map and a fullscreen map that allows you to see the world around you, it also allows you to create waypoints to mark locations in the world, and teleport to them. + +The mini map is enabled by default and can be expanded to the fullscreen map by pressing M by default, a keyboard/mouse reference can be seen by clicking on the blue `i` icon while on the fullscreen map. + +## Minimap + +### Configuring the mini map +The mini map can be configured by clicking on the gear icon in the bottom left corner of the fullscreen map, this will open a GUI where you can configure the mini map settings. +For a guide on finding the in game config see [Configuring FTB Chunks](./config.md#editing-the-config). + +All the minimap settings will be in its own section in the config GUI, for a description of what each setting does hover over the setting and a tooltip will show up with a description of the setting. + +### Minimap display info +Extra information can be displayed under the minimap by clicking on the Minimap Info Settings when on the fullscreen map, this will open a GUI where you can configure the minimap info settings. + +![Minimap display info settings](../../_assets/images/chunks/chunks-minimap-info-button.webp) + +This allows you to display extra information under the minimap, such as the current biome, coordinates, current time of day and FPS + +![Minimap display info](../../_assets/images/chunks/chunks-minimap-info.png) + +## Waypoints + +Waypoints are markers that can be placed on the map to mark locations in the world, they can be used to mark important locations such as bases, spawn points, and more. + +### Creating waypoints + +To create a waypoint, open the fullscreen map by pressing M, then right click where you want the waypoint to be on the map and click the Add Waypoint button that shows up. This will open a GUI where you can enter the name of the waypoint, choose a color for it, what dimension the waypoint is for and edit its coordinates. + +Once you are happy with the waypoint click the Accept button + +### Death points + +Death points are automatically created when you die in the world, they are used to mark the location of your death so you can find your way back to your items. Death points can be managed in the same way as waypoints. + +### Managing waypoints + +#### Editing waypoints + +To edit a waypoint, open the fullscreen map by pressing M, then you can edit the waypoint by either finding the waypoint on the map and right-clicking it then selecting edit or by clicking on the waypoint manager button then right clicking the waypoint in the list and selecting edit. This will open a GUI where you can edit the name, color, dimension and coordinates of the waypoint. + +#### Removing waypoints + +Removing waypoints is similar to editing them, open the fullscreen map by pressing M, then you can remove the waypoint by either finding the waypoint on the map and right-clicking it then selecting remove or by clicking on the waypoint manager button then clicking on the trashcan next to the waypoint in the list. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Commands.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Commands.md new file mode 100644 index 00000000..7d8b6a86 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Commands.md @@ -0,0 +1,137 @@ +--- +title: Commands +--- + +## Key + +- `< >` - Required argument. + - This means you must provide an argument for the command to work. +- `[ ]` - Optional argument. + - This means you can provide an argument for the command to work, but it is not required. + +## Homes + +__Homes__ are player-specific saved teleport destinations. Players may have one or more saved locations, depending on server and (if installed) [FTB Ranks](/mod-docs/mods/suite/Essentials/Ranks_Integration) configuration. + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/home [home]` | N | Takes you to either your default home or the specified home. | +|`/sethome ` | N | Adds a new home to your homes list, subject to your player homes limit. | +|`/delhome [home]` | N | Deletes your default home or the specified home. | +|`/listhomes` | N | Lists all of your homes. | + +## Teleporting + +### TPA + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/tpa ` | N | Sends a teleport request to the specified player. If they accept the request, you will be teleported to the player. | +|`/tpahere ` | N | Sends a teleport request to the specified player to teleport to you. If they accept the request, they will be teleported to you. | +|`/tpaccept ` | N | Accepts a teleport request (rarely needed as you can just click the **Accept** link in the message you receive). | +|`/tpdeny ` | N | Denies a teleport request (rarely needed as you can just click the **Deny** link in the message you receive). | + +### Misc + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/back` | N | Teleports you to the last location where you used any command that teleports you (including vanilla `/tp` command). Note that Essentials maintains a teleport history "stack", so this can be used multiple times to go to progressively older teleport points. | +|`/spawn` | N | Teleports you to the server spawn. | +|`/rtp` | N | Takes you to a random location in the world with a configured bounds. | +|`/teleport_last ` | Y | Teleports you to the last known location of the specified player (even if they're currently offline). | +|`/tpx ` | Y | Teleports you to another dimension at your current location. | +|`/jump` | Y | Teleports you to the block you're looking at (more precisely, to the top of the block column you're looking at). | + +## Warps + +__Warps__ are server-wide saved teleport destinations, common to all players. + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/warp` | N | Teleports you to the warp specified. (Names will be suggested) | +|`/setwarp ` | Y | Creates a new warp at your current location.| +|`/delwarp ` | Y | Deletes the warp specified.| +|`/listwarps` | N | Lists all of the warps on the server.| + +## Cheats / Admin + +All of these commands require `OP` to function + +| Command |Description | +| ----------- | --------- | +|`/heal [player]` | Fully heals you or the specified player, as well as replenishing food, and extinguishing any flames.| +|`/feed [player]` | Fully feeds you or the specified player.| +|`/extinguish [player]` | Puts your or the specified player out if they're on fire.| +|`/fly [player]` | Toggles creative flight for you or the specified player.| +|`/speed [boost_percent] [player]` | When no `boost_percent` is provided, this command will display your (or the specified player's) movement speed modifier. With the `boost_percent` provided, your (or the specified player's) movement speed will be increased by the `boost_percent` (this uses a standard vanilla [attribute modifier](https://minecraft.fandom.com/wiki/Attribute)). `Min: -100`, `Max: 2000`| +|`/god [player]` | Enables God mode (Invulnerability) for you or the specified player.| +|`/invsee ` | Opens the specified players inventory, allowing you to view and modify the inventory's contents.| +|`/nicknamefor ` | Forces a nickname on a specific player.| +|`/mute [until]` | Mutes a player for a specified amount of time (`until`) or forever. The `until` is a duration time; omitting it mutes the player indefinitely. See [Duration](/mod-docs/mods/suite/Essentials/Durations) for more information. Example: `/mute Slowpoke101 2h` mutes the player `Slowpoke101` for two hours.| +|`/unmute ` | Unmutes the specified player.| + +### Offline Teleport + +_[New in Essentials 1.20.1+]_ Teleports a player to a given location when they're offline. If you wish to teleport a player to a different dimension too, use the standard vanilla `execute in` method. E.g. `/execute in minecraft:the_nether run tp_offline name someplayer 0 70 0` teleports the player to (0, 70, 0) in the Nether. All `/tp_offline` commands require `OP` permissions to use. + +| Command |Description | +| ----------- | --------- | +|`/tp_offline name ` | Teleport player using player name.| +|`/tp_offline id ` | Teleport player using player UUID.| + +## Kits + +Kits are a relatively new feature to Essentials and have more in-depth documentation on the [Kits](/mod-docs/mods/suite/Essentials/Kits) page. All `/kit` commands require `OP` permissions to use. + +| Command |Description | +| ----------- | --------- | +|`/kit list` | Lists all of the kits available on the server.| +|`/kit show ` | Shows you the contents of the specified kit.| +|`/kit give ` | Gives the specified player the specified kit.| + +### Management + +| Command |Description | +| ----------- | --------- | +|`/kit delete ` | Deletes the specified kit.| +|`/kit create_from_player_inv [cooldown]` | Creates a kit from the current player's inventory contents, with an optional cooldown [duration](/mod-docs/mods/suite/Essentials/Durations).| +|`/kit create_from_player_hotbar [cooldown]` | Creates a kit from the current players hotbar contents, with an optional cooldown [duration](/mod-docs/mods/suite/Essentials/Durations).| +|`/kit create_from_block_inv [cooldown]` | Creates a kit from the inventory contents of the block you're looking at, with an optional cooldown [duration](/mod-docs/mods/suite/Essentials/Durations).| + +### Helper commands + +| Command |Description | +| ----------- | --------- | +|`/kit cooldown ` | Modifies the cooldown of the kit specified.| +|`/kit reset_cooldown ` | Resets the cooldown of the kit specified. The player can be identified by either their UUID or their in-game name.| +|`/kit set_autogrant ` | Sets the autogrant status of the kit specified.| +|`/kit put_in_block_inv ` | Puts the kit specified into the block you're looking at's inventory. | + +## Miscellaneous + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/kickme` | N | Kicks you from the server| +|`/leaderboard [leaderboard]` | N | Shows the current data for a specific leaderboard in the game (The command auto completes the leaderboard name)| +|`/nickname [nickname]` | N | Allows you to modify your in-game name| +|`/hat` | N | Forces the item held in your main hand onto your head, and your current head item into your main hand.| +|`/near [radius]` | Y | Shows the distance of other players around you| +|`/near [radius]` | Y |Shows the distance of a specific player from you| + +### Inventories + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/trashcan` | N | Opens a virtual inventory that will void any items put into it.| +|`/enderchest [player]` | Y | Opens another player's enderchest inventory.| +|`/open anvil` | Y | Opens the Anvil's GUI.| +|`/open smithing` | Y | Opens the Smithing Table's GUI.| +|`/open crafting` | Y | Opens the Crafting Table's GUI.| +|`/open stonecutter` | Y | Opens the Stonecutter's GUI.| + +### Notifying + +| Command |Op Required| Description | +| ----------- | --------- | ------------ | +|`/recording` | N | Marks your player in the `Tab` screen as recording and adds a red icon to your name in chat.| +|`/streaming` | N | Marks your player in the `Tab` screen as streaming and adds a purple icon to your name in chat.| diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Configuration.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Configuration.md new file mode 100644 index 00000000..8bb5b9a7 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Configuration.md @@ -0,0 +1,55 @@ +--- +title: Configuration +--- + +## Overview + +The FTB Essentials configuration file can be found at `config/ftbessentials.snbt`. This contains a configuration section for every command added by the mod; every command can be disabled in the config file, and some commands have extra configuration. + +The config file is heavily-commented, so each individual subsection will not be documented here. + +The file is read at server startup, and cannot be reloaded when the server is running; a restart is required to load any changes made. + +### Examples + +An example of a command with a simple configuration: + +``` +# Allows users to access an Anvil GUI without needing an Anvil. +anvil: { + # Default: true + enabled: true +} +``` + +To remove the `/open anvil` command, just change `enabled` to `false`, and (if running) restart your server. + +A command with a more complex configuration: + +``` +# Allows users to set 'homes', which they can then freely teleport to by using /home afterwards +home: { + # Cooldown between /home commands (in seconds) + # You can override this with FTB Ranks using ftbessentials.home.cooldown + # Default: 10 + # Range: 0 ~ 604800 + cooldown: 10 + + # Default: true + enabled: true + + # Max amount of homes a user can have. + # You can override this with FTB Ranks using ftbessentials.home.max + # Default: 1 + # Range: 0 ~ 2147483647 + max: 1 + + # Warm-up time before /home command executes (in seconds) + # You can override this with FTB Ranks using ftbessentials.home.warmup + # Default: 0 + # Range: 0 ~ 604800 + warmup: 0 +} +``` + +The `/home` command can be disabled (as all commmands can), but in addition, the default [warmup and cooldown](/mod-docs/mods/suite/Essentials/Warmups_Cooldowns) can be changed, as well the default maximum number of homes that players can have. As per the comments, these defaults can be [overridden with FTB Ranks](/mod-docs/mods/suite/Essentials/Ranks_Integration). diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Durations.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Durations.md new file mode 100644 index 00000000..51df3e23 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Durations.md @@ -0,0 +1,16 @@ +--- +title: Durations +--- + +Durations are used in a number of places in FTB Essentials, such as muting players, and are a shorthand way of specifying a time period. + +- `1s` - 1 second +- `1m` - 1 minute +- `1h` - 1 hour +- `1d` - 1 day +- `1w` - 1 week +- `*` - Forever + +## Examples + +`/mute Slowpoke101 2h` would mute the player `Slowpoke101` for `2 hours` diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Kits.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Kits.md new file mode 100644 index 00000000..9894042f --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Kits.md @@ -0,0 +1,129 @@ +--- +title: Kits +--- + +## Overview + +**Kits** are configured collections of items, along with an optional cooldown, which can be given to players. By default, all kit commands require admin permissions to use, so they are typically intended for use with solutions like Command Blocks, which run commands with admin permissions. + +Kit names (shown as `` in many of the examples below) are alphanumeric strings, with the `_` and `-` characters also permitted. + +## Creating Kits + +There are three similar ways of creating a new kit: + +### From the contents of a block + +Place the items you want in the kit (ensuring item counts are correct) into a Chest or similar inventory, then while looking at the block, type: + +`/kit create_from_block_inv ` + +Note that the command does take sided inventories into account (not important for chests, but might be for some other blocks). + +### From your player inventory + +Have all of the kit items anywhere in your inventory, and type: + +`/kit create_from_player_inv ` + +This will create a kit from all of the items in your inventory. + +### From your hotbar + +Have all of the kit items anywhere in your hotbar, and type: + +`/kit create_from_player_hotbar ` + +This will create a kit from just the items on your hotbar. This could be convenient if you're creating two or more kits, and want to be able to shuffle the right items around in your inventory. + +## Giving Kits + +To give a kit to one or more players, run: + +`/kit give ` + +Multiple players can be specified here, and the standard vanilla selectors work, e.g. + +`/kit give somekitname @a` + +would give `somekitname` to all players on the server. + +You can also put the contents of the kit into a chest or other inventory. To do this, look at the chest and type: + +`/kit put_in_block_inv ` + +You should ensure there's enough space in the inventory for the kit contents; if there isn't then you may get a partial kit (Forge), or no items at all (Fabric). + +### Giving to Yourself + +To conveniently give a kit to yourself, you can use: + +`/give_me_kit ` + +This is basically just a synonym for `/kit give @s ` with one important advantage: it also checks for the permission node `ftbessentials.give_me_kit.`. This allows for fine-grained control over which kits regular players can grant themselves. + +See [here](Ranks_Integration#kits) for more information. + +## Managing Kits + +### Viewing + +You can see a list of the known kits with: + +`/kit list` + +You can view the contents of a kit (along with cooldowns and other information) with: + +`/kit show ` + +Note that the kits listed by `/kit list` can also be clicked to run the `/kit show ...` command, as a convenience. + +### Deleting + +You can delete a kit with: + +`/kit delete ` + +There is no confirmation for this action, so take care. + +## Cooldowns + +Kits can optionally be created with a _cooldown_, which is how frequently kits can be given to players. Cooldowns are per-player. Cooldown syntax is pretty simple; a number followed by one of `s`, `m`, `h`, `d` or `w` to indicate seconds, minutes, hours, days or weeks, respectively. One special cooldown is `*`, which means "forever"; this can be used for kits which can only be given once per player. + +Example of creating a kit with a cooldown: + +`/kit create_from_block_inv kit1 3h` + +creates a kit which can be given to players not more often than every 3 hours. + +The cooldown of an existing kit can easily be modified later, if needed: + +`/kit cooldown ` + +### Resetting Cooldowns + +It is possible to reset the current kit cooldown for a kit, to allow players to immediately receive a kit again: + +`/kit reset_cooldown ` + +resets the cooldown of a kit for _all_ players (including offline players); + +`/kit reset_cooldown ` + +resets the cooldown of a kit for the given (online) player only; + +`/kit reset_cooldown ` + +is an equivalent player-only command, but using the player UUID allows the cooldown to be reset for an offline player, if necessary. + +### Autogranting + +Kits can be configured to be _auto-granted_; such kits are given to players automatically on login, subject to normal cooldown requirements. + +The `*` (forever) cooldown is quite useful with such kits, since it then becomes a "starter" kit; given to the player the first time they log in, and never again. + +You can configure if a kit is auto-granted like this: + +`/kit set_autogrant ` + +(kits are not autogranted by default) diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Ranks_Integration.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Ranks_Integration.md new file mode 100644 index 00000000..cbdbf045 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Ranks_Integration.md @@ -0,0 +1,104 @@ +--- +title: Ranks Integration +--- + +## Overview + +FTB Essentials integrates with the FTB Ranks mod to provide the following additional configurability: + +* Commands which normally require OP permissions to run can be made available to players by giving them the corresponding command node permission. +* Commands which have configurable [warm-ups and cool-downs](/mod-docs/mods/suite/Essentials/Warmups_Cooldowns) can use FTB Ranks permission nodes to override the default warmup and cooldown times, as defined in the [mod configuration](/mod-docs/mods/suite/Essentials/Configuration). + +## Command Nodes + +Every Essentials command has a corresponding command node in FTB Ranks: the format of the node name is `command.` followed by the actual command name. E.g. the node for the `/heal` command is `command.heal`. + +Commands with sub-commands join the nodes with a `.`, e.g. `/kit delete` uses a format of `command.kit.delete`. + +### Example + +To allow players in the "vip" rank to use the `/heal` and `/kit list` commands, and give them a max of 4 homes (instead of the default 1): + +``` +/ftbranks node add vip command.heal true +/ftbranks node add vip command.kit.list true +/ftbranks node add vip ftbessentials.home.max 4 +``` + +This can also be used to block access to commands that can normally be run. E.g. to only allow players in the "vip" and "admin" ranks to view their ender inventory: + +``` +/ftbranks node add member command.enderchest false +/ftbranks node add vip command.enderchest true +/ftbranks node add admin command.enderchest true +``` + +If you prefer to edit config files directly (take care!), you can edit `serverconfig/ftbranks/ranks.snbt`, e.g. + +``` +vip: { + name: "VIP" + power: 50 + ftbranks.name_format: "&bVIP {name}" + command.heal: true +} +``` + +Run `/ftbranks reload` after making changes to this file, and check your server log for any parse errors. + +## Warmups and Cooldowns + +See [warm-ups and cool-downs](/mod-docs/mods/suite/Essentials/Warmups_Cooldowns) for general information. + +Several teleport-related commands allow their default warmup and cooldown to be overridden by FTB Ranks. To check which commands support this, see the `serverconfig/ftbessentials.snbt` configuration file; look for comments mentioning `You can override this with FTB Ranks`. + +### Example + +The `/home` command has a default cooldown of 10 seconds: + +``` +# Allows users to set 'homes', which they can then freely teleport to by using /home afterwards +home: { + # Cooldown between /home commands (in seconds) + # You can override this with FTB Ranks using ftbessentials.home.cooldown + # Default: 10 + # Range: 0 ~ 604800 + cooldown: 10 +... +``` + +As the comment in the config file suggests, this can be overridden with FTB Ranks. E.g. to give VIP players a shorter cooldown, and admin-level players no cooldown at all: + +``` +/ftbranks node add vip ftbessentials.home.cooldown 3 +/ftbranks node add admin ftbessentials.home.cooldown 0 +``` + +## Kits + +As also discussed in [kits](Kits#giving-to-yourself), it's possible to set up per-kit permission nodes to allow regular players to give themselves a controlled set of kits. Typically you would also configure those kits with some [cooldown](Kits#cooldowns) value. + +### Example + +To allow players to give themselves the `emergency_supplies` kit every 3 hours: + +* Put the supplies you need for the rank in a chest, then while looking at the chest: + +``` +/ftbessentials kit create_from_inventory emergency_supplies 3h +``` + +* Set up the Ranks permission node: + +``` +/ftbranks create resupply 100 +/ftbranks node add resupply ftbessentials.give_me_kit.emergency_supplies true +``` + +Now, any players added to the `resupply` rank will be able to run `/give_me_kit emergency_supplies` every 3 hours. + +:::note + +The power level for the rank - 100 here - isn't important unless you're planning to have another rank which configures the same permission node. + +::: diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Warmups_Cooldowns.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Warmups_Cooldowns.md new file mode 100644 index 00000000..712f17c2 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/Warmups_Cooldowns.md @@ -0,0 +1,41 @@ +--- +title: Warmups and Cooldowns +--- + +## Overview + +Several teleport-related commands in FTB Essentials support the concept of _warmups_ and _cooldowns_. + +Command _warmups_ enforce a delay between the player entering a command, and the command actually executing. If the player moves or takes damage during the warmup delay, command execution is cancelled. By default, no commands have a non-zero delay. + +Command _cooldowns_ enforce a delay between subsequent runs of a command, on a per-player basis. Most teleport-related commands have a default cooldown of 10 seconds, with the exception of `/back` (30 seconds), and `/rtp` (600 seconds). + +These values can be changed in the [configuration file](/mod-docs/mods/suite/Essentials/Configuration). E.g. to give the `/home` command a 5-second cooldown and a 5-second warmup time: + +``` +# Allows users to set 'homes', which they can then freely teleport to by using /home afterwards +home: { + # Cooldown between /home commands (in seconds) + # You can override this with FTB Ranks using ftbessentials.home.cooldown + # Default: 10 + # Range: 0 ~ 604800 + cooldown: 5 + + # Default: true + enabled: true + + # Max amount of homes a user can have. + # You can override this with FTB Ranks using ftbessentials.home.max + # Default: 1 + # Range: 0 ~ 2147483647 + max: 1 + + # Warm-up time before /home command executes (in seconds) + # You can override this with FTB Ranks using ftbessentials.home.warmup + # Default: 0 + # Range: 0 ~ 604800 + warmup: 5 +} +``` + +Note that default cooldowns can be overridden by [FTB Ranks](/mod-docs/mods/suite/Essentials/Ranks_Integration#warmups-and-cooldowns), as the comments suggest. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/index.md new file mode 100644 index 00000000..9d8ab5d5 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Essentials/index.md @@ -0,0 +1,17 @@ +--- +title: Essentials +description: FTB Essentials adds a variety of useful commands for players and server admins. +sidebar_position: 3 +--- + +## What is FTB Essentials? + +FTB Essentials is a server-side mod which adds a large collection of useful and convenient commands, both for players and server admins. + +All commands can be individually disabled in the [mod configuration](/mod-docs/mods/suite/Essentials/Configuration), and the [FTB Ranks mod](/mod-docs/mods/suite/Essentials/Ranks_Integration) can optionally be used for more fine-grained access to commands and features. + +## Namespacing + +As of Minecraft `1.20.4` all FTB Essentials commands can be optionally configured to use the `ftbessentials` namespace within the command. This means that, when enabled, all commands will be prefixed with `/ftbessentials` instead of `/`. Aka, `/home` would become `/ftbessentials home`. + +This is useful when multiple mods add commands with the same name, or if you want to keep all FTB Essentials commands together in the tab-complete list. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Library/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Library/index.md new file mode 100644 index 00000000..313ee0a1 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Library/index.md @@ -0,0 +1,45 @@ +--- +title: Library +description: FTB Library provides common code for UI, configs and utilities used by the rest of our mods. +tags: + - introduction +--- + +## What is FTB Library? + +FTB Library is one of our core mods / library mod that is a collection of common code, utilities, and features that are utilized across all of our mods. + +## Features + +- `SNBT`, our custom string based NBT format that is used by our config system and by most of our storage solutions for mod data. See [SNBT](/mod-docs/mods/technical/SNBT/) for more information. +- `Custom UI` system that is used to create GUI's in all of our mods +- `Sidebar System` that is used to dynamically create sidebar icons for quick access for the user. This can do an array of different things, primarily run commands, open GUI's, or open a URL. +- `Config system` that is used to create and manage config files for mods. This system is used by all of our mods to create and manage their config files. +- `Utility commands` such as `/ftblibrary rain`, `ftblibrary night`, etc. + +## Commands + +| Command | Description | +| --- | --- | +| `/ftblibrary gamemode` | Quick toggle between creative and survival | +| `/ftblibrary rain` | Toggle rain | +| `/ftblibrary day` | Set time to day | +| `/ftblibrary night` | Set time to night | +| `/ftblibrary clientconfig` | Opens the client config | +| `/ftblibrary nbtedit ` | Opens a rich NBT Editing GUI | + +## NBT Editor + +The NBT Editor is a powerful tool that allows you to edit NBT data in a user-friendly way. You can edit the NBT data of blocks, entities, items, and players. The NBT Editor is accessible in-game by running the `/ftblibrary nbtedit` command. + +![Screenshot of the NBT Editor in-game](../../_assets/ftb-library-nbt-editor.png) + +## Sidebar System + +The Sidebar System can be used to display a dynamic array of buttons on the inventory screen as shortcuts for the user. Many FTB Mods add one or more buttons to the sidebar by default. + +Players can edit the position and visibility of the buttons by right-clicking on one of them to enter edit mode. The sidebar can be disabled entirely in `/ftblibrary clientconfig` if desired. Modpack Creators can edit the default setup of the sidebar by editing `defaultconfig/ftblibrary-client.snbt`. + +![Screenshot of the Sidebar Buttons in-game](../../_assets/ftb-library-sidebar-buttons.png) + +Non-FTB Mods can add support for a sidebar button via a json asset file. The supported features are subject to change, but here are some references: [JSON Schema](https://github.com/FTBTeam/FTB-Library/blob/dev/common/src/main/java/dev/ftb/mods/ftblibrary/sidebar/SidebarButtonData.java#L26). [Click Event Translation](https://github.com/FTBTeam/FTB-Library/blob/dev/common/src/main/java/dev/ftb/mods/ftblibrary/util/client/ClientUtils.java#L67). [Example Button JSON](https://github.com/FTBTeam/FTB-Library/blob/dev/common/src/main/resources/assets/ftblibrary/sidebar_buttons/toggle/day.json) diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Chapters/Settings.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Chapters/Settings.md new file mode 100644 index 00000000..db921c8f --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Chapters/Settings.md @@ -0,0 +1,89 @@ +--- +title: Settings +--- + +The chapter settings screen allows you to change the chapter title, icon, and much more. A description of each setting can be read by hovering over the options. + +## Chapter + +### Disable Completion Toast + +Disables the completion toast for this chapter. This will prevent the toast from appearing when all quests in this chapter are completed. + +### Icon + +The icon that will be displayed next to the chapter title in the chapter list. The icons come from all the items in the modpack + +### Subtitle + +The subtitle will be displayed as a tooltip when you hover over the chapter title in the chapter list. + +### Tags + +Tags are used to help theme the quest book and also allow you to use them in KubeJS events. You can add multiple tags to a chapter. + +### Title + +The title of the chapter. This is what will be displayed in the chapter list. + +--- + +## Appearance + +### Default Min Opened Quest Window Width + +Default minimum width of the quest description window for quests in this chapter. This can be overridden on a per-quest basis. + +### Default Quest Shape + +Sets the default shape of a quest in this chapter. This can be overridden on a per-quest basis. + +### Default Quest Size + +Default quest object size in the quest book for this chapter. This can be overridden on a per-quest basis. + +--- + +## Visibility + +### Always Invisible + +Hides the chapter from the player, this can be useful if you want to hide certain quests. + +### Default 'Hide dependency lines' + +Hide the dependency lines for quests in this chapter by default. This can be overridden on a per-quest basis. + +### Hide quest details until startable + +Default option for hiding quest details until the quest is startable. This can be overridden on a per-quest basis. + +### Hide quests until dependencies visible + +Hide quests in this chapter until their dependencies are visible. This can be overridden on a per-quest basis. + +--- + +## Misc + +### Autofocus quest ID + +Automatically focuses the quest with the given ID when the chapter is opened. + +### Default 'Progression mode' + +Sets the default progression mode for quests in this chapter. This can be overridden on a per-quest basis. + +### Default 'Repeatable quest' + +Sets the default repeatable status for quests in this chapter. This can be overridden on a per-quest basis. + +### Default item task 'Consume items' + +Sets the default consume items status for item tasks in this chapter. This can be overridden on a per-quest basis. + +### Sequential task completion + +If enabled tasks in this chapter will need to be completed in order. + + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Chapters/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Chapters/index.md new file mode 100644 index 00000000..59770aef --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Chapters/index.md @@ -0,0 +1,26 @@ +--- +title: Creating Chapters +sidebar_position: 2 +--- + +## Creating Chapters + +To create a chapter, expand the sidebar on the left and click on the green `+` button, this will open a menu where you can either create a new chapter or chapter group. + +A chapter group is a way to organize your chapters into categories, for example, you could have a chapter group called "Introduction" and then have all of your introductory chapters inside that group. + +![Creating a chapter](../../../../_assets/images/quests/creating-a-chapter.webp) + +Once the chapter is created, you can right-click on it to open the chapter options menu where you can choose to move the chapter up or down and edit the chapter settings. + +![Chapter options menu](../../../../_assets/images/quests/chapter-rightclick.webp) + +## Editing Chapter Settings + +When you click on the edit button in the chapter options menu, you will be taken to the chapter settings screen where you can change the chapter title, icon and much more. + +A description of each setting can be read by hovering over the options + +![Chapter settings](../../../../_assets/images/quests/chapter-settings.webp) + +A full list of settings can be found on the [Chapter Settings](./Settings.md) page. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Commands/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Commands/index.md new file mode 100644 index 00000000..c9a593c5 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Commands/index.md @@ -0,0 +1,27 @@ +--- +title: Commands +sidebar_position: 1 +--- + +:::info Key + +- `< >` - Required argument. + - This means you must provide an argument for the command to work. +- `[ ]` - Optional argument. + - This means you can provide an argument for the command to work, but it is not required. +::: + +| Command | Description | +|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `/ftbquests open_book [quest ID]` | Opens the quest book (Optionally to a specific quest) | +| `/ftbquests block_rewards [true\|false] [player]` | Blocks the player from claiming rewards from quests | +| `/ftbquests change_progress ` | Mark a quest as completed or reset the progress on a quest for given player. | +| `/ftbquests change_progress ` | Reset or complete all quests for given player. | +| `/ftbquests clear_item_display_cache` | Forces the client to purge any cached items which are used for item filter display performance.

May be useful if a filter's been modified and matching items need to be recalculated. | +| `/ftbquests delete_empty_reward_tables` | Cleans up any empty rewards table | +| `/ftbquests editing_mode [true\|false] [player]` | Enable quest editing mode for a player | +| `/ftbquests export_reward_table_to_chest ` | Creates a chest containing all the item rewards for the given quest | +| `/ftbquests generate_chapter_with_all_items_in_game` | Create a quest chapter with every in game item | +| `/ftbquests import_reward_table_from_chest ` | Import the contents of a chest as a reward table | +| `/ftbquests locked [true\|false] [player]` | Stop a player from being able to open the quest book and complete quests | +| `/ftbquests reload` | Reloads FTB Quests config and quests | diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Integrations/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Integrations/index.md new file mode 100644 index 00000000..8b3f5236 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Integrations/index.md @@ -0,0 +1,20 @@ +--- +title: Integrations +draft: true +--- + +FTB Quests has a number of integrations with other mods. These integrations allow you to use the features of other mods in your quests. + +:::caution +WIP +::: + +FTB Filter system but that’s a mod that needs it’s own docs anyway. Basically, complex filters that allows authors to configure item checks via a GUI + +JEI, REI: Works with lib as well and shows a dedicated page on the item selection for JEI items, it also adds quest items as a reward section in the uses / recipe tabs, if a reward contains a loot create it will also show what items can drop from it + +KubeJS: Events and custom quest types as well as custom filters + + +Explain how to make tag based quests using FTB filters and xmod compat, e.g Logs +tl;dr create a Logs item quest, right click on the quest and convert it to a tag quest diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Integrations/kube-js.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Integrations/kube-js.md new file mode 100644 index 00000000..69e17767 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Integrations/kube-js.md @@ -0,0 +1,12 @@ +--- +title: KubeJS +draft: true +--- + +Need something to go here. + +## Events + +## Examples + +Here are some examples of KubeJS scripts that you can use to interact with FTB Quests. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Reward_Tables.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Reward_Tables.md new file mode 100644 index 00000000..aa3547f7 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Reward_Tables.md @@ -0,0 +1,176 @@ +--- +title: Reward Tables and Loot Crates +sidebar_position: 4 +--- + +# Reward Tables + +Reward Tables are a way to manage quest rewards dynamically, equivalent to [loot tables](https://minecraft.wiki/w/Loot_table). + +## Accessing reward tables + +Instead of assigning a fixed reward, you create a pool of items that the reward will be selected from. + +Click the settings cog in your questbook (lower right). + +![Settings cog](../../../../_assets/images/quests/rewards/settings-cog.png "The settings cog is located in the lower right of the screen") + +Select "Edit Reward Tables" in the menu, where you'll be taken to create your first reward table. + +![Edit button for reward tables](../../../../_assets/images/quests/rewards/edit_reward_tables.webp "The edit button for reward tables") + +## Types of loot tables + +Within the questbook interface, reward tables are created and categorized into various types, which are detailed on the [quest rewards](./Rewards/index.md) page. + +- Choice Reward +- All Table Reward +- Random Reward +- Loot Reward + +## Loot crates + +Loot crates reward the player with a **[Loot Reward](./Rewards/Loot_Reward.md)** upon their use. They keep all the benefits offered by reward tables. + +### Converting a reward table + +After a reward table is created, it can be converted to a loot crate by hovering over it and clicking the loot crate button. + +In the following image, we convert a reward table of igneous rocks to a loot crate. + +![Enabling loot crates](../../../../_assets/images/quests/rewards/loot-crate-reach-config.webp "Reaching the configuration for a loot crate") + +### Obtaining the crate as an item + +To obtain the crate as an item in-game, you must know its identifier (id). In the previous example, the id was `igneous_rocks`. + +![Previous example id](../../../../_assets/images/quests/rewards/loot-crate-id.png "The previous example's id was igneous_rocks") + +:::info +Minecraft 1.20.5 and above use the new [component](https://minecraft.wiki/w/Data_component_format) item system when giving items. +::: + +```mcfunction +/give @s ftbquests:lootcrate[ftbquests:loot_crate="igneous_rocks"] +``` + +### In a loot table + +Loot crates in item form can be included in a standard Minecraft [loot table](https://minecraft.wiki/w/Loot_table). We'll go through an example. + +With the following structure, we create a [datapack](https://minecraft.wiki/w/Data_pack) named `SilverfishLootCrateDatapack` in our world folder. + +```plaintext +world/ +└── datapacks/ + └── SilverfishLootCrateDatapack/ + ├── pack.mcmeta <----------------------- Mandatory file for datapacks + └── data/ + └── minecraft/ + └── loot_tables/ + └── entities/ + └── silverfish.json <--- The silverfish loot table +``` + +- [pack.mcmeta](https://minecraft.wiki/w/Data_pack#pack.mcmeta) is mandatory and includes your datapack version. +- The file `silverfish.json` includes your loot table which contains a loot crate. + +In the following code block is the code for the loot table. Notice the use of the component `ftbquests:loot_crate` with the id of our loot crate, `igneous_rocks`, to clearly identify this loot crate's contents. + +```json +{ + "type": "minecraft:entity", + "pools": [ + { + "rolls": 1, + "entries": [ + { + "type": "minecraft:item", + "name": "ftbquests:lootcrate", + "functions": [ + { + "function": "minecraft:set_components", + "components": { + "ftbquests:loot_crate": "igneous_rocks" + } + } + ] + } + ] + } + ], + "random_sequence": "minecraft:entities/silverfish" +} +``` + +After saving our `silverfish.json` file, we exit the world and enter it again. Now, silverfish drop the "Igneous Rocks" loot crate on death. + +![Silverfish dropping a loot crate](../../../../_assets/images/quests/rewards/loot-crate-silverfish.png "A silverfish drops the loot crate on death") + +When we open the loot crate from the silverfish, we obtain either one Granite, Diorite or Andesite. + +![An igneous rock is randomly obtained when opening the loot crate](../../../../_assets/images/quests/rewards/loot-crate-igneous-rocks.png "An igneous rock is randomly obtained when opening the loot crate") + +### Presets to accelerate development + +A few presets can help you create loot crates of various rarities quickly. + +By creating a reward table with any name in the "Name" column below (e.g. "`common`"), and converting it to a loot crate, it will automatically assign some properties. + +|Icon|Name|Color (hexcode)|Passive Mob Drop Rate|Monster Drop Rate|Boss Drop Rate|Glow| +|-|-|-|-|-|-|-| +|![Common crate preset](../../../../_assets/images/quests/rewards/loot-crate-common.png "The common crate")|common|0x92999A|350|10|0|false| +|![Uncommon crate preset](../../../../_assets/images/quests/rewards/loot-crate-uncommon.png "The uncommon crate")|uncommon|0x37AA69|200|90|0|false| +|![Rare crate preset](../../../../_assets/images/quests/rewards/loot-crate-rare.png "The rare crate")|rare|0x0094FF|50|200|0|false| +|![Epic crate preset](../../../../_assets/images/quests/rewards/loot-crate-epic.png "The epic crate")|epic|0x8000FF|9|10|10|false| +|![Legendary crate preset](../../../../_assets/images/quests/rewards/loot-crate-legendary.webp "The legendary crate")|legendary|0xFFC147|1|1|190|true| + +### Nesting with loot crates + +Reward tables and loot crates can be nested in each other. + +The "parent" table needs to be a reward table or a loot crate, and the "children" needs to be loot crates. + +#### Nesting example + +Step 1: Start by creating your children reward tables and convert them all to loot crates. In this example below we have the five rarities. + +![Example loot crates](../../../../_assets/images/quests/rewards/nesting-five-types.png "Fives types of loot crates") + +Step 2: Give yourself all the loot crates using their identifiers (ID). + +```mcfunction +/give @s ftbquests:lootcrate[ftbquests:loot_crate="common"] +/give @s ftbquests:lootcrate[ftbquests:loot_crate="uncommon"] +/give @s ftbquests:lootcrate[ftbquests:loot_crate="rare"] +/give @s ftbquests:lootcrate[ftbquests:loot_crate="epic"] +/give @s ftbquests:lootcrate[ftbquests:loot_crate="legendary"] +``` + +![Loot crates in hotbar](../../../../_assets/images/quests/rewards/nesting-five-crates-inv.webp "The five types of loot crates are in our hotbar") + +Step 3: With the loot crates in your hotbar, create a new parent reward table. We will call it "All Loot Crates" for this example. + +![New reward table](../../../../_assets/images/quests/rewards/nesting-parent.png "The new parent reward table") + +Step 4: Add each of the children loot crates to the parent reward table by clicking the "Add" button. + +![Add the loot crate to the parent](../../../../_assets/images/quests/rewards/nesting-add-common.webp "The common loot crate is added to the parent reward table") + +For this example we do this until we get the following. + +![All five types](../../../../_assets/images/quests/rewards/nesting-all-five.webp "All our five loot crates are added to the parent reward table") + +Step 5 (optional): Before hitting "accept", you can click each of the loot crates and rename the titles. Much cleaner! + +![Renaming the common crate](../../../../_assets/images/quests/rewards/nesting-rename-loot-crate.png "Renaming the entries of the parent table looks cleaner") + +Step 6: Hit accept until you are back at quest creation. + +![The accept button](../../../../_assets/images/quests/rewards/accept.png "Hitting the accept button ensures saving your changes!") + +Step 7: Create a quest, create a "Loot Table" reward and set it to your parent reward table (in this example, "All Loot Crates"). + +![Loot reward](../../../../_assets/images/quests/rewards/nesting-loot-reward.webp "A chance to get any of the five loot crates!") + +Now your players can truly receive a random assortment of items; the possibilities are limitless! diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md new file mode 100644 index 00000000..7c6f75dc --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Advancement_Reward.md @@ -0,0 +1,24 @@ +--- +title: Advancement Reward +sidebar_position: 8 +--- + +# Advancement Reward + +Advancements are a means to track progression in Minecraft, but sometimes you can use them for custom logic or even to give out items. + +## Example + +To grant a specific advancement through a quest, create the reward for it and select your advancement to grant. + +In this example we want to grant the "Isn't It Iron Pick" advancement. + +![Isn't It Iron Pick advancement](../../../../../_assets/images/quests/rewards/advancement-isnt-iron-pick.png "The Isn't It Iron Pick advancement as a reward") + +Only this advancement (in yellow) will be granted to the player. Dependencies until that advancement are untouched. + +![The advancement tree](../../../../../_assets/images/quests/rewards/advancement-screen-iron-pick.png "The dependencies of Isn't It Iron Pick are not granted") + +:::tip +If you want to grant all advancements until "Isn't It Iron Pick", you might be better off with a [command reward](./Command_Reward.md) such as `/advancement grant @p until minecraft:story/iron_tools`. +::: diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md new file mode 100644 index 00000000..417db230 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/All_Table_Reward.md @@ -0,0 +1,12 @@ +--- +title: All Table Reward +sidebar_position: 3 +--- + +# All Table Reward + +All rewards of a specific reward table will be given out to the player, in full count. + +For example, if we have a reward table with many rewards such as items, xp, advancements, etc., the player will receive all of them at once. + +![All table rewards](../../../../../_assets/images/quests/rewards/all-table-reward.webp "A loot table with items, xp and an advancement is received in full") diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md new file mode 100644 index 00000000..88f9ea9a --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Choice_Reward.md @@ -0,0 +1,12 @@ +--- +title: Choice Reward +sidebar_position: 2 +--- + +# Choice Reward + +Choice rewards allow the player to choose any item in a reward table. The item is given in full count. + +In the example below, if they would choose the iron pickaxes, they would receive two. + +![Tools choice reward](../../../../../_assets/images/quests/rewards/choice-reward.webp "A choice between a diamond pickaxe and two enchanted iron axes") diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Command_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Command_Reward.md new file mode 100644 index 00000000..bb90de45 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Command_Reward.md @@ -0,0 +1,46 @@ +--- +title: Command Reward +sidebar_position: 5 +--- + +# Command Reward + +With a command reward, you can almost do anything. You input the command in the reward itself. + +Example: Teleport the player five blocks up (requires permission level 2, also set in the reward itself) + +```mcfunction +/tp @p ~ ~5 ~ +``` + +Example: Add 10 levels to the player (requires permission level 2) + +```mcfunction +/xp add @p 10 levels +``` + +Etc. Try something now! + +## Changing quest progress on the go + +Running commands such as from `/ftbquests` is also possible. + +For example we have a dummy quest with the quest id `570F25BE1914AE96`. We change its settings to be hidden in the questbook. + +![Dummy quest](../../../../../_assets/images/quests/rewards/command-dummy-quest.png "Dummy Quest") + +We also have a special chapter "Woodcutting" with one quest called "Oak Log". + +"Oak Log" is dependent on the completion of "Dummy Quest" before it can show up, since we set it as hidden until dependencies are completed. The chapter "Woodcutting" is also hidden since we set the same setting and "Oak Log" is our only quest. + +![Woodcutting chapter](../../../../../_assets/images/quests/rewards/command-woodcutting.webp "The hidden Woodcutting chapter and its only quest named Oak Log") + +When you are rewarded with the command `/ftbquests change_progress @p complete 570F25BE1914AE96` (permission level 2 required in the settings), you will complete this hidden dummy quest. + +By this chain of events you then unlock the "Oak Log" quest and its "Woodcutting" chapter. + +Here's an example of this in action: + +![Unlocking woodcutting](../../../../../_assets/images/quests/rewards/command-claim-quest.webp "Unlocking the woodcutting chapter indirectly through a command") + +With this method you have more granular control over quest progression and can give your players some choices. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md new file mode 100644 index 00000000..90dbf696 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Custom_Reward.md @@ -0,0 +1,65 @@ +--- +title: Custom Reward +sidebar_position: 6 +--- + +# Custom Reward + +Custom quests do nothing on their own. When they are paired with mods such as KubeJS that integrate with Architectury events (a library mod), they allow for complex rewards. + +:::note +The mods KubeJS and FTB XMod Compat are usually required to write custom rewards. +::: + +## Usage + +Custom rewards are best used after trying other built-in options of FTB Quests. Think of custom rewards like minecraft functions (mcfunction). They'll allow you to do complex calculations for your reward giving. + +Let's imagine a two steps operation where you want to give your players an amount of diamonds equal to their experience level. + +1. Count the experience levels +2. Give diamonds equal to said experience level + +### Diamonds equal to XP level example + +First, let's create a quest to kill 10 Blaze for a custom reward. + +![Custom reward creation](../../../../../_assets/images/quests/rewards/custom-reward-creation.webp "Killing 10 blazes will reward us with the currently inactive custom reward") + +Let's then copy the custom reward ID by right-clicking it. In this example our ID for this custom reward is `29F9C17B7503E992`. + +![Copying the id](../../../../../_assets/images/quests/rewards/custom-copy-id.webp "Right-click allows us to copy the ID") + +:::note +For this example, we have KubeJS and FTB XMod Compat installed since they are both required. +::: + +We create a script at the location `kubejs/server_scripts/custom.js` under our modpack's root folder with the following content. + +```javascript +//Minecraft 1.21.1 +//For the blaze quest, give player diamonds equal to xp level +FTBQuestsEvents.customReward('29F9C17B7503E992', event => { + const xpLevel = event.player.experienceLevel + const diamonds = Item.of('minecraft:diamond', xpLevel) + event.player.give(diamonds) +}) +``` + +Then in-game we reload the server scripts with `/kubejs reload server-scripts` and we go kill 10 blaze (or forcefully complete the quest for testing purposes). + +![Quest completed](../../../../../_assets/images/quests/rewards/custom-quest-complete.webp "The blaze requirement of our quest is completed") + +We now take a look at our xp bar: we are level 43, so we should expect to receive 43 diamonds. + +![Player xp bar](../../../../../_assets/images/quests/rewards/custom-lv-forty-three.png "The player is level forty-three") + +We click the reward to collect it. This will execute the KubeJS script on the server and run the JavaScript code from earlier. + +![Claiming reward](../../../../../_assets/images/quests/rewards/custom-claim-reward.webp "Claiming the custom reward") + +We are then given diamonds equal to our experience level, in this case, 43 diamonds. + +![Obtaining diamonds](../../../../../_assets/images/quests/rewards/custom-receive-diamond.webp "Receiving forty-three diamonds from the custom reward") + +Making custom rewards work can sometimes be more time consuming than other reward giving methods, but when used properly it can empower your creativity as a maker. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md new file mode 100644 index 00000000..681b6759 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Experience_Reward.md @@ -0,0 +1,25 @@ +--- +title: XP Reward +sidebar_position: 7 +--- + +# XP and XP Levels + +Experience comes in two forms: + +- Points +- Levels + +A zombie gives 5 experience points when killed. + +## XP (experience points) + +Gaining five (5) experience points: + +![Gaining XP points](../../../../../_assets/images/quests/rewards/xp-points.webp "Gaining 5 xp points") + +## XP Levels (experience levels) + +Gaining five (5) experience levels: + +![Gaining XP levels](../../../../../_assets/images/quests/rewards/xp-levels.webp "Gaining 5 xp levels") diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Item_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Item_Reward.md new file mode 100644 index 00000000..e985f06c --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Item_Reward.md @@ -0,0 +1,30 @@ +--- +title: Item Reward +sidebar_position: 1 +--- + +# Item Reward + +Item rewards give the player an item or a count of an item. + +## Example with count + +For example here clicking the axe icon rewards two identical axes. + +![Two axes reward](../../../../../_assets/images/quests/rewards/item-reward-two-axe.webp "A quest that will reward two axes simultaneously") + +## Rewarding with fluids or other custom data + +The easiest way is to put the item with the fluids **in your inventory**. + +For example we fill a small fluid tank from PneumaticCraft with lava. + +![Half-filled small lava tank](../../../../../_assets/images/quests/rewards/item-reward-fluid-tank.png "The fluid tank should be placed in the player's inventory before creating the quest") + +When selecting for the item to reward the player with, we will click the compass to change the mode. + +![List mode](../../../../../_assets/images/quests/rewards/item-reward-list-mode.png "List mode is changed by clicking the compass") + +Then, we can select our fluid tank to give as a reward. + +![Inventory list mode](../../../../../_assets/images/quests/rewards/item-reward-inventory-mode.webp "The inventory list mode") diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md new file mode 100644 index 00000000..d5f528c5 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Loot_Reward.md @@ -0,0 +1,27 @@ +--- +title: Loot Reward +sidebar_position: 4 +--- + +# Loot Reward + +The loot reward is your standard loot table. There's a chance to receive one of the rewards, or nothing. + +## Example with an apple + +In this loot table, we have a single enchanted golden apple. + +The weights are as follows: + +- 1 for the enchanted golden apple +- 1 as the configured empty weight for this table (cog icon) + +![Apple loot reward](../../../../../_assets/images/quests/rewards/loot-reward-golden-apple.png "A loot reward table containing an enchanted golden apple") + +Since both the apple and the empty weight have the same value, they have the same chance of being obtained. + +Therefore, the player could end up with absolutely nothing, which we can see below. + +![Quest turn in](../../../../../_assets/images/quests/rewards/loot-reward-preview.png "Previewing the reward reveals there is a chance of getting nothing") + +Unless you want to reward players with nothing, avoid setting the empty weight above zero! diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Random_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Random_Reward.md new file mode 100644 index 00000000..f0bc665d --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Random_Reward.md @@ -0,0 +1,20 @@ +--- +title: Random Reward +sidebar_position: 4 +--- + +# Random Reward + +A random reward pulls one entry from a reward table and gives it to the player in **full count**. An item is **always guaranteed**. + +In the example below, it's guaranteed to get any of the five tools, with a 20% chance of getting a sword. + +:::info +Even if the reward table's empty weight is greater than zero, the player will always receive an item. +::: + +:::tip +Want a chance to reward nothing? See [Loot Reward](./Loot_Reward.md) instead. +::: + +![Random reward](../../../../../_assets/images/quests/rewards/random-reward.png "One tool from this reward table will be given to the player upon completion of the quest") diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md new file mode 100644 index 00000000..6cd7c775 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Stage_Reward.md @@ -0,0 +1,79 @@ +--- +title: Stage Reward +sidebar_position: 10 +--- + +# Stage Reward + +Stage rewards add or remove stages to a player which are usually tied in with modpack progression. How these stages are added depends on your installed mods. + +## Stage provider + +Stages are fully handled by FTB Library. + +By default, FTB Library allows any gamestage mod to replace the implementation of stages. This means if you have a gamestage mod installed, refer to that mod's documentation. + +Instead if you are only using a stock install of FTB Quests along with FTB Library, stages are implemented as tags onto your player. + +To see those tags, you can use the command `/ftblibrary nbtedit player @s`. Here's a visual example where a player both visited the nether and got copper. + +![FTB Library NBTEdit command](../../../../../_assets/images/quests/rewards/stages-ftblib-nbtedit.png "FTB Library's NBTEdit command") + +## Stock demonstration with KubeJS + +If you only plan on using FTB Quests for progression, let's take a look at how you can implement it. For this example we'll be using KubeJS to manipulate the stage tags. + +We create a quest for our player to visit the nether and they manage to do so, automatically receiving the stage upon entering the hellish dimension. + +![Quest visit nether](../../../../../_assets/images/quests/rewards/stage-visited-nether.webp "The stage visited_nether is given") + +Using `/ftblibrary nbtedit player @s` we confirm that they got the tag `visited_nether`. We also notice they possessed the `got_copper` tag beforehand. + +![The player tags](../../../../../_assets/images/quests/rewards/stages-zoom-tags.png "The player has got the visited_nether tag") + +Next we create a quest to get a PneumaticCraft "Finished PCB" item which rewards the player with a custom reward. + +We copy the ID of this custom reward which for our example is `082B2A8F0870DB9E`. + +![Finished PCB quest](../../../../../_assets/images/quests/rewards/stages-custom-pcb-task.webp "A quest to fetch a PCB item which grants a custom reward") + +:::tip +Check the [custom reward](./Custom_Reward.md) page for more in-depth information on this reward type. +::: + +Under our modpack's root, we create the following script at the location `kubejs/server_scripts/stages.js`. + +Then, reload the server scripts with `/kubejs reload server-scripts`. + +```javascript +// Minecraft 1.21 +// The reward granted for the "Finished PCB" quest +FTBQuestsEvents.customReward('082B2A8F0870DB9E', event => { + const playerStages = event.player.stages + + const give_diamond = function(amount) { + const diamond_items = Item.of('minecraft:diamond', amount) + event.player.give(diamond_items) + } + + if (playerStages.has('visited_nether')) { + give_diamond(3) + } else if (playerStages.has('got_copper')) { + give_diamond(2) + } else { + give_diamond(1) + } +}) +``` + +When the player will claim the custom reward with ID `082B2A8F0870DB9E`, the reward will vary: + +- 3 diamonds if they visited the nether +- 2 diamonds if they had obtained copper +- 1 diamond if they have neither stages + +Since the player got the stage `visited_nether` earlier, they get three (3) diamonds. + +![Getting the diamonds as reward](../../../../../_assets/images/quests/rewards/stages-got-diamonds.webp "Getting three diamonds because the stage visited_nether is completed") + +With a judicious use of stage rewards, your control of progression can be enhanced. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md new file mode 100644 index 00000000..9639b4d5 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/Toast_Reward.md @@ -0,0 +1,50 @@ +--- +title: Toast Reward +sidebar_position: 9 +--- + +# Toast Reward + +A toast reward displays a pop-up for the player. The only use is for information. + +## Use case example + +Let's say you create a quest and edit it. + +![Editing a quest](../../../../../_assets/images/quests/rewards/toast-edit-quest.webp "Right-click the icon to edit the quest") + +You then disable the pop-up by setting "Disable Toast Completion" to `True`. + +Optionally, set a title. In this example we choose "Gather Iron Ingots". + +![Disabling the pop-up](../../../../../_assets/images/quests/rewards/toast-disable-popup.png "Disabling the toast completion pop-up") + +Hit "Accept". + +![The accept button](../../../../../_assets/images/quests/rewards/accept.png "Hitting the accept button ensures saving your changes!") + +After your changes, open the quest and add the toast reward (the sign icon) and a diamond. + +![Example toast quest](../../../../../_assets/images/quests/rewards/toast-example-quest.png "A sample toast quest") + +Now edit the toast reward. + +![Editing the toast](../../../../../_assets/images/quests/rewards/toast-edit-reward.webp "Right-click the icon to edit the toast reward") + +We enable "Auto-claim". + +We set the description to "You can claim a diamond!" + +We set the title of the toast reward to the title of the quest: "Gather Iron Ingots". + +![Editing the title and description](../../../../../_assets/images/quests/rewards/toast-edit-title-desc.png "Edit the title and description with some custom text") + +Hit "Accept". + +![The accept button](../../../../../_assets/images/quests/rewards/accept.png "Hitting the accept button ensures saving your changes!") + +Now, when a player completes the quest, the toast appears in the upper-right corner of the screen. + +![Toast appears](../../../../../_assets/images/quests/rewards/toast-show-up.webp "The toast appears!") + +Toast rewards are therefore an effective way to convey specific information to players. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/index.md new file mode 100644 index 00000000..4bf5d875 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Rewards/index.md @@ -0,0 +1,19 @@ +--- +title: Quest Rewards +sidebar_position: 3 +--- + +| Type | Description | +|-|-| +| [Item](./Item_Reward.md) | Give an item as a reward | +| [Choice Reward](./Choice_Reward.md) | Allow the player to choose from a selection of rewards | +| [All Table Reward](./All_Table_Reward.md) | Gives the player every item from a set reward table regardless of the set weights | +| [Random Reward](./Random_Reward.md) | The player gets a random reward from a set reward table and is always guaranteed to reward the player with an item | +| [Loot Reward](./Loot_Reward.md) | Reward a player with loot from a reward table, if the reward table has the chance of dropping nothing the player will have a chance of not being given a reward | +| [Command](./Command_Reward.md) | Run a command when the quest is completed | +| [Custom](./Custom_Reward.md) | Does nothing on its own | +| [XP](./Experience_Reward.md) | Give the player `x` XP | +| [XP Levels](./Experience_Reward.md) | Give the player `x` levels of XP | +| [Advancement](./Advancement_Reward.md) | Completes an advancement for the player | +| [Toast](./Toast_Reward.md) | Show a toast with a custom message to the player | +| [Stage](./Stage_Reward.md) | Grant or revoke a game stage | diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Settings.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Settings.md new file mode 100644 index 00000000..7ad3fd1a --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Settings.md @@ -0,0 +1,157 @@ +--- +title: Settings +--- + +## Quest + +### Description + +The description of the quest. This is what will be displayed below the quest tasks and rewards. +The text can be formatted to include colours, bold text, links and more. SEE GUIDE + +### Disable Completion Toast + +Disables the completion toast for this quest. This will prevent the toast from appearing in the top right when this quest is completed. + +### Icon + +The quest icon, this is the icon that will be displayed in the quest book + +### Subtitle + +The subtitle will be displayed as a tooltip when you hover over the quest title in the quest list. + +### Tags + +Tags are used to help theme the quest/quest book and also allow you to use them in KubeJS events. You can add multiple tags to a quest. + +### Title + +The title of the quest. + +--- + +## Appearance + +### Icon scaling + +Size of the quest icon in the quest book + +### Min opened quest window width + +Minimum width of the quest description window + +### Shape + +The shape of the quest in the quest book. The following shapes are available: + +- Default (Will use the default shape for the chapter) +- Circle +- Square +- Rounded Square +- Diamond +- Pentagon +- Hexagon +- Octagon +- Heart +- Gear + +### Size + +Size of the quest in the quest book including the icon + +### X + +X position of the quest in the quest book + +### Y + +Y position of the quest in the quest book + +--- + +## Visibility + +### Hide details until startable + +If enabled, the quest details (text and tasks) will be hidden until the quest can be started. + +### Hide until dependencies are visible + +If enabled, the quest will be hidden until all of its dependencies are visible. + +### Hide text until quest is completed + +Hides the quest description until the quest is completed. + +### Invisible until completed + +The quest is invisible until it is completed. Useful for easter egg or optional quests. + +### Invisible until X tasks are completed + +Only applies if invisible is enabled. The quest will be invisible until X tasks are completed, once X tasks are completed the quest will become visible. + +--- + +## Dependencies + +### Dependencies + +List of quests that the quest depends on, see the below dependency requirement options for more information. + +### Dependency requirement + +- All Completed + - All the dependencies must be completed before this quest can be started. +- One Completed + - Only one of the dependencies must be completed before this quest can be started. +- All Started + - All the dependencies must be started before this quest can be started. +- One Started + - Only one of the dependencies must be started before this quest can be started. + +### Hide dependency lines + +Hides the dependency lines for this quest. + +### Hide dependent lines + +Hides the dependent lines for any quests that depend on this quest. + +### Min required dependencies + +Number of dependencies that must be completed before this quest can be started. + +--- + +## Misc + +### Disable JEI recipe + +Disable showing JEI recipes for this quest. + +### Ignore reward blocking + +Offer the quest rewards even if reward blocking is enabled for the team. + +### Optional quest + +The quest is optional and does not need to be completed to progress. + +### Progression mode + +- Linear + - Quests must be completed in order. +- Flexible + - Quests can be completed in any order. + +### Repeatable quest + +The quest can be repeated as many times as the player wants. + +### Sequential task completion + +If enabled, tasks in this quest will need to be completed in order. + + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Types.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Types.md new file mode 100644 index 00000000..bbc32602 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/Types.md @@ -0,0 +1,24 @@ +--- +title: Quest Types +sidebar_position: 2 +--- + +| Type | Description | +|-----------------|------------------------------------------------------------------| +| Item | Obtain the specified item | +| Custom | Custom quest type | +| XP Levels | Collect `x` levels of XP | +| Visit Dimension | The player will need to visit a given dimension | +| Stat | Specify a statistic that the player will need to reach or exceed | +| Kill Entity | Kill the entity specified | +| Location | Navigate to the given position in the world | +| Checkmark | Click on the checkmark to complete the task | +| Advancement | Complete the specified advancement | +| Observation | Observe a set block/entity | +| Visit Biome | Find the biome specified | +| Find Structure | Find the specified structure (e.g. Stronghold) | +| Stage | Game stages | +| Fluid | Obtain the given fluid | +| Forge Energy | Generate `x` amount of Forge Energy | +| Image | Set a decorative image for your quest chapter | + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/index.md new file mode 100644 index 00000000..b6c1515b --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Quests/index.md @@ -0,0 +1,51 @@ +--- +title: Creating Quests +sidebar_position: 1 +--- + +:::info +To create a quest, you will first need to create a chapter. A quest is always created inside a chapter and a chapter can +be put inside a chapter group. + +For details on creating a chapter, see the [Chapters](../Chapters/index.md) page. +::: + +To create a quest, right-click anywhere in the blank space of the quest book and select the type of task you want to create. Additional tasks can be added to the quest later (see [Quest Tasks](#quest-tasks)). + +A detailed explanation of the different quest types can be found on the [Quest Types](./Types.md) page. + +![Create Quest](../../../../_assets/images/quests/create-a-quest.webp) + +After selecting the type of quest you would like to create, you will be asked to select/enter some initial settings for the quest, such as selecting an item needed to complete the quest, or how many XP levels the player needs to collect. + +With the quest created, you will now be able to add additional tasks to the quest, in addition to the rewards the player will get for completing the quest. + +### Quest Tasks + +You can add additional tasks to a quest by clicking the `+` button in the tasks section of the quest. +This will allow you to select the type of task you want to add to the quest again. + +![Add Quest Task](../../../../_assets/images/quests/quest-add-task.webp) + +#### Using item tags + +When creating a task that requires the player to collect a certain item, you can use item tags to make the task more flexible. + +For example, if you want the player to collect any type of wood, you can create the quest with an item task and select Oak Logs as the item. + +Now you can right-click the task and select `Convert to 'FTB Filter System' Tag Filter`. This will open a new window that allows you to select which tag you want to use. + +:::note + +For this to work, the [FTB Filter System](https://www.curseforge.com/minecraft/mc-mods/ftb-filter-system) and [FTB XMod Compat](https://www.curseforge.com/minecraft/mc-mods/ftb-xmod-compat) mods must also be installed. + +::: + +![Convert to Tag Filter](../../../../_assets/images/quests/quest-convert-to-tag-filter.webp) + +### Quest Rewards + +[Quest rewards](./Rewards/index.md) can be added by clicking the `+` button in the rewards section of the quest window. +This will open a window where you can select the type of reward you would like to add to the quest. + +![Add Quest Reward](../../../../_assets/images/quests/quest-add-reward.webp) diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Styling/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Styling/index.md new file mode 100644 index 00000000..aa9e5fa6 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Developer/Styling/index.md @@ -0,0 +1,180 @@ +--- +title: Theming the quest book +toc_max_heading_level: 4 +--- + +Firstly: Themes are just a `.txt` file that tells quests how to look. Most components will use this for their styling. If they don't. Please let us know! Not many people use this system + +Secondly: Themes are handled by placing a `ftbquests/ftb_quests_theme.txt` file in your resource pack (KubeJS works here) + +## The fun stuff + +### Properties + +#### Colour +- `color`: A colour property is an RGBA colour code, but it supports a bunch of things, so here goes + - "#00A8FF" (Hex codes are supported) + - "#FF00A8FF" (Alpha supported (First 2) hex codes are supported) + - Then the following presets are supported: `transparent`, `black`, `dark_gray`, `gray`, `white`, `red`, `green`, `blue`, `light_red`, `light_green`, `light_blue` +#### Icon +- `icon`: Another fun one, this can be handled using the following: + - An icon is a string value like the following `item:minecraft:diamond` + - But an icon and support many different types (Not just items) + - `color:{value}` (See above) + - `bullet:{color_value}` is a simple bullet-point icon (drawn in code, rather than as a bullet texture) + - `http`, `https`, `file`: Loads a resource from disk or a remote location. + - All of these take a value like `https://example.com`, `file://C:/Location` + - `hollow_rectangle:{color}` The name says it all, it makes a hollow rectangle + - `part:{icon}` is used for drawing [nine-sliced](https://en.wikipedia.org/wiki/9-slice_scaling) widgets using an existing texture and corner-size definition + - `builtin` indicates that the icon is drawn by the mod using an internal class to do the work + - Finally, if you do not provide one of these keywords, and instead do something like `ftbranks:textures/gui/something.png` it will just try to do a normal asset icon +- **But now! Here is the fun stuff...** + - Properties: Using a `;` you can signify that an icon has specific properties. These are as follows (I'll show an example at the end btw) + - `padding={int_value}` Icon padding (all directions (left, right, up, down)) + - `border={color_value}` see colour description above. + - You can give this rounded corners by adding `border_round_edges=true` + - `color={color_value}` See above for colours, but this will give the icon a standard colour under all the other options + - `tint={color_value}` See above again. But this adds an overall tint to the icon + - The distinction between `color` and `tint` is subtle, and the effect often depends on the specific icon type. If in doubt, experiment! + - Finally, these are added together using a `; ` meaning a full example might look like this + - `icon:minecraft:diamond; padding=5; border=#00A8FF; border_round_edges=true; color=blue; tint=#A8FFFFFF` + - The whitespace after each `;` character is _important_ ! +- `double`: This one is simple. It's just a double (`1.0D`) +- `int`: (See above) +- `string`: (See above) + +Well! Wasn't that fun. Now we know all about properties. As you can tell, the colour and icon properties are pretty powerful! + +Now we get onto the fun stuff. How do you use this in quests? Well, as we said above, it's all configured in the `ftb_quests_theme.txt` + +As of right now, the quest themes system supports the following values + +#### Overall +- background: \{icon_prop\} +- `extra_quest_shapes: {string}` (Please note, this is split using a `,`) +- text_color: \{color_prop\} +- hover_text_color: \{color_prop\} +- disabled_text_color: \{color_prop\} + +#### Widgets + +Widgets are most of the UI containers (IIRC) + +- widget_border: \{color_prop\} +- widget_background: \{color_prop\} +- symbol_in: \{color_prop\} +- symbol_out: \{color_prop\} +- button: \{icon_prop\} +- panel: \{icon_prop\} +- disabled_button: \{icon_prop\} +- hover_button: \{icon_prop\} +- context_menu: \{icon_prop\} +- scroll_bar_background: \{icon_prop\} +- scroll_bar: \{icon_prop\} +- container_slot: \{icon_prop\} +- text_box: \{icon_prop\} + +#### Icons +- check_icon: \{icon_prop\} This defaults to `builtin` - using the `CheckIcon` class in FTB Quests +- add_icon: \{icon_prop\} This defaults to `builtin` - using a complex render but uses the `symbol_in` and `symbol_out` colours + +#### Overall quest book icons +- alert_icon: \{icon_prop\} +- support_icon: \{icon_prop\} +- wiki_icon: \{icon_prop\} +- wiki_url: \{icon_prop\} +- pin_icon_on: \{icon_prop\} +- pin_icon_off: \{icon_prop\} +- editor_icon_on: \{icon_prop\} +- editor_icon_off: \{icon_prop\} +- hidden_icon: \{icon_prop\} +- link_icon: \{icon_prop\} +- save_icon: \{icon_prop\} +- settings_icon: \{icon_prop\} +- prefs_icon: \{icon_prop\} +- close_icon: \{icon_prop\} +- emergency_items_icon: \{icon_prop\} +- guide_icon: \{icon_prop\} +- modpack_icon: \{icon_prop\} +- reward_table_icon: \{icon_prop\} +- shop_icon: \{icon_prop\} +- collect_rewards_icon: \{icon_prop\} +- delete_icon: \{icon_prop\} +- reload_icon: \{icon_prop\} +- download_icon: \{icon_prop\} +- edit_icon: \{icon_prop\} +- move_up_icon: \{icon_prop\} +- move_down_icon: \{icon_prop\} + +#### Task specific +- checkmark_task_active: \{icon_prop\} +- checkmark_task_inactive: \{icon_prop\} + +#### Quest window + +- icon: \{icon_prop\} +- `full_screen_quest: {int_prop}` +- tasks_text_color: \{color_prop\} +- rewards_text_color: \{color_prop\} +- quest_view_background: \{icon_prop\} +- quest_view_border: \{color_prop\} +- quest_view_title: \{color_prop\} +- quest_completed_color: \{color_prop\} +- quest_started_color: \{color_prop\} +- quest_not_started_color: \{color_prop\} +- quest_locked_color: \{color_prop\} +- dependency_line_texture: \{icon_prop\} +- dependency_line_completed_color: \{color_prop\} +- dependency_line_uncompleted_color: \{color_prop\} +- dependency_line_requires_color: \{color_prop\} +- dependency_line_required_for_color: \{color_prop\} +- `dependency_line_selected_speed: {double_prop}` +- `dependency_line_unselected_speed: {double_prop}` +- `dependency_line_thickness: {double_prop}` +- `quest_spacing: {double_prop}` +- `pinned_quest_size: {double_prop}` +- left_arrow: \{icon_prop\} +- right_arrow: \{icon_prop\} + +#### Tagging + +You may have noticed a `[*]` line at the very top of the `ftb_quests_theme.txt` file. Lines like this act as _filters_, limiting which quests that theming should be applied to. The default filter, a `*`, indicates that anything below this should apply to _all_ quests, so this is the fallback behaviour. + +You can add more `[...]` lines if you like. Between the `[]` brackets, put either a quest ID (the long hex ID you can get by right-clicking a quest and selecting "Copy ID"), or a quest _tag_. Quest tags are just free form strings, which you can add to quests via the "Edit" context menu action - see the "Tags" list property in the edit screen. + +Example: +``` +[bluequests] +quest_not_started_color: #FF0000FF + +[redquests] +quest_not_started_color: #FFFF0000 +``` + +Now, adding the "bluequests" tag to any quest will make it render blue when it hasn't yet been started, and similarly for the "redquests" tag. Every other theming property is inherited from the `[*]` defaults. + +In general, it's better to use tags than literal quest ID's, just because tags are a lot more flexible. + +#### Custom Shapes + +You can have custom quest shapes if the built-in shapes aren't sufficient for your needs. To do this: + +* Pick a shape name (free form text, keep it short and meaningful, one word) and add it to the comma-separated list in `extra_quest_shapes` +* Place three texture files for your new shape name in your resource pack, accessible as: + * `ftbquests:textures/shapes//background.png` - textured background + * `ftbquests:textures/shapes//outline.png` - a solid outline for the shape edge + * `ftbquests:textures/shapes//shape.png` - used for masking, the same as (and exactly enclosing) the outline + * See one of the existing texture sets in https://github.com/FTBTeam/FTB-Quests/tree/main/common/src/main/resources/assets/ftbquests/textures/shapes if unsure +* Add a translation for your shape in a language file: `"ftbquests.quest.shape.": "New Shape"` + +### Side notes + +Finally, there are a couple of side notes to this system + +At any point in your `.txt` file, if you use `{{ NAME }}` in the value, it will assume you want to use the value of a different property. So this might look like the following: `quest_completed_color: {{rewards_text_color}}` + +It's important to note that these need to be the same (or compatible) property types for a replacement to be successful. + +Some of the above values have a min and max. You should check here: https://github.com/FTBTeam/FTB-Quests/blob/main/common/src/main/java/dev/ftb/mods/ftbquests/quest/theme/property/ThemeProperties.java for those min and max values + + diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Navigating.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Navigating.md new file mode 100644 index 00000000..017fcedf --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Navigating.md @@ -0,0 +1,65 @@ +--- +title: Navigating the Quest Book +sidebar_position: 2 +--- + +## Key References +FTB Quests has a number of keyboard shortcuts that can help you quickly navigate the quest book, such as Ctrl + F +to quickly find a quest. + +You can view a full list of key references by opening the quest book, then clicking on the `i` icon in the top right of the screen. + +![Key References](../../../../_assets/images/quests/key-reference.webp) + +## Showing the chapter list +Moving your mouse cursor to the left of the screen will open the quest book chapter list. Clicking on a chapter will show you the quests available in that chapter. + +![Chapter sidebar minimized](../../../../_assets/images/quests/chapter-sidebar-min.webp) + +You can also 'pin' the chapter list open by clicking the pin icon in the top left of the screen. This will keep the chapter list open even when you move your mouse away from it. + +![Pin chapter sidebar](../../../../_assets/images/quests/chapter-sidebar-pin.webp) + +## Moving around the quests +Sometimes there may be countless quests in a single chapter. You can move around the quests by clicking and holding your left mouse button on an empty area of the quest screen +and dragging it around. For a full list of way to navigate the quest book, see the key references above. + +![Moving around the quest book](../../../../_assets/images/quests/moving-around-quests.webp) + +## Opening a quest +To open a quest, simply click on the quest you would like to view. This will then open a new window with the details of the quests, which includes the quest description, tasks, and rewards. + +![Opening a quest](../../../../_assets/images/quests/opening-a-quest.webp) + +You can also click on the task to view the crafting recipe or any other extra information about the task. + +![Viewing a task](../../../../_assets/images/quests/viewing-a-task.webp) + +## Pinning a quest +You can pin a quest so that the quest is always visible to you by opening the quest you want to track the progress of and then clicking on the pin icon + +![Pinning a quest](../../../../_assets/images/quests/pinning-a-quest.webp) + +## Completing a quest and claiming rewards + +:::info +Some quests may be team based, meaning that once a task is completed by any member of the team, it will be marked as completed for all members of the team, the rewards can also be marked as a team reward. +::: + +Once you have completed all the tasks for a quest, you will get a notification in the top right of the screen and an `!` will appear on the quest book icon in your inventory screen. + +When you open the quest book, the chapter the quest is in will also have an `!` along with the specific quest that was completed + +![Quest completed](../../../../_assets/images/quests/quest-notification-1.png) +![Quest completed](../../../../_assets/images/quests/quest-notification-2.webp) + +### Claiming reward + +To claim a reward, you can either click on the Claim all button in the top right of the screen. + +![Claiming a reward](../../../../_assets/images/quests/claim-all-rewards.webp) + +Or you can open the completed quest and click on the rewards. +Some rewards will allow you to choose between multiple rewards, you can click on the reward you would like to claim. + +![Claiming a reward](../../../../_assets/images/quests/claim-rewards.webp) diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Opening.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Opening.md new file mode 100644 index 00000000..563b54cd --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Opening.md @@ -0,0 +1,28 @@ +--- +title: Opening the Quest Book +sidebar_position: 1 +--- + +The quest book is a simple and easy-to-use way to track your progress in the game. It is divided into chapters, each of which contains a number of quests. Each quest has a title, a description, and a set of objectives that you need to complete in order to finish it. When you complete a quest, you will be rewarded with items, experience, or other rewards. + +## How to open the quest book + +You can open the quest book by opening your inventory and clicking on the book icon in the top left of the screen. This will open the quest book interface, where you can see all the quests and chapters that are available. + +![Opening the quest book](../../../../_assets/images/quests/opening-questbook-inv.webp) + +It's also possible to open the quest book by crafting the quest book item and right-clicking it, or by using the key bind (The key bind is not bound by default). + +![Quest book item](../../../../_assets/images/quests/questbook-item.webp) + +If you are playing a modpack that does not have any quests added to it, the quest book will be empty. + +![Empty quest book](../../../../_assets/images/quests/empty-questbook.webp) + +On modpacks that have quests, such as FTB NeoTech, you will see a list of chapters on the left side of the screen. Clicking on a chapter will show you the quests that are available in that chapter. + +:::tip +Some quests and chapters may be hidden until you complete other quests or chapters first. +::: + +![Quest book with chapters](../../../../_assets/images/quests/questbook-chapters.webp) diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Tips_Tricks.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Tips_Tricks.md new file mode 100644 index 00000000..69dd109f --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/Player/Questbook/Tips_Tricks.md @@ -0,0 +1,36 @@ +--- +title: Tips & Tricks +--- + +## Auto-pinning quests + +You can tell FTB Quests to automatically pin quests, so they are always visible. To accomplish this, open the quest book and click the pin icon in the top right of the screen. +This will pin all the quests in the quest book, in large modpacks this may cause the list of quests to go off the screen. + +## Locked Quests / Dependencies / Dependents + +Sometimes a quest will be locked but you cannot see the incomplete dependency quest(s) because it is in a different quest Chapter. + +![Locked quest without a visible dependency](../../../../_assets/images/quests/questbook-dependency-hidden.png) + +If you click the small Left Arrow in the quest, you can open a dropdown that lists all of the dependencies of the quest. + +![Picture of quest view with the left and right arrow highlighted with a box](../../../../_assets/images/quests/questbook-dependency-buttons.webp) + +You can click on a quest in the list to be taken directly to the quest. Note that the chapter the dependency quest is in is listed here in `[brackets]` if the quest is not in the current chapter. + +![Dependencies dropdown list for a quest](../../../../_assets/images/quests/questbook-dependency-dropdown.webp) + +You can also use the Right Arrow on the top right of the quest to see a dropdown listing all of the Dependent quests. + +![Dependents dropdown list for a quest](../../../../_assets/images/quests/questbook-dependency-upstream.webp) + +## Linked Quests + +Some quests may be "Linked". This means the same quest is displayed in more than one location in the questbook. + +You can jump between the linked quests by clicking the link icon in the titlebar of the quest. + +![Hovering over Linked quest button](../../../../_assets/images/quests/questbook-linked-quest.png) + +If the quest is a link, the button will be on the left side. If the quest is the original, the button will be on the right and will give a dropdown when clicked because there can be more than one quest link(s) from it. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Quests/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/index.md new file mode 100644 index 00000000..e97ca027 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Quests/index.md @@ -0,0 +1,21 @@ +--- +title: Quests +description: FTB Quests is a lightweight, team-based questing mod that is very simple to use. +sidebar_position: 2 +--- + +:::info +These docs were created using FTB Quests for Minecraft 1.21, there may be differences in older versions. +::: + +## What is FTB Quests? + +FTB Quests is a lightweight, team-based questing mod that is very simple to use. + +## Getting Started + +### I am a player looking for information on how to use the quest book +If you are a player and looking for information about how to use the quest book, checkout the [Player](./Player/Questbook/Opening.md) section of the documentation. + +### I am a developer looking to create quests +If you are a developer and looking to create quests, checkout the [Developer](./Developer/Quests/index.md) section of the documentation. diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/API.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/API.md new file mode 100644 index 00000000..6520a628 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/API.md @@ -0,0 +1,56 @@ +--- +title: API +sidebar_position: 5 +--- + +This page covers basic API usage for mods who wish to use FTB Ranks to query nodes or add their own conditions. + +The top-level Java class for all API usage is [FTBRanksAPI](https://github.com/FTBTeam/FTB-Ranks/blob/1.20.1/main/common/src/main/java/dev/ftb/mods/ftbranks/api/FTBRanksAPI.java). + +### Querying Nodes +A very simple example of querying a node: + +```java +public int getInt(ServerPlayer player, int def, String node) { + return Math.max(FTBRanksAPI.getPermissionValue(player, node).asInteger().orElse(def), 0); +} +``` + +This defines a simple method to retrieve an integer node value from FTB Ranks, with a default if the node isn't present. Example usage: + +```java +int cooldown = getInt(player, "ftbessentials.home.cooldown", 5); +``` + +In general, any method or class in the `dev.ftb.mods.ftbranks.api` package is suitable for API usage, and all API classes have comprehensive Javadocs. It's not advised to use any classes or methods outside that package, as they may change without warning in a later FTB Ranks release. + +### Registering Custom Conditions + +Modders can register their own custom conditions by listening to the `RegisterConditionsEvent`. This is an Architectury event, since FTB Ranks is a cross-platform mod. Example: + +```java +// in your mod constructor +RankEvent.REGISTER_CONDITIONS.register(MyModClass::registerConditions); + +// later on +private static void registerConditions(RegisterConditionsEvent event) { + event.register("my_simple", (rank, nbt) -> new CustomCondition()); + event.register("my_advanced", (rank, nbt) -> new AdvancedCustomCondition(nbt)); +} + +// elsewhere... +// note that simple conditions can implement RankCondition.Simple and don't need to do any serialization/deserialization +public class CustomCondition implements RankCondition { + @Override + public String getType() { + return "my_simple"; + } + + @Override + public boolean isRankActive(ServerPlayer player) { + return false; // adjust depending on what your condition is checking for + } + + // other methods to be implemented +} +``` diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Advanced Conditions.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Advanced Conditions.md new file mode 100644 index 00000000..43f75662 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Advanced Conditions.md @@ -0,0 +1,247 @@ +--- +sidebar_position: 3 +--- + +Conditions determine when a rank is implicitly applied to a player. Typically, ranks are awarded based on some player activity, e.g. a "Senior" role can be applied if a player has been on the server for a certain amount of time. + +Advanced conditions are so-called because they require a collection of fields to be supplied to configure how they work, as a config subsection in the `ranks.snbt` file. For this reason, it's not uncommon to edit the config file manually to add an advanced condition, although it is also possible to use commands. + +All advanced conditions have a `type` field, which identifies the condition being added. All other fields are specific to the condition, and are described along with each condition below. + +:::tip +Example of using a command to set an advanced condition for the "senior" rank: +``` +/ftbranks condition senior { type: "playtime", time: 3, time_unit: weeks } +``` +::: + +--- + +### `and` + +```json +{ + admin: { + name: "Op and At Spawn" + power: 1000 + condition: { + type: "and" + conditions: [ + { type: "op" } + { type: "spawn" } + ] + } + } +} +``` + +The `"and"` conditions allows combining of two or more subconditions. The rank applies to the player if _all_ of the subconditions match. + +#### Fields +* `conditions` - a list of the subconditions, all of which must be matched for this condition to apply + +--- +### `dimension` + +```json +{ + admin: { + name: "In the Overworld" + power: 1000 + condition: { + type: "dimension" + dimension: "minecraft:overworld" + } + } +} +``` +The `"dimension"` condition checks the dimension that a player is currently in; the rank applies to the player if they are in the specified dimension. + +#### Fields +* `dimension` is the dimension ID of the dimension to be checked, e.g. `minecraft:overworld` or `minecraft:the_nether` + +--- + +### `not` + +```json +{ + admin: { + name: "Not in the Nether" + power: 1000 + condition: { + type: "not" + condition: { type: "dimension", "dimension": "minecraft:the_nether" } + } + } +} +``` + +The `"not"` condition takes a single subcondition; the rank applies to the player if the subcondition does _not_ match. + +#### Fields +* `condition` - one subcondition, which must not be matched for this condition to apply + +--- + +### `or` + +```json +{ + admin: { + name: "Op or One Week Played or Creative Mode" + power: 1000 + condition: { + type: "or" + conditions: [ + { type: "op" } + { type: "playtime", "time": 1, "time_unit": "weeks" } + { type: "creative_mode"} + ] + } + } +} +``` + +The `"or"` condition allows combining of two or more subconditions. The rank applies to the player if _any_ of the subconditions match. + +#### Fields +* `conditions` - a list of the subconditions, at least one of which must be matched for this condition to apply + +--- + +### `playtime` + +```json +{ + admin: { + name: "Admin" + power: 1000 + condition: { + type: "playtime" + time: 3 + time_unit: "weeks" + } + } +} +``` + +When the `"playtime"` condition is applied to a role it is given to any player that has played for a certain number of time units. + +#### Fields + +* `time` is the number of time units the player must have been on the server for +* `time_unit` is one of the following: + - `"ticks"` + - `"seconds"` + - `"minutes"` + - `"hours"` + - `"days"` + - `"weeks"` + +If a `time_unit` is not supplied it will default to ticks (and a warning will be logged when the config is loaded by the server). + +--- + +### `rank_added` + +```json +{ + admin: { + name: "Has the 'xyz' rank added" + power: 1000 + condition: { + type: "rank_added" + rank: "xyz" + } + } +} +``` + +The `"rank_added"` condition can be used to check if a player has had some other rank explicitly added, either by the `/ftbranks add ...` command, or by direct editing of the player rank file. It does _not_ match ranks which apply implicitly; see the `rank_applies` condition if you need that. + +This is a fairly esoteric condition, but can be used to simplify the usage of complex compound conditions, where you might otherwise end up with multiple levels of nested and/or/not conditions. + +#### Fields +* `rank` - the rank to check, which must be explicitly added to the player + +--- + +### `rank_applies` + +```json +{ + admin: { + name: "The 'xyz' rank applies to the player" + power: 1000 + condition: { + type: "rank_applies" + rank: "xyz" + } + } +} +``` + +The `rank_applies` condition is very similar to the `rank_added` condition, but with one important difference: it matches _any_ rank that currently applies to the player, either explicitly added, or by an implicit match (e.g. a `playtime` or `stat` condition). + +#### Fields +* `rank` - the rank to check, may be explicitly added or applies implictly + +--- + +### `stat` + +```json +{ + admin: { + name: "Walked at least 5000m (500000cm)" + power: 1000 + condition: { + type: "stat" + stat: "minecraft:walk_one_cm" + value: 500000 + value_check: >= + } + } +} +``` + +The `"stat"` condition can be used to compare a player's [Minecraft Statistics](https://minecraft.fandom.com/wiki/Statistics) with a given value. This rank applies to the player if the given stat value for the player satisfies the check. + +#### Fields +* `stat` is the resource location for the stat to check. All default stats added by vanilla can be seen at https://minecraft.fandom.com/wiki/Statistics. It is possible that some mods may add extra custom stats. +* `value` is an integer value to be compared against the stat's returned values +* `value_check` determines how to compare the stat's value against the supplied `value`. It is one of: + - `equals` or `==` + - `not_equals` or `not` or `!=` + - `greater` or `>` + - `greater_or_equal` or `>=` + - `lesser` or `<` + - `lesser_or_equal` or `<=` + +If omitted, `value_check` defaults to `equals`. + +--- + +### `xor` + +```json +{ + admin: { + name: "Only one of Op or One Week Played" + power: 1000 + condition: { + type: "xor" + conditions: [ + { type: "op" } + { type: "playtime", "time": 1, "time_unit": "weeks" } + ] + } + } +} +``` + +The `"xor"` condition allows combining of two or more subconditions. The rank applies to the player if _only one_ of the subconditions matches. + +#### Fields +* `conditions` - a list of the subconditions, exactly one of which must be matched for this condition to apply diff --git a/docs/mods/suite/Ranks/Commands.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Commands.md similarity index 100% rename from docs/mods/suite/Ranks/Commands.md rename to mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Commands.md diff --git a/docs/mods/suite/Ranks/Configuration.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Configuration.md similarity index 100% rename from docs/mods/suite/Ranks/Configuration.md rename to mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Configuration.md diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Integration/FTB Essentials.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Integration/FTB Essentials.md new file mode 100644 index 00000000..83ffbdb8 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Integration/FTB Essentials.md @@ -0,0 +1,8 @@ + +FTB Essentials adds several commands with configurable warmup and cooldown delays; these delays can be overridden with FTB Ranks permission nodes. + +See [the Essentials documentation page](/mod-docs/mods/suite/Essentials/Ranks_Integration#warmups-and-cooldowns) for more details. + +:::info +Note that FTB Essentials / FTB Ranks integration does not require FTB XMod Compat to be present. +::: diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Integration/FTB XMod Compat.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Integration/FTB XMod Compat.md new file mode 100644 index 00000000..487bf410 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Integration/FTB XMod Compat.md @@ -0,0 +1,18 @@ + + +When FTB XMod Compat is installed, the following FTB mods define some mod-specific nodes. + +### FTB Chunks + +| Node | Type | Description | +| ---- | ---- | ---- | +|`ftbchunks.max_claimed`| Integer | The maximum number of chunks a player may claim | +|`ftbchunks.max_force_loaded`| Integer | The maximum number of chunks a player may force-load | +|`ftbchunks.chunk_load_offline` | Boolean | Whether the player may keep chunks force-loaded while they are offline | +|`ftbchunks.no_wilderness`| Boolean | Whether the player may break/place blocks in unclaimed chunks | + +### FTB Quests + +| Node | Type | Description | +| ---- | ---- | ---- | +| `ftbquests.editor` | Boolean | Players with this node may edit the quest book without requiring admin permissions | diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Simple Conditions.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Simple Conditions.md new file mode 100644 index 00000000..360e352b --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/Simple Conditions.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 2 +--- +Conditions determine when a rank is implicitly applied to a player. Typically, ranks are awarded based on some player activity, e.g. a "Senior" role can be applied if a player has been on the server for a certain amount of time. + +Simple conditions are so-called because they take no arguments; the condition is simply added to a rank by specifying its name. + +### `always_active` + +```json +{ + member: { + name: "Member" + power: 1 + condition: "always_active" + } +} +``` + +When the `"always_active"` condition is applied to a rank, the rank given to _every_ `player` that joins the server / world. This is typically used as a default rank, and usually has the lowest power level. + +--- + +### `creative_mode` + +```json +{ + admin: { + name: "Admin" + power: 1000 + condition: "creative_mode" + } +} +``` + +When the `"creative_mode"` condition is applied to a rank, the rank is given to any player who is in creative mode. This can be used in various ways, for example. Using KubeJS you can detect if X player enters creative mode & automatically put them back into survival. + +--- + +### `fake_player` + +```json +{ + admin: { + name: "Admin" + power: 1000 + condition: "fake_player" + } +} +``` + +When the `"fake_player"` condition is applied to a rank, the rank is given to any _fake player_. A fake player is a "virtual" player object which many mods use when there is a need to interact with the world like a player, e.g. to break or place blocks, right click blocks, attack entities, etc. Having this condition on a role that prevents blocks from being placed will stop blocks that place things from working. (This will not work on `1.20.4` Forge) + +--- + +### `op` + +```json +{ + admin: { + name: "Admin" + power: 1000 + condition: "op" + } +} +``` + +When the `"op"` condition is applied to a rank, the rank is given to any player that is opped via `/op `. + +--- + +### `spawn` + +```json +{ + admin: { + name: "Admin" + power: 1000 + condition: "spawn" + } +} +``` + +When the `"spawn"` condition is applied to a rank, the rank is given to any player who is currently in the protected spawn chunk range. +:::tip +The spawn protected radius can be found in the `server.properties` file; see the field `"spawn-protection"`. +::: +For more advanced conditions see [Advanced Conditions](). diff --git a/docs/mods/suite/Ranks/index.md b/mods_versioned_docs/version-1.21.1/mods/suite/Ranks/index.md similarity index 100% rename from docs/mods/suite/Ranks/index.md rename to mods_versioned_docs/version-1.21.1/mods/suite/Ranks/index.md diff --git a/mods_versioned_docs/version-1.21.1/mods/suite/Team_Bases/commands.md b/mods_versioned_docs/version-1.21.1/mods/suite/Team_Bases/commands.md new file mode 100644 index 00000000..b49f3a18 --- /dev/null +++ b/mods_versioned_docs/version-1.21.1/mods/suite/Team_Bases/commands.md @@ -0,0 +1,36 @@ +--- +title: Commands +description: A list of commands available in Team Bases. +sidebar_position: 3 +--- + +### Player Commands + +| Command | Description | +|-----------------------|-----------------------------------------| +| `/ftbteambases home` | Teleport to your team base spawn point. | +| `/ftbteambases lobby` | Teleport back to the lobby. | + +### Admin Commands + +| Command | Description | +|-------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| `/ftbteambases create ` | Create a base. | +| `/ftbteambases list` | List all known team bases. The **[Show]** and **[Visit]** buttons can be clicked to show base details, or teleport to the base. | +| `/ftbteambases show ` | Show base details. `` is an existing FTB Teams shortname. | +| `/ftbteambases visit ` | Teleport to a base spawn. `` is an existing FTB Teams shortname. | +| `/ftbteambases visit` | Opens a GUI showing all live bases and optionally all archived bases with some performance info, and the option to visit. | +| `/ftbteambases nether-visit ` | Go to the Nether at the point a Nether portal for this team would take you. | +| `/ftbteambases relocate