Merge branch 'main' of https://github.com/Tofaa2/Tachyon

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -2,12 +2,8 @@
  A lightweight fast multi-threaded 1.8 legacy Minecraft server implementation
 
 
-## Usage
-WARNING: Tachyon is still in development and the API is not stable/ missing certain things such as world data.
-
-## Development
-Tachyon utilizes a plugin system to add features to the server. An example of a plugin can be found in the `example-plugin` directory.
-
+## Usage And Development
+For more information regarding how to work with Tachyon, visit our Gitbooks page.
 
 Example of a Tachyon server configuration file:
 ```json
@@ -68,12 +64,7 @@ Example of a Tachyon server configuration file:
 | proxy.bungee | Whether or not the server is behind a BungeeCord proxy                                                      |
 | proxy.velocity | Whether or not the server is behind a Velocity proxy                                                        |
 
-## Building
-Tachyon uses Gradle as its build system. To build Tachyon, its made from two subprojects, the `api` and the `server` projects.
-To build the full server, run the `shadowJar` project for the `server` project. This will build the server and its dependencies into a single jar file.
-Keep in mind Tachyon depends on JAVA 17 to function.
-
 ## Credits
 
 - [Minestom](https://minestom.net/) for the inspiration and some (a lot) of the code written in this project. Best server software out there for custom development
-- [PacketEvents](https:://github.com/retrooper/packetevents) for some inspiration on how to handle packets and wrappers
+- [PacketEvents](https:://github.com/retrooper/packetevents) for some inspiration on how to handle packets and wrappers