5zig-reborn · Andre601 · Oct 25, 2021 · Oct 25, 2021 · Oct 25, 2021
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,34 @@
+name: Deploy Site
+
+on:
+  push:
+    paths: 
+    - 'docs/**'
+    - 'mkdocs.yml'
+    branches:
+    - master
+    #
+    # If your repository would have releases should you uncomment the below lines
+    # in order to ignore pushes caused by newly created releases.
+    #
+    #tags-ignore:
+    #- '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]
+    - name: Set up Python 3.7
+      uses: actions/[email protected]
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools
+        python -m pip install -r requirements.txt
+    - name: Deploy Files
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "[email protected]"
+        mkdocs gh-deploy --force
diff --git a/.gitmodules b/.gitmodules
diff --git a/docs/Client_API/home.md b/docs/Client_API/home.md
diff --git a/docs/Client_API/manifest.md b/docs/Client_API/manifest.md
diff --git a/docs/Client_API/updates.md b/docs/Client_API/updates.md
diff --git a/docs/Mod/chat-filter.md b/docs/Mod/chat-filter.md
diff --git a/docs/Mod/fabric.md b/docs/Mod/fabric.md
@@ -5,15 +5,16 @@ Every official release includes a pre-built Fabric jar in the downloads.
 Just drop that file into the Fabric `mods` folder.
 
 ## Unreleased versions
