mirror of
https://github.com/ershisan99/www.git
synced 2025-12-17 12:34:17 +00:00
ship it
This commit is contained in:
5
content/docs/advanced/meta.json
Normal file
5
content/docs/advanced/meta.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"title": "Advanced",
|
||||
"pages": ["private-server"],
|
||||
"defaultOpen": false
|
||||
}
|
||||
68
content/docs/advanced/private-server.mdx
Normal file
68
content/docs/advanced/private-server.mdx
Normal file
@@ -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.
|
||||
|
||||
<Tabs items={['Windows', 'Mac/Linux']}>
|
||||
<Tab value="Windows">
|
||||
Download `server-win.exe` and run that file.
|
||||
</Tab>
|
||||
<Tab value="Mac/Linux">
|
||||
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.
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## 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.
|
||||
|
||||
<Files>
|
||||
<Folder name="Mods">
|
||||
<File name="Multiplayer"/>
|
||||
</Folder>
|
||||
<Folder name="config" defaultOpen>
|
||||
<File name="Multiplayer.jkr"/>
|
||||
</Folder>
|
||||
|
||||
</Files>
|
||||
|
||||
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.
|
||||
157
content/docs/getting-started/faq.mdx
Normal file
157
content/docs/getting-started/faq.mdx
Normal file
@@ -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:
|
||||
|
||||
<Card
|
||||
href="/docs/advanced/private-server"
|
||||
title="Private Server Setup"
|
||||
>
|
||||
Host your own server for your friends to connect to.
|
||||
</Card>
|
||||
|
||||
## 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:
|
||||
|
||||
<Card
|
||||
href="/docs/advanced/private-server"
|
||||
title="Private Server Setup"
|
||||
>
|
||||
Host your own server for your friends to connect to.
|
||||
</Card>
|
||||
|
||||
## 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:
|
||||
<Card
|
||||
href="/docs/advanced/private-server"
|
||||
title="Private Server Setup"
|
||||
>
|
||||
Host your own server for your friends to connect to.
|
||||
</Card>
|
||||
|
||||
## 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.
|
||||
68
content/docs/getting-started/installation.mdx
Normal file
68
content/docs/getting-started/installation.mdx
Normal file
@@ -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
|
||||
|
||||
<Steps>
|
||||
<Step>
|
||||
|
||||
### Install Lovely and Steamodded
|
||||
Follow the guide here to install: https://github.com/Steamopollys/Steamodded/wiki
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
|
||||
### Download the latest version of the Multiplayer mod
|
||||
<Button asChild className='no-underline'><a
|
||||
href="https://github.com/Balatro-Multiplayer/BalatroMultiplayer/releases/latest/download/BalatroMultiplayer.zip"
|
||||
rel={'noopener noreferrer'}><DownloadIcon/>Download the latest version</a></Button>
|
||||
|
||||
</Step>
|
||||
<Step>
|
||||
|
||||
### 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.
|
||||
</Step>
|
||||
</Steps>
|
||||
>
|
||||
|
||||
|
||||
|
||||
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
|
||||
|
||||
<Tabs items={['Windows', 'Mac', 'Linux/Steamdeck', 'Balatro Mod Manager (Windows/Mac)']}>
|
||||
<Tab value="Windows" className={'flex justify-center'}>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/iqTpHz5vZgA" title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen></iframe>
|
||||
</Tab>
|
||||
<Tab value="Mac" className={'flex justify-center'}>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/05Hs8f1t8eo" title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen></iframe>
|
||||
</Tab>
|
||||
<Tab value="Linux/Steamdeck" className={'flex justify-center'}>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/zaVy_AwojQk" title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen></iframe>
|
||||
</Tab>
|
||||
<Tab value="Balatro Mod Manager (Windows/Mac)" className={'flex justify-center'}>
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/JG3jw0oqRZo?si=LaHTjWe6xX6EVdqa"
|
||||
title="YouTube video player"
|
||||
frameBorder="0"
|
||||
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
|
||||
allowFullScreen></iframe>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
5
content/docs/getting-started/meta.json
Normal file
5
content/docs/getting-started/meta.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"title": "Getting Started",
|
||||
"pages": ["installation", "faq"],
|
||||
"defaultOpen": true
|
||||
}
|
||||
@@ -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.
|
||||
<Cards>
|
||||
<Card
|
||||
href="/docs/getting-started/installation"
|
||||
title="Installation"
|
||||
>
|
||||
Learn how to install the mod.
|
||||
</Card>
|
||||
<Card
|
||||
href="/docs/getting-started/installation"
|
||||
title="FAQ"
|
||||
>
|
||||
Answers to common questions.
|
||||
</Card>
|
||||
</Cards>
|
||||
5
content/docs/meta.json
Normal file
5
content/docs/meta.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"title": "Advanced",
|
||||
"pages": ["index", "getting-started", "advanced"],
|
||||
"defaultOpen": true
|
||||
}
|
||||
Reference in New Issue
Block a user