Port existing pages to MKDocs

11 files changed, 302 insertions, 1 deletions

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
new file mode 100644
index 0000000..3bf0173
--- /dev/null
+++ b/.github/workflows/deploy.yml
@@ -0,0 +1,24 @@
+name: Deploy
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
\ No newline at end of file
diff --git a/README.md b/README.md
index 6c8221e..c3503dc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,5 @@
 # SkyBlockModWiki
-SkyBlock Mod Wiki v2
+The SkyBlock Mod Wiki is a reference for the usage of modifications (mods for short) on Hypixel SkyBlock.
+It is intended to introduce new users to mods and be a reference to the variety of different features and settings each mod offers.
+
+Made with [Material for MKDocs](https://github.com/squidfunk/mkdocs-material)
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..8369b3a
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,11 @@
+# Home
+
+The SkyBlock Mod Wiki is a reference for the usage of modifications (mods for short) on Hypixel SkyBlock.
+It is intended to introduce new users to mods and be a reference to the variety of different features and settings each mod offers.
+
+## Getting Started with Mods on Hypixel SkyBlock
+- [How to Install Mods](tutorials/how-to-install-mods.md)
+- [SkyBlock Mod List](mod-lists/skyblock-mod-list.md)
+- [General Mod List](mod-lists/general-mod-list.md)
+
+This resource is created by SkyBlock players. It is not associated with or endorsed by Hypixel Inc.
\ No newline at end of file
diff --git a/docs/mod-lists/general-mod-list.md b/docs/mod-lists/general-mod-list.md
new file mode 100644
index 0000000..60097a7
--- /dev/null
+++ b/docs/mod-lists/general-mod-list.md
@@ -0,0 +1,67 @@
+# General Mod List
+!!! note
+    This list is a work in progress so some mods may be missing and many mods do not yet have main pages.
+
+These are mods that are not SkyBlock-specific but are often used by SkyBlock players.
+
+### Optifine
+Adds many visual fixes and improvements to Minecraft, provides support for shader packs and advanced texture pack features
+
+- Download: https://optifine.net/downloads
+    - Click "Show all versions" and scroll down to find 1.8.9
+- Support: https://discord.gg/optifine
+
+### Patcher
+Fixes issues with Minecraft 1.8.9 and adds some additional customization options
+
+- Download: https://sk1er.club/mods/patcher
+- Support: https://discord.gg/sk1er
+
+### ReplayMod
+Records gameplay by recording movements, allowing the recording to be viewed from any angle
+
+- Download: https://www.replaymod.com/download/
+- Documentation: https://www.replaymod.com/docs/
+- Support: https://discord.gg/5GR7RSb
+
+### SimpleToggleSprint
+Toggles sprint on and off instead of requiring the sprint key to be held down
+
+- Download: https://github.com/My-Name-Is-Jeff/SimpleToggleSprint/releases
+- Support: https://discord.gg/skytils
+
+### Scrollable Tooltips
+Adds scrolling to item tooltips, useful for super long SkyBlock item stats
+
+- Download: https://sk1er.club/mods/text_overflow_scroll
+- Support: https://discord.gg/sk1er
+
+### Sk1er Old Animations
+Adds Minecraft 1.7 animations to 1.8.9
+
+- Download: https://sk1er.club/beta
+- Support: https://discord.gg/sk1er
+
+### ChatTriggers
+Adds support for Minecraft mods written in Javascript
+
+- Download: https://www.chattriggers.com/
+- Support: https://discord.gg/chattriggers
+
+### AutoTip
+Tips Hypixel boosters at a regular interval
+
+- Download: https://sk1er.club/mods/autotip
+- Support: https://discord.gg/sk1er
+
+### QuickPlay
+Shortcut menu for faster navigation to Hypixel mini-games
+
+- Download: https://bugg.co/quickplay/
+- Support: https://bugg.co/quickplay/discord
+
+### LevelHead
+Displays Hypixel player stats above players' heads
+
+- Download: https://sk1er.club/mods/level_head
+- Support: https://discord.gg/sk1er
\ No newline at end of file
diff --git a/docs/mod-lists/skyblock-mod-list.md b/docs/mod-lists/skyblock-mod-list.md
new file mode 100644
index 0000000..e6d9327
--- /dev/null
+++ b/docs/mod-lists/skyblock-mod-list.md
@@ -0,0 +1,67 @@
+# SkyBlock Mod List
+!!! note
+    This list is a work in progress so some mods may be missing and many mods do not yet have main pages.
+
+This is a quick reference list of many of the common mods for SkyBlock and their official download locations.
+Click on the "Main Page" link under a mod's name for more detailed information about that mod.
+
+## Mods
+
+### NotEnoughUpdates
+- Download: https://github.com/NotEnoughUpdates/NotEnoughUpdates/releases
+- Support: https://discord.gg/moulberry
+
+### SkyBlockAddons
+!!! warning
+    This mod is no longer being maintained. Some features still work but new issues will not be fixed.
+
+SkyBlockAddons was one of the first SkyBlock mods when it first released in 2019. It adds over a hundred small tweaks that improve the player experience. Examples include more legible health and mana bars, a better enchanting table GUI (removed after Hypixel improved the original GUI), the power orb status display, Discord realtime presence, and the slayer tracker.
+
+- Download: https://github.com/BiscuitDevelopment/SkyblockAddons/releases
+- Support: https://discord.gg/PqTAEek
+
+### Skytils
+- Download: https://github.com/Skytils/SkytilsMod/releases
+- Support: https://discord.gg/skytils
+
+### SkyBlock Extras
+- Download: https://sbewebsite.appspot.com/
+- Support: https://discord.gg/sbe
+
+### Dungeons Guide
+- Download: https://github.com/Dungeons-Guide/Skyblock-Dungeons-Guide/releases
+- Support: https://discord.gg/vuGsXhY5Bv
+
+### Fancy Warp Menu
+Fancy Warp Menu is a rewrite of SkyBlock Addons' fancy warp menu for improved performance and customization. It supports custom layouts and textures installed as resource packs.
+
+- Download: https://github.com/ILikePlayingGames/FancyWarpMenu/releases
+- Support: https://discord.gg/tXFf9umfA9
+
+### SkyHanni
+- Download: https://github.com/hannibal002/SkyHanni/releases
+- Support: https://discord.gg/8DXVN4BJz3
+
+### SkyBlockPersonalized
+- Download: https://github.com/Cobble8/SkyblockPersonalized/releases
+- Support: https://discord.gg/QXA3y5EbNA
+
+### Dulkir Mod
+- Download: https://github.com/inglettronald/DulkirMod
+- Support: https://discord.gg/WnJwrNZQSn
+
+### Partly Sane Skies
+- Download: https://github.com/PartlySaneStudios/partly-sane-skies/
+- Support: https://discord.gg/v4PU3WeH7z
+
+## ChatTriggers Modules
+These require [ChatTriggers](https://www.chattriggers.com) to be installed first.
+ChatTriggers is a mod loader that allows mods to be written in JavaScript instead of Java.
+
+### BetterMap
+- Download: https://github.com/BetterMap/BetterMap/
+- Support: https://discord.gg/Uq5YzpaMsr
+
+### SoopyV2
+- Download: https://github.com/Soopyboo32/SoopyV2
+- Support: https://discord.gg/dfSMq96RSN
diff --git a/docs/tutorials/how-to-find-crash-reports-and-logs.md b/docs/tutorials/how-to-find-crash-reports-and-logs.md
new file mode 100644
index 0000000..eaee5c0
--- /dev/null
+++ b/docs/tutorials/how-to-find-crash-reports-and-logs.md
@@ -0,0 +1,42 @@
+# How to Find Crash Reports and Logs
+Crash reports and logs are text files that record information about the state of the game while it is running.
+They are useful for reviewing what happened in previous game sessions (e.g. reviewing old chat messages) or tracing the steps that led up to a game crash.
+
+## Opening the Game Folder
+The game folder, also known as the `.minecraft` folder, is the place where all of Minecraft's settings, logs, and mods are located. The steps below describe how to locate and open this folder.
+
+1. Open the Minecraft Launcher
+2. Select "Minecraft: Java Edition" from the column on the left if it's not already selected
+3. Click the "Installations" tab on the top
+   ![A screenshot of the Minecraft Launcher Java Edition home page with a red arrow pointing towards the "Installations" tab on the top|thumb|Minecraft Java Edition home page with an arrow pointing at the "Installations" tab](img/Minecraft%20Launcher%20Java%20Edition%20Home.png)
+4. Hover over your Forge installation and click the folder icon to open your game folder
+   ![A screenshot of the Minecraft Launcher Installations tab with an installation named "forge" highlighted and an arrow pointing to the folder icon to the right of the installation name](img/Minecraft%20Launcher%20Java%20Edition%20Installations%20Tab.png)
+5. Go to the folder named `crash-reports` in the game folder. The crash reports are located inside it.
+6. Look at the "Date Modified" column beside the file names and find the crash report file that corresponds to the date and time the crash happened.
+
+## Locating Crash Reports
+Crash reports are text files that contain details about what the game was doing when it crashed.
+If you encounter a crash while using mods and ask the mod developer for help, the crash report is one of the first things they will ask for.
+
+1. Go to the folder named `crash-reports` in the game folder. The crash reports are located inside it.
+2. Look at the "Date Modified" column beside the file names and find the crash report file that corresponds to the date and time the crash happened.
+
+## Locating JVM Crash Reports
+!!! warning
+    Be careful when sharing JVM crash reports. They contain your Minecraft access token, which can be used by others to log in to your account.
+
+JVM crash reports are a different kind of crash report that is generated when the Java Runtime Environment, the program Minecraft runs on top of, crashes.
+If the exit code shown on the Minecraft Launcher's game crash notification is not 1 or -1, it is likely that one of these was generated.
+
+1. Go to the game folder.
+2. Look for files with names starting with `hs_err_pid` followed by a number (e.g. `hs_err_pid12345.log`).
+3. Look at the "Date Modified" column beside the file names and find the log file that corresponds to the date and time the issue happened.
+
+## Locating Logs
+!!! warning
+    Be careful when sharing logs. They contain chat messages, which may contain sensitive information.
+
+Logs are text files that record information about events that happen while the game is running, such as chat messages. They may be required to diagnose issues where the game does not crash.
+
+1. Go to the folder named `logs` in the game folder. The logs are located inside it.
+2. Look at the "Date Modified" column beside the file names and find the log file that corresponds to the date and time the issue happened.
diff --git a/docs/tutorials/how-to-install-mods.md b/docs/tutorials/how-to-install-mods.md
new file mode 100644
index 0000000..f2c9b33
--- /dev/null
+++ b/docs/tutorials/how-to-install-mods.md
@@ -0,0 +1,52 @@
+# How to Install Mods
+This guide is written for Minecraft 1.8.9. A guide for newer versions will be written once Hypixel and mod developers start to support them.
+
+## Install Java
+Java is required to run the Minecraft Forge installer. Please install the latest version from Oracle [here](http://java.com/download).
+
+## Install Minecraft Forge
+Minecraft Forge is a mod loader that provides basic functionality that all mods depend on. You need to install Forge before installing any mods.
+
+1. Close the Minecraft Launcher if it is open. The Minecraft Forge installer changes a file in the launcher so it might break if the launcher is open.
+2. Download Minecraft Forge for Minecraft 1.8.9 from the [Minecraft Forge website](https://maven.minecraftforge.net/net/minecraftforge/forge/1.8.9-11.15.1.2318-1.8.9/forge-1.8.9-11.15.1.2318-1.8.9-installer.jar).
+3. After the download starts, your browser will warn you that the file may harm your computer. This warning displays for all downloaded Java programs. Minecraft Forge is safe so you can click "Keep File" or "Trust File". The text may vary depending on the browser.
+4. Double-click the file you downloaded and the Minecraft Forge installer should open. If your computer asks you to select a program to open the file, please make sure Java is installed.
+5. Don't change any of the options on the installer screen and click "OK" to begin the installation. It will start the installation and show a prompt when it's finished. Click "OK" to close the installer.
+
+## Creating a Minecraft Launcher Profile
+We recommend creating a new launcher profile to store your Minecraft Forge settings in a separate folder. If you store the settings for different Minecraft versions in the same ".minecraft" folder, the different versions will overwrite each others' settings and the game will stop working.
+
+1. Open the Minecraft Launcher. After Minecraft Forge is installed, you may see a new profile named "forge"  with a furnace icon to the left of the "PLAY" button. We will not use this profile since it may be overwritten if you install a different Minecraft Forge version.
+2. Click the "Installations" button at the top of the launcher.
+3. Click "New installation." A prompt will appear with a list of options for the new profile.
+![A screenshot of the new installation prompt showing the available installation options](img/Create%20Minecraft%20Launcher%20Installation%20Menu.png)
+4. Set the `Name` option to the name you want for the new installation. It is set to "Minecraft Forge 1.8.9" in the screenshot above.
+5. Set the `Version` option to "release 1.8.9-forge1.8.9-11.15.1.2318-1.8.9". Click the text box, start typing "forge", and it will show that option as a suggestion you can click on. Click on the suggestion and it'll set the option for you.
+6. For the `Game Directory` option, click "BROWSE" beside the text field and a file picker will open.
+    1. **Windows**
+        1. Click the "Roaming" folder to select it.
+        2. Click "Make New Folder" in the bottom left and give the new folder a name, like ".minecraft-1.8.9". Click to the right of the name text box to set the folder name.
+        3. Make sure the new folder is selected and click "OK". The folder path should now appear in the "Game Directory" text box.
+    2. **macOS**
+        1. Right-click the "assets" folder and click "Show in Finder". A new Finder window will open.
+        2. In the new window, click "minecraft" at the top middle and click "Application Support" in the menu that opens.
+        3. Click the three dots to beside the search icon in the top right corner of the window and click "New Folder".
+        4. Enter a name for the new folder like "minecraft-1.8.9" and press Enter to set the name.
+        5. Go back to the Minecraft Launcher and click "minecraft" with a folder icon beside it. The button should be located to the left of the search bar. Then click "Application Support" in the menu that opens.
+        6. In the far right column, scroll down until you see the new folder you created. Click on it to select it and press "Open" in the bottom right corner of the window. The folder path should now appear in the "Game Directory" text box.
+7. Click "Save" in the bottom right corner of the window to save your new profile.
+8. Hover over your new profile and click "Play". Wait for the game to reach the main menu to make sure it runs correctly. If it runs correctly, you can now install mods.
+
+# Choose a Default Minecraft Launcher Profile
+You can set the default launcher profile, which is launched when the big "PLAY" button is pressed on the launcher's main page.
+
+1. On the launcher's main page, click on the profile to the left of the big "PLAY" button. It is an icon of a block, like a crafting table, anvil, or furnace, with the profile name and version beside it.
+2. Click on a profile from the dropdown menu that opens. You have now changed your default launcher profile.
+
+# Install Mods
+You can find mods at the mod lists linked on the [home page](../index.md).
+
+1. Go to the "Installations" tab in the Minecraft Launcher and hover over the installation you created in the above section. Click the folder icon on the right and your game folder will open.
+2. Go into the folder named "mods" or create it if it doesn't exist.
+3. Drag the mods you downloaded into the "mods" folder.
+4. Close the window and go back to the "Installations" tab. Hover over the installation from step one and click "Play" this time. The game will now start with your mods installed.
diff --git a/docs/tutorials/img/Create Minecraft Launcher Installation Menu.png b/docs/tutorials/img/Create Minecraft Launcher Installation Menu.png
new file mode 100644
index 0000000..9fb422b
--- /dev/null
+++ b/docs/tutorials/img/Create Minecraft Launcher Installation Menu.png
diff --git a/docs/tutorials/img/Minecraft Launcher Java Edition Home.png b/docs/tutorials/img/Minecraft Launcher Java Edition Home.png
new file mode 100644
index 0000000..fcf349b
--- /dev/null
+++ b/docs/tutorials/img/Minecraft Launcher Java Edition Home.png
diff --git a/docs/tutorials/img/Minecraft Launcher Java Edition Installations Tab.png b/docs/tutorials/img/Minecraft Launcher Java Edition Installations Tab.png
new file mode 100644
index 0000000..969fd96
--- /dev/null
+++ b/docs/tutorials/img/Minecraft Launcher Java Edition Installations Tab.png
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..3dd1e3f
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,35 @@
+site_name: SkyBlock Mod Wiki
+repo_name: ILikePlayingGames/SkyBlockModWiki
+repo_url: https://github.com/ILikePlayingGames/SkyBlockModWiki
+edit_uri: edit/main/docs
+theme:
+  name: material
+  features:
+    - content.action.edit
+    - content.action.view
+    - navigation.instant
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tracking
+    - navigation.top
+  icon:
+    repo: fontawesome/brands/github
+markdown_extensions:
+  - admonition
+  - attr_list
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.magiclink
+  - pymdownx.superfences
+  - toc:
+      permalink: true
+nav:
+  - Home: 'index.md'
+  - Tutorials:
+      - How to Install Mods: 'tutorials/how-to-install-mods.md'
+      - How to Find Crash Reports and Logs: 'tutorials/how-to-find-crash-reports-and-logs.md'
+  - Mod Lists:
+      - SkyBlock Mod List: 'mod-lists/skyblock-mod-list.md'
+      - General Mod List: 'mod-lists/general-mod-list.md'