-* First, grab the 5zig Fabric Patcher from [here](https://github.com/5zig-reborn/5zig-fabric/releases/latest), and an up-to-date 5zig mod from
-[here](https://github.com/5zig-reborn/deployments).
 
-* Put both in the Fabric `mods` folder and start Minecraft.
+- First, grab the 5zig Fabric Patcher from [here][5zig-patcher], and an up-to-date 5zig mod from [here][5zig-deployments].
+- Put both in the Fabric `mods` folder and start Minecraft with your Fabric Loader.
+  !!! warning
+      If you have OptiFine or OptiFabric in your `mods` folder prior to installing the patcher, please remove them.  
+      You'll be able to add them once the installation is over.
 
-!!! warning
-    If you have OptiFine or OptiFabric in your `mods` folder prior to installing the patcher, please remove them.
-    You'll be able to add them once the installation is over.
+- If everything went well, you should see a prompt to restart your game.  
+  The installer will automatically delete itself.  
+  You should now see a file ending with `-Fabric.jar` in your `mods` folder.
 
-* If everything went well, you should see a prompt to restart your game.  
-The installer will automatically delete itself.  
-You should now see a file ending with `-Fabric.jar` in your `mods` folder.
+[5zig-patcher]: https://github.com/5zig-reborn/5zig-fabric/releases/latest
+[5zig-deployments]: https://github.com/5zig-reborn/deployments
diff --git a/docs/Mod/home.md b/docs/Mod/home.md
diff --git a/docs/Server_API/home.md b/docs/Server_API/home.md
diff --git a/docs/images/logo.png → docs/assets/images/logo.png b/docs/images/logo.png → docs/assets/images/logo.png
diff --git a/docs/client-api/index.md b/docs/client-api/index.md
@@ -0,0 +1,5 @@
+# Introduction
+The Client API of 5zig Reborn allows you to create plugins for it to add and use.  
+This gives you the ability to enhance and expand 5zig Reborn beyond its default features.
+
+To get started should you read the [Plzgin Manifest](/client-api/manifest.md) page.
diff --git a/docs/client-api/manifest.md b/docs/client-api/manifest.md
@@ -0,0 +1,31 @@
+# The Plugin Manifest
+In order for The 5zig Mod to recognize and load your plugin, you have to include a JSON file called `plugin.json` inside your jar.
+
+## Plugin Manifest Specification
+The manifest should be a dictionary with the following entries:
+
+| Name        | Required?                 | Type     | Description                                                                                                                                               | Example                           |
+| ----------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
+| `main`      | Yes                       | `String` | The main class of the plugin.                                                                                                                             | `com.example.ExamplePlugin`       |
+| `name`      | Required with `updateUrl` | `String` | The name of the plugin.                                                                                                                                   | `Example Plugin`                  |
+| `version`   | Required with `updateUrl` | `String` | The version of the plugin.                                                                                                                                | `1.0.0`                           |
+| `author`    | No                        | `String` | The authors of the plugin.                                                                                                                                | `John Doe, Jane Doe`              |
+| `desc`      | No                        | `String` | A brief description of the plugin.                                                                                                                        | `An example plugin.`              |
+| `license`   | No                        | `String` | The license of the plugin.                                                                                                                                | `MIT`                             |
+| `updateUrl` | No                        | `String` | A URL that will be used for automatic updates. Omitting this will disable that feature. See [Automatic Updates](/client-api/updates.md) for more details. | `https://example.com/update.json` |
+| `icon`      | No                        | `String` | A URL pointing to a (preferably) 32x32 PNG icon.                                                                                                          | `https://example.com/icon.png`    |
+
+Putting all these values will result in:
+
+```json
+{
+  "main": "com.example.ExamplePlugin",
+  "name": "Example Plugin",
+  "version": "1.0.0",
+  "author": "John Doe, Jane Doe",
+  "desc": "An example plugin.",
+  "license": "MIT",
+  "updateUrl": "https://example.com/update.json",
+  "icon": "https://example.com/icon.png"
+}
+```
diff --git a/docs/client-api/updates.md b/docs/client-api/updates.md
@@ -0,0 +1,23 @@
+# Automatic Updates
+If you would like to make your plugin update automatically when a new release is available,
+you have to include an `updateUrl` in the [plugin manifest](/client-api/manifest.md).
+
+!!! info "Note"
+    Users can toggle auto-updating off, so keep in mind this won't always work.
+
+## How it works
+The URL you set in the `plugin.json` should point to a JSON file which contains the following information:
+
+| Name       | Type     | Description                             | Example                          |
+| ---------- | -------- | --------------------------------------- | -------------------------------- |
+| `latest`   | `String` | The latest version of the plugin.       | `1.1.0`                          |
+| `download` | `String` | The download URL of the latest version. | `https://example.com/latest.jar` |
+
+For example:
+
+```json
+{
+  "latest": "1.1.0",
+  "download": "https://example.com/latest.jar"
+}
+```
diff --git a/docs/index.md b/docs/index.md
@@ -1 +1,7 @@
 # 5zig Reborn
+
+Welcome to the documentation of 5zig Reborn.  
+The pages you find here will cover the [Client API](client-api), [specific features of the Mod](mod) and the [Server API](server-api).
+
+## Contribute
+If you find typos or want to contribute in another way can you submit a Pull request for these docs on [our GitHub Repository](https://github.com/5zig-reborn/documentation).
diff --git a/docs/mod/index.md b/docs/mod/index.md
@@ -0,0 +1,2 @@
+# Introduction
+The pages in this sections are about the [placeholders you can use in the chat filter](/mod/placeholders.md) and [how you can install the mod on fabric](/mod/fabric.md).
diff --git a/docs/mod/placeholders.md b/docs/mod/placeholders.md
@@ -0,0 +1,31 @@
+# Placeholders
+Chat Filter, Auto Text, and Join Auto Text support many different placeholders that are automatically evaluated by the mod.  
+All placeholders have the `${placeholder}` syntax. For example, the `username` placeholder would be `${username}`.
+
+## List
+
+| Syntax                 | Description                                                 | Example                                      |
+| ---------------------- | ----------------------------------------------------------- | -------------------------------------------- |
+| `${coords}`            | The coordinates of the player in the format `X, Y, Z`       | `0, 100, 0`                                  |
+| `${coordX}`            | The X coordinate of the player.                             | `0`                                          |
+| `${coordY}`            | The Y coordinate of the player.                             | `100`                                        |
+| `${coordZ}`            | The Z coordinate of the player.                             | `0`                                          |
+|                        |                                                             |                                              |
+| `${clipboard}`         | Acts as a normal paste action (++cmd+v++ / ++ctrl+v++).     | `none`                                       |
+|                        |                                                             |                                              |
+| `${random[<entries>]}` | Selects a random entry from the list.                       | `${random["entry 1", "entry 2", "entry 3"]}` |
+|                        |                                                             |                                              |
+| `${server-ip}`         | Current IP/Domain of the server the player is currently on. | `hypixel.net`                                |
+| `${server-lobby}`      | Name of the server lobby.[^1]                               | `hub-1`                                      |
+| `${server-port}`       | Gives the port used for the server.                         | `25565`                                      |
+| `${server-gamemode}`   | Name of the current gamemode the player plays.[^1]          |                                              |
+|                        |                                                             |                                              |
+| `${time-min}`          | Displays the current time in the format `HH:mm`             | `09:10`                                      |
+| `${time-sec}`          | Displays the current time in the format `HH:mm:ss`          | `09:10:15`                                   |
+|                        |                                                             |                                              |
+| `${username}`          | Shows the name of the player.                               | `SomePlayer`                                 |
+| `${uuid}`              | Shows the UUID of the player.[^2]                           | `bba224a2-0bff-4913-b042-27ca3b60973f`       |
+| `${uuid-stripped}`     | Shows the UUID of the player without the dashes (`-`).[^2]  | `bba224a20bff4913b04227ca3b60973f`           |
+
+[^1]: This may only work if the mod supports the server, either natively or via a plugin.
+[^2]: Available since version 3.13.1
diff --git a/docs/server-api/index.md b/docs/server-api/index.md
@@ -0,0 +1,3 @@
+# Introduction
+
+This page looks a bit empty... :confused:
diff --git a/mkdocs-material b/mkdocs-material
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Introduction
		The pages in this sections are about the [placeholders you can use in the chat filter](/mod/placeholders.md) and [how you can install the mod on fabric](/mod/fabric.md).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Introduction

		This page looks a bit empty... :confused: