Merge pull request #73 from Erb3-forked/docs

Added docs (using vitepress)

.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+# Based on https://vitepress.dev/guide/deploy#github-pages
+name: Deploy VitePress site to GitHub Pages
+
+on:
+  push:
+    branches: [master]
+  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:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci
+      - name: Build with VitePress
+        run: npm run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -93,3 +93,8 @@ features.toml
 
 
 .vscode/settings.json
+
+# Documentation
+docs/.vitepress/dist
+docs/.vitepress/cache
+node_modules

docs/.vitepress/config.mts

@@ -0,0 +1,36 @@
+import { defineConfig } from 'vitepress';
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'Pumpkin',
+  description: 'Empowering everyone to host fast and efficient Minecraft servers',
+  lang: 'en-US',
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    sidebar: [
+      {
+        text: 'About',
+        items: [
+          { text: 'Introduction', link: '/about/introduction' },
+          { text: 'Quick Start', link: '/about/quick-start' },
+          { text: 'Contributing', link: 'https://github.com/Snowiiii/Pumpkin/blob/master/CONTRIBUTING.md' },
+        ],
+      },
+      {
+        text: 'Plugins',
+        items: [
+          { text: 'About Plugins', link: '/plugins/about' },
+          { text: 'Getting Started in Rust', link: '/plugins/getting-started-rs' },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/Snowiiii/Pumpkin' },
+      { icon: 'discord', link: 'https://discord.gg/RNm224ZsDq' },
+    ],
+
+    logo: '/assets/icon.png',
+  },
+  head: [['link', { rel: 'icon', href: '/assets/favicon.ico' }]],
+});

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

docs/about/introduction.md

@@ -0,0 +1,22 @@
+# Pumpkin
+
+Pumpkin is a Minecraft server built entirely in **Rust**, offering a fast, efficient,
+and customizable experience. It prioritizes performance and player enjoyment while adhering to the core mechanics of the game.
+
+![image](https://github.com/user-attachments/assets/7e2e865e-b150-4675-a2d5-b52f9900378e)
+
+## What Pumpkin wants to achieve
+
+- **Performance**: Leveraging multi-threading for maximum speed and efficiency.
+- **Compatibility**: Supports the latest Minecraft server version and adheres to vanilla game mechanics.
+- **Security**: Prioritizes security by preventing known exploits.
+- **Flexibility**: Highly configurable with the ability to disable unnecessary features.
+- **Extensibility**: Provides a foundation for plugin development.
+
+## What Pumpkin will not
+
+- Provide compatibility with Vanilla or Bukkit servers (including configs and plugins).
+- Function as a framework for building a server from scratch.
+
+> [!IMPORTANT]
+> Pumpkin is currently under heavy development. Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/3) to see current progress

docs/about/quick-start.md

@@ -0,0 +1,41 @@
+# Quick Start
+
+There are currently no release builds, because there was no release :D.
+
+To get Pumpkin running you first have to clone it:
+
+```shell
+git clone https://github.com/Snowiiii/Pumpkin.git
+cd Pumpkin
+```
+
+You also may have to [install rust](https://www.rust-lang.org/tools/install) when you don't already have.
+
+You can place a vanilla world into the Pumpkin/ directory when you want. Just name the World to `world`
+
+Then run:
+
+> [!NOTE]
+> This can take a while. Because we enabled heavy optimizations for release builds
+>
+> To apply further optimizations specfic to your CPU and use your CPU features. You should set the target-cpu=native
+> Rust flag.
+
+```shell
+cargo run --release
+```
+
+## Docker
+
+Experimental Docker support is available.
+The image is currently not published anywhere, but you can use the following command to build it:
+
+```shell
+docker build . -t pumpkin
+```
+
+To run it use the following command:
+
+```shell
+docker run --rm -v "./world:/pumpkin/world" pumpkin
+```

docs/index.md

@@ -0,0 +1,27 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: 'Pumpkin'
+  text: 'Minecraft Server'
+  tagline: Empowering everyone to host fast and efficient Minecraft servers
+  actions:
+    - theme: brand
+      text: Quick Start
+      link: /about/quick-start
+    - theme: alt
+      text: Documentation
+      link: /about/introduction
+    - theme: alt
+      text: For developers
+      link: /plugins/about
+
+features:
+  - title: Written in Rust
+    details: Pumpkin is written 100% in Rust, ensuring memory safety and unmatched performance.
+  - title: Feature complete
+    details: With all vanilla features supported, you will have no issues.
+  - title: Extensible
+    details: Using Extism you can extend Pumpkin to your needs. Play your way!
+---

docs/plugins/about.md

@@ -0,0 +1,15 @@
+# Plugins
+
+Pumpkin uses [Extism](https://extism.org/) for loading plugins.
+This means that you can write your plugins in any language that can compile to Extism WASM.
+These languages include:
+
+- Rust
+- JavaScript / TypeScript
+- Golang
+- C#
+- F#
+- C
+- Haskell
+- Zig
+- AssemblyScript

docs/plugins/getting-started-rs.md

@@ -0,0 +1,4 @@
+# Getting Started in Rust
+
+Rust in one of the supported plugin languages.
+This page has not been written yet.