diff --git a/content/docs/advanced/meta.json b/content/docs/advanced/meta.json new file mode 100644 index 0000000..4b1cd2d --- /dev/null +++ b/content/docs/advanced/meta.json @@ -0,0 +1,5 @@ +{ + "title": "Advanced", + "pages": ["private-server"], + "defaultOpen": false +} diff --git a/content/docs/advanced/private-server.mdx b/content/docs/advanced/private-server.mdx new file mode 100644 index 0000000..2091b4d --- /dev/null +++ b/content/docs/advanced/private-server.mdx @@ -0,0 +1,68 @@ +--- +title: Private Server Setup +--- + +import {Tab, Tabs} from 'fumadocs-ui/components/tabs'; +import {File, Folder, Files} from 'fumadocs-ui/components/files'; + +## Starting a server + +In each of the mod file folders we provide server files as well (one for each operating system), you can use these files to run your own server. + + + + Download `server-win.exe` and run that file. + + + Download `server-mac`. Once you download that open terminal and navigate to where that file is + by running + ```sh + cd /path/to/directory/where/server-mac/is + ``` + + Then, run + ```sh + chmod +x server-mac + ``` + + After that you can run + + ```sh + ./server-mac + ``` + to run the server. + + + +## Connecting to the server + +Once the server is running you will have to modify your config to point to the server. +To modify your config go to the location where your `Mods` folder is, +beside that folder will be another folder called `config`, inside the `config` folder will be a file called `Multiplayer.jkr`. +If this file is not there for you then you need to launch the game with the Multiplayer mod installed at least once. + + + + + + + + + + + +The contents of this file will look something like this by default: + +```lua +return { + ["username"] = "Guest", + ["server_url"] = "balatro.virtualized.dev", + ["server_port"] = 8788, +} +``` + +If you are running the server on your computer you can change the `server_url` field to `"localhost"`, +but your friends will have to connect to you over the internet or through a tunnel service like Hamachi or ZeroTier. + +For them to connect over the internet you will have to port forward port `8788` on your PC and router, +then they will have to input your public IP address in the `server_url`. You can find your public IP address by going to a site like this: https://www.whatismyip.com. \ No newline at end of file diff --git a/content/docs/getting-started/faq.mdx b/content/docs/getting-started/faq.mdx new file mode 100644 index 0000000..1d6c59c --- /dev/null +++ b/content/docs/getting-started/faq.mdx @@ -0,0 +1,157 @@ +--- +title: FAQ +--- + +import {DownloadIcon} from "lucide-react"; +import {Steps, Step} from "fumadocs-ui/components/steps"; +import {Tab, Tabs} from 'fumadocs-ui/components/tabs'; + +## How does the mod work? + +When you install the mod you will have two extra buttons on the main menu to start a lobby and to join a lobby. +The person who starts the lobby will be given game mode options and are able to invite others by sending them a code. +For the most popular game mode, each player will play the small and big blinds normally, and each boss blind +will be a PvP blind where you are trying to beat the other player's score. +You won't lose when you fail a blind, but you will lose a life every time you lose to the other person, +and there are lobby options set by the lobby host to modify how the game modes work or change +the amount of lives each player has. + +## I don't know how to or am having trouble installing the mod, what do I do? + +There is instructions for installing the mod +[here.](/docs/getting-started/installation) +If you followed the instructions and are still having trouble you can open a support ticket in +the [Discord server](https://discord.com/channels/1226193436521267223/1227357106064326727) +and a Developer, Admin, or Helper will help you ASAP. + +## Do I need to start a server to play with my friends? + +**TL;DR:** No, there is an official one. + +**Long answer:** + +No, there is an official server that you will automatically connect to +when you start the game with the mod installed, +although if you have problems connecting or want to host a private server you can follow these instructions: + + + Host your own server for your friends to connect to. + + +## Can you play with more than 2 people? + +**TL;DR:** Not yet. + +**Long answer:** + +Not right now but there is a Battle Royale mode being worked on and tested actively which will allow up to 8 players. + +## Is there a co-op mode? + +**TL;DR:** Not yet. + +**Long answer:** + +There have been many ideas for co-op modes posted in +[# old_suggestions](https://discord.com/channels/1226193436521267223/1226416122685816914), +we don't have a co-op mode right now, but it is planned. +If you have an idea for how a co-op mode would work, feel free send a suggestion in. + +## I am having an issue installing the mod or crash when I launch Balatro, what should I do? + +Open a support ticket by going to +our [Discord server](https://discord.com/channels/1226193436521267223/1227357106064326727) +and pressing "Open support thread." +This will create a private thread in the support channel where a Developer, Admin or Helper +will respond as soon as someone is available. + +## I am not able to connect to the Multiplayer server, what should I do? + +The first thing you can do is open a +[ticket](https://discord.com/channels/1226193436521267223/1227357106064326727) +to try and figure out if it is a fixable problem, but sometimes you may not be able to connect to the server due to your network or country. +In the case that you cannot connect to the server you and your friends will have to play on a private server, +you can follow these instructions: + + + Host your own server for your friends to connect to. + + +## Is the Multiplayer mod compatible with other mods? + +The Multiplayer mod **should be compatible with most other mods** that use Steamodded version **1.0.0 or higher** or Lovely directly. +If there is a mod that is problems or crashes with the Multiplayer mod you can submit a bug report +in [# bug-report](https://discord.com/channels/1226193436521267223/1226614033503752253), +and we will try and make the Multiplayer mod compatible with it. + +## I want to try this mod, but I don't have anyone to try it with, how can I find people in this server that want to play + +**TL;DR:** Go to [# custom-lfg.](https://discord.com/channels/1226193436521267223/1226597231289827458) + +**Long answer:** + +There is a role in +[# roles](https://discord.com/channels/1226193436521267223/1227405578268315708) +that anyone can give themselves called **The Lovers (LFG)**, +anyone who has this role is welcoming pings in the +[# custom-lfg](https://discord.com/channels/1226193436521267223/1226597231289827458) +channel. If you want to find someone to play with you can ping the LFG role in the +[# custom-lfg](https://discord.com/channels/1226193436521267223/1226597231289827458) +channel and ask if anyone wants to play. Alternatively if you give yourself the role +you will be pinged when someone else is looking for someone to play. + +## Is there a way to see your opponents jokers or hands? + +**TL;DR:** Not yet. + +**Long answer:** + +No, not right now, but this will probably be implemented as a mechanic in a future update, +such as having a joker or voucher that tells you what the opponent's jokers are. + +## I don't want to or can't play on the official server, how do I open a private server? + +You can follow these instructions: + + Host your own server for your friends to connect to. + + +## When I download Lovely my browser and antivirus tell me that it is dangerous, is it safe? + +**TL;DR:** Lovely is safe. + +**Long answer:** +The reason that lovely is marked as a virus by your browser and antivirus software is because it is a trojan (just not the bad kind). +What lovely does is takes the code of all the mods in your mods folder and injects it into Balatro so that the mods can modify +Balatro's code directly. This is dangerous when used by a bad actor because they could inject something dangerous into something +you run all the time, this dangerous injection could steal your information, hold your files hostage, or control your computer. +So, although Lovely is injecting stuff into your Balatro exe it is not doing anything dangerous. +**You should be careful of the mods you install** though, any mod that is injected into Balatro will have full access to your computer as +if it was Balatro trying to do those things which makes it much harder to detect. + + +## Does the mod work if I don't use Steam (App Store/Mobile/Switch/Console/etc)? + +**TL;DR:** No. + +**Long answer:** + +No, not only will you not be able to mod those versions easily, +the game differs from platform to platform so the mod may not even work on another platform even if you could mod it. + +## Will we be putting the mod on platforms like Thunderstore mod manager? + +The mod is probably compatible with Thunderstore mod manager as of 0.1.6 but as Steamodded is not updated past 0.9.8 on +Thunderstore it wouldn't make sense for us to upload it there. +Every multiplayer version past 0.1.3 requires Steamodded 1.0.0+. +If Steamodded gets updated on Thunderstore we will look into supporting Thunderstore more seriously. +If you are a die hard Thunderstore fan you could probably add our mod and Steamodded 1.0.0 as local mods and see if it works properly. \ No newline at end of file diff --git a/content/docs/getting-started/installation.mdx b/content/docs/getting-started/installation.mdx new file mode 100644 index 0000000..f05ce41 --- /dev/null +++ b/content/docs/getting-started/installation.mdx @@ -0,0 +1,68 @@ +--- +title: Installation +--- + +import {DownloadIcon} from "lucide-react"; +import {Steps, Step} from "fumadocs-ui/components/steps"; +import {Tab, Tabs} from 'fumadocs-ui/components/tabs'; + +## General Instructions + + + + + ### Install Lovely and Steamodded + Follow the guide here to install: https://github.com/Steamopollys/Steamodded/wiki + + + + + + ### Download the latest version of the Multiplayer mod + + + + + + ### Add the mod to your `Mods` folder + + Unzip the `Multiplayer.zip` file and put the folder in the Mods folder described by the Steamodded instructions. + + +> + + + +If you need any further help or run into any problems feel free to open a ticket [in the Discord server.](https://discord.com/channels/1226193436521267223/1227357106064326727) + +## Video Instructions + + + + + + + + + + + + + + + diff --git a/content/docs/getting-started/meta.json b/content/docs/getting-started/meta.json new file mode 100644 index 0000000..992fc96 --- /dev/null +++ b/content/docs/getting-started/meta.json @@ -0,0 +1,5 @@ +{ + "title": "Getting Started", + "pages": ["installation", "faq"], + "defaultOpen": true +} diff --git a/content/docs/index.mdx b/content/docs/index.mdx index 7ae491a..0aed75a 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -1,7 +1,20 @@ --- -title: Hello World +title: Introduction --- -## Introduction +Balatro Multiplayer is a mod for Balatro that allows you to play with your friends or against other players. -I love Anime. \ No newline at end of file + + + Learn how to install the mod. + + + Answers to common questions. + + \ No newline at end of file diff --git a/content/docs/meta.json b/content/docs/meta.json new file mode 100644 index 0000000..849073e --- /dev/null +++ b/content/docs/meta.json @@ -0,0 +1,5 @@ +{ + "title": "Advanced", + "pages": ["index", "getting-started", "advanced"], + "defaultOpen": true +} diff --git a/src/app/(home)/about/page.tsx b/src/app/(home)/about/page.tsx index 91eed83..84da5f8 100644 --- a/src/app/(home)/about/page.tsx +++ b/src/app/(home)/about/page.tsx @@ -1,3 +1,10 @@ export default async function About() { - return
About
+ return ( +
+
+

About

+

This is empty for now, we'll add some content here soon.

+
+
+ ) } diff --git a/src/app/(home)/page.tsx b/src/app/(home)/page.tsx index 7b1eed8..83559b0 100644 --- a/src/app/(home)/page.tsx +++ b/src/app/(home)/page.tsx @@ -24,7 +24,7 @@ export default function Home() {
@@ -44,7 +44,7 @@ export default function Home() { size='lg' className='w-full bg-red-600 text-white hover:bg-red-700 sm:w-auto' > - + Get Started @@ -71,8 +71,7 @@ export default function Home() { Features

- Everything you need to enjoy Balatro with friends and the wider - community. + Play with friends, compete globally, join tournaments

@@ -81,10 +80,7 @@ export default function Home() { Real-time Matches -

- Challenge friends to head-to-head poker matches with - synchronized gameplay. -

+

Challenge friends to head-to-head Balatro matches.

 @@ -93,7 +89,7 @@ export default function Home() {

- Create and join tournaments with custom rules and brackets. + Join our weekly tournaments and compete against other players.

@@ -110,12 +106,12 @@ export default function Home() { - Spectator Mode + Active Community

- Watch live matches between top players and learn new - strategies. + Join our Discord server to find matches, share strategies, and + participate in community events.

@@ -164,8 +160,7 @@ export default function Home() {

- Create a lobby and share the code with friends for casual - matches. + Challenge friends in private matches

  • @@ -190,11 +185,11 @@ export default function Home() {
-
- -
+ {/*
*/} + {/* */} + {/*
*/} @@ -206,8 +201,7 @@ export default function Home() {

- Join ranked queues with MMR-based matchmaking and - leaderboards. + Compete in two distinct queues:

@@ -228,11 +222,11 @@ export default function Home() {
-
- -
+ {/*
*/} + {/* */} + {/*
*/} @@ -244,8 +238,7 @@ export default function Home() {

- Find players for games with custom rulesets via our Discord - community. + Organize custom matches with unique rules and mods

  • @@ -270,8 +263,8 @@ export default function Home() {
    @@ -313,8 +306,8 @@ export default function Home() {

    Install the Mod

    - Download and install the multiplayer mod using our - simple installer. + Download and install the multiplayer mod by following + the instructions on our documentation.

    • @@ -323,9 +316,7 @@ export default function Home() { 2
-

- Create or Join a Game -

+

Start a match

Host your own game or join an existing one with a simple game code. @@ -351,7 +342,9 @@ export default function Home() { className='w-full bg-red-600 text-white hover:bg-red-700 sm:w-auto' asChild > - Install Now + + Install Now +

@@ -373,15 +366,16 @@ export default function Home() { Ready to Play?

- Join thousands of Balatro players already enjoying multiplayer - matches. + Join our competitive community of 3,000+ ranked players.

@@ -405,12 +399,12 @@ export default function Home() { > About - - Credits - + {/**/} + {/* Credits*/} + {/**/}