Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

brought the guide up-to-date and other things #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/files/maploaderterminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/files/modioaccountpanel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/files/orb.png
Binary file not shown.
Binary file removed docs/files/questpatcherinstalledmods.png
Binary file not shown.
Binary file removed docs/files/questpatcherloading.png
Binary file not shown.
Binary file removed docs/files/questpatchermacunverified.png
Binary file not shown.
Binary file removed docs/files/questpatcherotheritems.png
Binary file not shown.
Binary file removed docs/files/questpatcherpatch.png
Binary file not shown.
Binary file removed docs/files/questpatcherpatched.png
Binary file not shown.
Binary file removed docs/files/questpatcherselectmod.png
Binary file not shown.
Binary file removed docs/files/questpatchersmartscreen.png
Binary file not shown.
Binary file removed docs/files/restoreapp.png
Binary file not shown.
Binary file removed docs/files/uninstallapp.png
Binary file not shown.
6 changes: 1 addition & 5 deletions docs/sidebar.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
- **User Guide**
- [Introduction](./)
- [Choose Your Platform](choose-guide)
- **PC Modding**
- **Modding Guide**
- [Beginner's Guide](pc-guide)
- [Updating Mods](pc-updating)
- [Custom Maps](pc-maploading)
- **Quest Modding**
- [Beginner's Guide](quest-guide)
- [Updating Mods](quest-updating)
- [Custom Maps](quest-maploading)
- **Extras**
- [Frequently Asked Questions](../faq)
- **Links**
Expand Down
8 changes: 2 additions & 6 deletions docs/user-guide/chooseguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ Applicable hardware includes:

## ![Oculus Logo](https://icongr.am/simple/oculus.svg?color=A9A9A9&size=24) Quest Modding

If you are using the Oculus Quest version of the game, follow our [**Quest Modding**](quest-guide) guide.
As of September 27, 2021 mods are unavailable for the Meta Quest. You can still use mods with Quest Link and a PC version of the game!

Applicable hardware includes:

- Oculus Quest/Quest 2

> ### [![Oculus Logo](https://icongr.am/simple/oculus.svg?color=A9A9A9&size=18.72)]() [**Continue with Quest Modding**](quest-guide)
> ### [![Steam Logo](https://icongr.am/simple/steam.svg?color=A9A9A9&size=18.72)](pc-guide) [**Continue with PC Modding**](pc-guide)
14 changes: 6 additions & 8 deletions docs/user-guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,22 @@ For live support with this guide please visit us in **#installation-help** on th
### What can you do with mods?

You can:
- Play custom maps with [*Monke Map Loader*](https://monkemaphub.com/)
- Customize your gorilla with custom materials, infected materials, and hats with [*Gorilla Cosmetics*](https://github.com/legoandmars/GorillaCosmetics)
- Jump high with [*Space Monke*](https://github.com/legoandmars/SpaceMonke)
- Change the look of the sky with [*MonkeSkies*](https://github.com/Raemien/MonkeSkies)
- Dash where you look with [*DashMonke*](https://github.com/TrueTamashii/DashMonke)
- Enhance the gorilla computer, see your currently loaded mods, change monitor POV, and more with [*Computer Interface*](https://github.com/ToniMacaroni/ComputerInterface)
- Customize your gorilla with custom materials, infected materials, hats, and holdables with [*Custom Cosmetics*](https://github.com/wryser/CustomCosmetics)
- Use custom shirts, badges and more with [*Gorilla Shirts*](https://github.com/developer9998/GorillaShirts)
- Get a variety of mods all with the press of a button with [*GorillaWatch*](https://github.com/ArtificialGorillas/GorillaWatch)
- Change the background of the gorilla computer with [*Computer Backgrounds*](https://github.com/Striker-67/computer-backgrounds)

There are *many more mods* to discover, and you'll find them in the **Downloads** category on the [GorillaTag Modding Discord](https://discord.gg/b2MhDBAzTv).

### Is modding the game safe?

Modding the game is allowed by the developers of Gorilla Tag, however keep in mind the following:

!> The use of mods that interfere with gameplay inside public lobbies is forbidden by the developers and can result in a ban. Please keep mods contained to private lobbies. **Most gameplay-changing mods automatically disable joining public lobbies, but please be careful.**
!> All mods carry the risk of getting banned. Though you should be fine as long as you're using trusted mods, note that the use of mods that interfere with gameplay inside public lobbies is forbidden by the developers and can result in a ban. Please keep mods contained to modded lobbies. **Most gameplay-changing mods automatically disable joining public lobbies, but please be careful.**

### End Goal

This guide has the end goal of taking a completely unmodified Gorilla Tag installation from vanilla to modded with BepInEx (PC) or QuestLoader (Quest).
This guide has the end goal of taking a completely unmodified Gorilla Tag installation from vanilla to modded with BepInEx.

---

Expand Down
8 changes: 3 additions & 5 deletions docs/user-guide/pc/beginners-guide.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# PC Beginner's Guide
---
>
> This guide only applies to the PC version of Gorilla Tag.
> If you're using a Quest (without Link), go to the [**Quest Modding**](quest-guide) guide.
>

<!-- <div class="horizontal bordered" data-ea-publisher="gorillatagmodding-burrito-software" data-ea-type="image" data-ea-manual="true" id="pc-mod-guide"></div> -->
<!-- Guide Page Ad -->
Expand All @@ -22,8 +18,10 @@

?> This is currently the **recommended mod installer**.

!> Not all mods from Monke Mod Manager are updated to the latest version of the game, it is recommended that you only use it to install BepInEx and get mods from the [Gorilla Tag Modding Group](https://discord.gg/b2MhDBAzTv).

Monke Mod Manager is a mod installer that will install custom mods into Gorilla Tag automatically, and can be re-run in order to update the mods. Monke Mod Manager also notifies you of any updates upon launch by opening the latest release's page if available.
Download Monke Mod Manager from [**Steven's GitHub**](https://github.com/DeadlyKitten/MonkeModManager/releases/latest). Select the **Assets** dropdown and download the .exe file named `MonkeModManager.exe`.
Download Monke Mod Manager from [**Buzz's GitHub**](https://github.com/BzzzThe18th/MonkeModManager/releases/latest). Select the **Assets** dropdown and download the .exe file named `MonkeModManager.exe`.

> Note: If Windows alerts you that the file is unsafe/at risk, choose to keep/run anyway. This is a false-positive.

Expand Down
30 changes: 10 additions & 20 deletions docs/user-guide/pc/pc-maploading.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,23 @@
# PC Custom Maps Installation
---
>
> This guide only applies to the PC version of Gorilla Tag.
> If you're using a Quest (without Link), go to the [**Quest Custom Maps Installation**](quest-maploading) guide.
> This guide applies to the PC and Quest versions of Gorilla Tag and doesn't require a modified version of the game.

?> `.gtmap` files are cross compatible between PC and Quest, so you can crossplay with your friends, on any platform!

## Installing Maps
!> **Make sure to install the Monke Map Loader mod!** You can download it from the [**Monke Mod Manager**](pc-guide#monke-mod-manager).

?> **Don't have the Monke Mod Manager?** Check out the guide to install it [here](pc-guide#monke-mod-manager)!

Once you've installed the Monke Map Loader, you can install custom maps (`.gtmap` files) into your `Gorilla Tag/BepInEx/plugins/MonkeMapLoader/CustomMaps` folder.
## Loading Maps
In game, head to the arcade map and look into one of the VR arcade machines, You should see a count-down. When the count down ends, you will have entered the virtual stump! You may need to accept the Mod.io terms of service. Just to the right you should see something on the wall saying "PRESS THE 'TERMINAL CONTROL' BUTTON TO PROCEED.", follow the instructions and you'll see a list of maps that looks like this:

If you don't know where your Gorilla Tag folder is, there's instructions on how to find it [here](pc-guide#install-folder).
![Map Loader Terminal](../docs/files/maploaderterminal.png)

**Not sure where to download more custom maps?** Head to [monkemaphub.com](https://monkemaphub.com), where you can find all released maps for the map loader. Click the logo below to head there!
You can press enter on a map to see more details. If you'd like to load it, press enter again to download if you haven't already and press enter to load it, wait for the "Map loaded!" confirmation. After that, you can walk putside the stump to join a lobby! Monke!

> [![Monke Map Hub logo](../docs/files/MMHLOGO.png)](https://monkemaphub.com)
## Installing Maps

## Loading Maps
In game, head to the computer and use the arrow keys to select **Monke Map Loader**, then press enter. Press enter again to skip the splash screen, then use the arrow keys to select a map from the list of your currently installed custom maps. You should see an orb with a spinning preview of the map, similar to the one found below.
Right now there isn't any easy way to install maps that haven't officially been added to the loader, however, on occasion people may ask for testing in the [Gorilla Tag Modding Group](https://discord.gg/b2MhDBAzTv), once you download the map, you can play it by connecting your mod.io account with the link panel:

![Orb Preview](../docs/files/orb.png)
![Mod.io Account Panel](../docs/files/modioaccountpanel.png)

You can press enter on a map to see more details. If you'd like to load it, press enter one more time and wait for the "Map loaded!" confirmation. After that, hop in the teleporter! Monke!
Then press option on the terminal to see your downloaded maps!

## Public Lobbies & Custom Maps

?> Although you're normally not supposed to use mods in public matches, the Monke Map Loader implements a special solution that make it OK to do.
When you select a custom map and join a public match by going through the teleporter, you're actually joining a private match that matchmakes you with other people playing that map.
It's only possible to join these matches if you have the Monke Map Loader installed, so joining public matches is not only fine, but recommended.
?> Although you're normally not supposed to use mods in public lobbies, the in-game map-loader has a built in solution that matchmakes you with other people in that map! These lobbies are inaccessable unless you're in the virtual stump.
9 changes: 4 additions & 5 deletions docs/user-guide/pc/pc-updating.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# PC Mod Updating
---
>
> This guide only applies to the PC version of Gorilla Tag.
> If you're using a Quest (without Link), go to the [**Quest Mod Updating**](quest-updating) guide.

<!-- <div class="horizontal bordered" data-ea-publisher="gorillatagmodding-burrito-software" data-ea-type="image" data-ea-manual="true" id="pc-mod-updating"></div> -->
<!-- Guide Page Ad -->
Expand All @@ -15,7 +12,7 @@

## Updating Gorilla Tag

By default, Steam automatically updates Gorilla Tag, and your mods should be compatible. In the case that mods don't load, or if your game crashes, check the [**GorillaTag Modding Discord**](https://discord.gg/b2MhDBAzTv)'s `#announcements` channel for further information, and update any outdated mods by downloading a new version if one exists.
By default, Steam automatically updates Gorilla Tag, and your mods should be compatible. In the case that mods don't load, or if your game crashes, check the [**Gorilla Tag Modding Group**](https://discord.gg/b2MhDBAzTv) for further information, and update any outdated mods by downloading a new version if one exists and temporarily removing ones that aren't updated.

## Updating Mods

Expand All @@ -27,11 +24,13 @@ You can update any mods that are installed via the Monke Mod Manager easily.

To update a mod, simply select any installed mods, and hit the *Install/Update* button to begin the process. When the status monitor in the bottom left says "*Install complete!*", you should be good to go!

!> Not all mods from Monke Mod Manager are updated to the latest version of the game, it is recommended that you only update mods through the [Gorilla Tag Modding Group](https://discord.gg/b2MhDBAzTv).

### Manual Installation

!> Before manually updating mods, you should check the source to see if they have updated or confirmed the mod to work on the latest version.

1. Download the mod(s) you wish to update, whether it be from GitHub, the [GorillaTag Modding Discord](https://discord.gg/b2MhDBAzTv) **#pc-mod-releases** channel, or other sources. **Make sure to download any dependencies required by the mod.**
1. Download the mod(s) you wish to update, whether it be from GitHub, the [Gorilla Tag Modding Group](https://discord.gg/b2MhDBAzTv) **#pc-mod-releases** channel, or other sources. **Make sure to download any dependencies required by the mod.**

![Plugins Folder Preview](../docs/files/pluginsfolder.png)

Expand Down
144 changes: 0 additions & 144 deletions docs/user-guide/quest/beginners-guide.md

This file was deleted.

Loading