Multi instance

docusaurus.config.js → 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,13 +127,19 @@ const config = {
             sidebarId: 'mods',
             position: 'left',
             label: 'Mods',
+            docsPluginId: 'mods',
           },
           {
             type: 'docSidebar',
             sidebarId: 'support',
             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;

docs/mods/others/index.md → 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.
 :::

docs/mods/suite/Backups-3/config.mdx → 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.
 

docs/mods/suite/Essentials/Commands.md → 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 <player>` | Opens the specified players inventory, allowing you to view and modify the inventory's contents.|
 |`/nicknamefor <player> <nickname>` | Forces a nickname on a specific player.|
-|`/mute <player> [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 <player> [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 <player>` | 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 <name>` | Deletes the specified kit.|
-|`/kit create_from_player_inv <name> [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 <name> [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 <name> [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 <name> [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 <name> [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 <name> [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
 

docs/mods/suite/Essentials/Configuration.md → 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).

docs/mods/suite/Essentials/Ranks_Integration.md → 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`.
 

docs/mods/suite/Essentials/Warmups_Cooldowns.md → 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.

docs/mods/suite/Essentials/index.md → 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
 

docs/mods/suite/Library/index.md → 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.

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 <name> <power>` | Y | Creates a rank named `<name>` with the given `<power>` level. The new rank will have no condition attached, or other custom nodes added to it. |
+| `/ftbranks delete <rank>` | Y | Deletes the rank named `<name>`. Take care: this operation can't be undone! |
+| `/ftbranks add <players> <rank>` | Y | Adds the given `<players>` to the given `<rank>`. Entity selectors can be used to add multiple players. |
+| `/ftbranks remove <players> <rank>` | Y | Removes the given `<players>` from the given `<rank>`. Entity selectors can be used to remove multiple players. |
+| `/ftbranks list_ranks_of <player>` | Y | List all the ranks that the given `<player>` currently has. |
+| `/ftbranks list_players_with <rank>` | Y | Lists all the players who currently have the given `<rank>`. |
+| `/ftbranks node <add\|remove\|list> <rank> <node> <value>` | Y | Adds or removes the given node to/from the given `<rank>`. |
+| `/ftbranks condition <rank> <value>` | 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 <rank>` | Y | Dumps the configuration information for the given `<rank>` |
+
+### 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 ""
+```