Skip to content

Commit

Permalink
.
Browse files Browse the repository at this point in the history
  • Loading branch information
radmanplays committed Feb 17, 2024
1 parent fd2d29a commit bdb5acf
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 9 deletions.
14 changes: 7 additions & 7 deletions docs/.vitepress/cache/deps/_metadata.json
Original file line number Diff line number Diff line change
@@ -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
}
},
Expand Down
11 changes: 9 additions & 2 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export default defineConfig({

themeConfig: {
nav: [
{ text: 'EaglerForge Guide', link: '/guide/' },
{ text: 'API Docs', link: '/apidocs/' },

// {
Expand All @@ -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/' },
// ...
],
},
],
Expand Down
File renamed without changes.
27 changes: 27 additions & 0 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -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.
<details>
<summary>Windows</summary>
<br>
1. Double click CompileLatestClient.bat, a GUI resembling a classic windows installer should open
</br>
2. Follow the steps shown to you in the new window to finish compiling
</details>
<details>
<summary>MacOS/Linux</summary>
<br>
1. Open a terminal in the folder the repository was cloned to
</br>
<br>2. Type chmod +x CompileLatestClient.sh and hit enter</br>
<br>3. Type ./CompileLatestClient.sh and hit enter, a GUI resembling a classic windows installer should open
</br>
<br>Follow the steps shown to you in the new window to finish compiling</br>
</details>

0 comments on commit bdb5acf

Please sign in to comment.