Skip to content

Commit

Permalink
add wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
Jab125 committed Oct 12, 2024
1 parent cda27b2 commit 5de77d1
Show file tree
Hide file tree
Showing 9 changed files with 88 additions and 0 deletions.
13 changes: 13 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
plugins {
id 'fabric-loom' version '1.7-SNAPSHOT'
id 'maven-publish'
// id 'org.sinytra.wiki.toolkit' version '0.0.999990'
}

version = project.mod_version
Expand Down Expand Up @@ -34,6 +35,18 @@ repositories {
}
}

// for moddedmc.org
// TODO uncomment when WikiToolkit#1 is merged
//wiki {
// docs {
// // The name of the object (examplemod) should match the registered wiki project ID (if it exists).
// hotjoin {
// // The path to the folder containing the documentation metadata file (sinytra-wiki.json)
// root = file('docs')
// }
// }
//}

fabricApi {
configureDataGeneration()
}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"usage": "Usage",
"faq.mdx": "Frequently Asked Questions"
}
29 changes: 29 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Frequently Asked Questions
---
**Q: Does Hot-Join support 3-4 player splitscreen?**
A: _Hot-Join only supports 2 player splitscreen at the moment, but splitscreen up to 4 players is planned for a future update._

**Q: Does Hot-Join support Steam Deck**
A: _Hot-Join **is** supported on Steam Deck, but only in Desktop mode._

**Q: Is it possible to use multiple monitors?**
A: _Not at the moment._

**Q: How do you use this mod?**
A: _See [Prerequisites](usage/prerequisites)._

**Q: My controller isn't working!**
A: _Check to see if you have a controller mod installed, and have the controller setup with that mod._

**Q: Does clicking the <code><img width={20} height={20} src="https://raw.githubusercontent.com/Jab125/hot-join/refs/heads/develop/docs/.assets/item/hotjoin/start.png" title="Start button" /> Start</code> button to open another instance work with controller mods other than Legacy4J?**
A: _It is planned for a future update._

**Q: Where is the source code for Hot-Join?**
A: _https://github.com/Jab125/hotjoin_

**Q: Where can I report issues?**
A: _https://github.com/Jab125/hotjoin/issues_

**Q: Is there an API for Hot-Join?**
A: _Not at the moment. One is planned for the future, though._
5 changes: 5 additions & 0 deletions docs/usage/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"prerequisites.mdx": "Prerequisites",
"authme.mdx": "Usage with Auth Me",
"legacy4j.mdx": "Usage with Legacy4J"
}
8 changes: 8 additions & 0 deletions docs/usage/authme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Usage with Auth Me
---
If Hot-Join is installed alongside Auth Me, you can start splitscreen by using the `/hotjoin authme microsoft` command, and logging in to a Microsoft account.

<Callout>
You will need to install a controller mod in order to control both instances.
</Callout>
9 changes: 9 additions & 0 deletions docs/usage/legacy4j.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Usage with Legacy4J
---
There are 2 ways to use Legacy4J with Hot-Join.

The preferred method is to click the <code><img width={20} height={20} src="https://raw.githubusercontent.com/Jab125/hot-join/refs/heads/develop/docs/.assets/item/hotjoin/start.png" title="Start button" /> Start</code> button on the controller that you wish to use.

The alternative method is to use the `/hotjoin legacy4j` command. Note that when doing so, you will have to setup the controller manually.
<ModAsset width={1000} location="hotjoin:legacy4jcontrollermethod" />
15 changes: 15 additions & 0 deletions docs/usage/prerequisites.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Prerequisites
---

Hot-Join requires the following mods:
- Fabric API
- Concentration

There are 2 ways of using Hot-Join, either with **Auth Me** or with **Legacy4J**.

To see the relevant pages both, see [Usage with Auth Me](authme) and [Usage with Legacy4J](legacy4j)

<Callout>
After launching the second instance, it may take awhile for the 2nd client to load.
</Callout>
5 changes: 5 additions & 0 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@ pluginManagement {
name = 'Fabric'
url = 'https://maven.fabricmc.net/'
}
maven {
name = 'Sinytra'
url = 'https://maven.sinytra.org/'
}
mavenCentral()
gradlePluginPortal()
mavenLocal()
}
}

0 comments on commit 5de77d1

Please sign in to comment.