feat: wiki

Mr-EmPee · May 29, 2024 · 73f2e40 · 73f2e40
1 parent 5c07e08
commit 73f2e40
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,22 @@
+# Mystical Barriers
+
+This plugin provides a unique and customizable way to define barriers that are visible and interactive only to a subset of players. These barriers can be used to limit access to specific areas, creating exclusive zones or protected regions within your game environment.
+
+## Purpose
+
+The primary purpose of MysticalBarriers is to offer server administrators a tool to control player movement and interaction in a dynamic and flexible manner. By implementing these barriers, you can:
+
+- Restrict access to certain areas based on player roles or permissions.
+- Create private or exclusive zones for specific player groups.
+- Enhance game mechanics by introducing new strategic elements involving barrier usage.
+- Ensure controlled entry points in event scenarios or special locations.
+
+## Features
+- **Single Block Barriers**: Create simple, single-block barriers that are easy to set up and manage.
+- **Complex Structures**: Build your own custom barriers that can appear and disappear
+
+- **Visibility Control**: Barriers are only visible and interactive to the subset of players you define, ensuring privacy and controlled access.
+- **Projectile Blocking**: Barriers are not just for show; they effectively block projectiles, adding an extra layer of strategy to your gameplay.
+
+- **User-Friendly Commands**: Simple commands to create, manage, and configure barriers without extensive setup.
+- **Permission-Based Access**: Define which players or groups can see and interact with the barriers using a flexible permission system.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,2 @@
+* [Home](/)
+* [Guide](guide.md)
diff --git a/docs/guide.md b/docs/guide.md
@@ -0,0 +1,28 @@
+## Creating a barrier
+To create a barrier you first need to **select the area of your barrier**, in order
+to that you need you a barrier wand
+
+```
+/mb wand
+```
+
+Use your barrier wand by right-clicking on a block to select the two corners of your barrier.
+After having selected the corners execute
+
+```
+/mb create <barrier-name>
+```
+
+replace `<barrier-name>` with a name of your choice. To test it try to set the permission `mysticalbarriers.bypass.<barrier-name>` to `false`
+
+## Managing a barrier
+To access the management GUI of a barrier you need to execute
+
+```
+/mb edit <barrier-name>
+```
+
+from there you can:
+- Modify the barrier material/structure
+- Modify the barrier visibility range
+- Delete the barrier
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>MysticalBarriers</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css">
+</head>
+<body>
+  <div id="app"></div>
+
+  <script>
+    window.$docsify = {
+      name: 'MysticalBarriers',
+      repo: 'https://github.com/Mr-EmPee/MysticalBarriers',
+      loadSidebar: true,
+      subMaxLevel: 25
+    }
+  </script>
+
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-java.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js" type="text/javascript"></script>
+</body>
+</html>