From bdb5acf5fcbbdabf8f434b6cf683a3f96cbccccf Mon Sep 17 00:00:00 2001 From: radmanplays <95340057+radmanplays@users.noreply.github.com> Date: Sat, 17 Feb 2024 11:56:52 +0330 Subject: [PATCH] . --- docs/.vitepress/cache/deps/_metadata.json | 14 +++++----- docs/.vitepress/config.ts | 11 ++++++-- .../{apidocs => guide}/how-to-install-mods.md | 0 docs/guide/index.md | 27 +++++++++++++++++++ 4 files changed, 43 insertions(+), 9 deletions(-) rename docs/{apidocs => guide}/how-to-install-mods.md (100%) create mode 100644 docs/guide/index.md diff --git a/docs/.vitepress/cache/deps/_metadata.json b/docs/.vitepress/cache/deps/_metadata.json index b30579d..b4f2c09 100644 --- a/docs/.vitepress/cache/deps/_metadata.json +++ b/docs/.vitepress/cache/deps/_metadata.json @@ -1,31 +1,31 @@ { - "hash": "304bc3a4", + "hash": "4b0757b2", "configHash": "fc81c693", - "lockfileHash": "55458d9a", - "browserHash": "6af3ae63", + "lockfileHash": "7c5de84f", + "browserHash": "a630f1bf", "optimized": { "vue": { "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js", "file": "vue.js", - "fileHash": "b42d0c6a", + "fileHash": "76637531", "needsInterop": false }, "vitepress > @vue/devtools-api": { "src": "../../../../node_modules/@vue/devtools-api/dist/index.js", "file": "vitepress___@vue_devtools-api.js", - "fileHash": "340713bb", + "fileHash": "23b35625", "needsInterop": false }, "vitepress > @vueuse/core": { "src": "../../../../node_modules/@vueuse/core/index.mjs", "file": "vitepress___@vueuse_core.js", - "fileHash": "876e7a60", + "fileHash": "b4a83756", "needsInterop": false }, "@theme/index": { "src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js", "file": "@theme_index.js", - "fileHash": "93b83dbd", + "fileHash": "388cf2b0", "needsInterop": false } }, diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 5951bf3..4bb0231 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -8,6 +8,7 @@ export default defineConfig({ themeConfig: { nav: [ + { text: 'EaglerForge Guide', link: '/guide/' }, { text: 'API Docs', link: '/apidocs/' }, // { @@ -23,13 +24,19 @@ export default defineConfig({ ], sidebar: [ + { + text: 'Guide', + collapsed: false, + items: [ + { text: 'Compiling EaglerForge', link: '/guide/' }, + { text: 'How to Install Mods', link: '/guide/how-to-install-mods' }, + ], + }, { text: 'Getting started', collapsed: false, items: [ - { text: 'How to Install Mods', link: '/apidocs/how-to-install-mods' }, { text: 'Introduction', link: '/apidocs/' }, - // ... ], }, ], diff --git a/docs/apidocs/how-to-install-mods.md b/docs/guide/how-to-install-mods.md similarity index 100% rename from docs/apidocs/how-to-install-mods.md rename to docs/guide/how-to-install-mods.md diff --git a/docs/guide/index.md b/docs/guide/index.md new file mode 100644 index 0000000..7932889 --- /dev/null +++ b/docs/guide/index.md @@ -0,0 +1,27 @@ +# Compiling EaglerForge + +## Prerequisites +1. Ownership of Minecraft: Java Edition (its OK if you have gamepass) +2. A Windows/Mac/Linux computer +3. FFMPEG (you can download it [here](https://ffmpeg.org/download.html)) +4. At least Java 11 +--- +## Actually compiling the client +First, download the repository to your computer. Then, extract it. +
+Windows +
+ 1. Double click CompileLatestClient.bat, a GUI resembling a classic windows installer should open +
+ 2. Follow the steps shown to you in the new window to finish compiling +
+
+MacOS/Linux +
+ 1. Open a terminal in the folder the repository was cloned to +
+
2. Type chmod +x CompileLatestClient.sh and hit enter
+
3. Type ./CompileLatestClient.sh and hit enter, a GUI resembling a classic windows installer should open +
+
Follow the steps shown to you in the new window to finish compiling
+