Downloading and setup

BeaverBuddies is a multiplayer mod, so you will need a friend to play with. You should chose who will be the "Host" and who will be the "Client". The Host should be able to port forward (discussed below).

Unless otherwise indicated, both the Host and the Client should follow these steps:

TL;DR: If you know what you're doing, simply have both Host and Client install the mod, and either:

1. make sure the Host has forwarded port 25565. Then skip to the next section or
2. make sure both players are using Steam.

Note: BeaverBuddies is likely not compatible with other mods. If you have other mods installed, temporarily uninstall/disable them before using BeaverBuddies (the Mod Manager mod makes this easier - see below).

Installing BeaverBuddies (Steam)

If you are using Steam, please install BeaverBuddies through the Timberborn Workshop on Steam. This is the preferred method as it will ensure the mod is setup properly and updated.

Simply go to the BeaverBuddies workshop item and hit the (+ Subscribe) button. Try launching Timberborn, and the Mod should appear in your Mods list at launch.

Note: BeaverBuddies is likely not compatible with other Mods at this time (see more here), so make sure they're also unchecked.

Installing BeaverBuddies (non-Steam)

This guide from Mod.io explains how to install Mods without Steam, using the Mods folder.

The recommended method for installing Beaver Buddies is to use the Mod Manager. This allows you to easily enable/disable the mod. Follow these steps:

1. If you have not already installed the Mod Manager mod, do so (see links above for guides to installing a mod).
2. Open Timberborn and click the "Mod manager" button in the main menu (it may just appear as a link).
3. Search "Beaver Buddies" and click "Download".

4. If you have other mods installed, you should disable them using the Mod Manager them before using BeaverBuddies.
5. Click the [X] to exit Timberborn.
6. Restart. You're done! Beaver Buddies and its dependencies should be installed.

If you do not want to use the Mod Manager:

1. Download the latest release of BeaverBuddies and TimberAPI.
   • Make sure you are using a version of TimberAPI compatible with BeaverBuddies, as described here.
2. Install them using these instructions

Port Forwarding or Steam Networking

BeaverBuddies supports two different network modes (with crossplay supported for 3+ player sessions).

1. Steam peer-to-peer connection (beta): When the host hosts a game, they have the option to invite players to join via steam. This mode uses Steam's peer-to-peer networking, which does require your network configuration to support peer-to-peer (this can be a bit tricky to diagnose, so if you're having trouble, try method 2). This is also a bit slower, and is still in beta, so expect some possible issues - and obviously it requires both players to have the Steam version of Timberborn.

• Use this approach if you use Steam and are having trouble setting up port forwarding.

2. Use port forwarding. The Host has set up port forwarding to port 25565 on their computer (or configure the port in Settings). User @skoapie created this guide for BeaverBuddies. There are many tutorials on the internet for how to set up port forwarding, e.g. here. If you don't want to port forward, you can check out other options like Hamachi, which can simulate LAN play for free for small groups of players.

• Use this approach if you are having trouble with Steam P2P, or if you aren't using Steam, since it will be faster and more reliable.

Running a game

Once the set-up steps above have been completed once, connecting should be straightforward. Each party should follow the steps below:

The Host:

1. Find your global IP address, e.g. from this site. Share this with the Client.
2. If you want to start from a new game, create a new game and save it, then exit to the Main Menu.
3. From the main menu, select "Load game", and find the save you want to host.
4. Click the "Host co-op game" button (instead of "Load"):

5. Invite the client to connect using the appropriate method: Steam (invite them or they can direct join in the Steam chat menu) or direct connect (via the BeaverBuddies Join Game button in the main menu). Their game will start loading immediately, but they should wait for you before interacting with it.
6. Wait until the client appears in your list of joined players, then start your game.

7. Unpause and play with your buddy!

The Client:

1. Launch Timberborn and wait for the Host to start hosting.
2. If using direct connect, click the "Join co-op game" button, then type in the Host's global IP address (see instructions above for how to get it), and click "Ok".
3. If using steam, accept their invitation or find their name in chat and right-click and join their game.
   • If you receive a connection error, see the Troubleshooting guide below.
4. You will start receiving the game save and then automatically start loading.
5. Once loaded, let the Host know. Unpause and play with your buddy!

Troubleshooting

Q: How do I file a bug report, make a feature request, or ask a question?

Note: If making a bug report: Don't restart either Host or Client's game, since that will delete the logs that can help us diagnose the bug.

Make a GitHub account and post and issue here. Follow the instructions in the "Bug Report" template. This may help us fix your issue.

Q: The Client's game never connects to the server. What can I do?

• Make sure that the client has correctly typed in the Host's current IP address (this may have changed).
• Check to make sure the Host has appropriate port forwarding. The Host can verify this by loading a game, and then using this website. The Host should type in the port they are using (probably 25565). If the port is not accessible, the Host has likely not set up port forwarding properly.
• If using a port other than 25565, make sure that the host has set up their ReplayConfig.json correctly (see above).

Q: I'm getting a message that the Client desynced. What do I do?

First, don't forget to have the Host save the game. You should be able to reload from there.

Then, consider posting a bug report. See above.

Here are some tips that may help you stay connected:

• Make sure you're connecting properly. See the instructions above.
• Make sure the host has loaded a fresh save and has not yet unpaused the game when the client connects.
• If you are loading a game with lots of progress, which you haven't tried with this mod before, try starting a new game instead. If the new game works, it may be something in your prior save that isn't fully supported yet by this mod. If you can identify what causes the desync, we can try to fix the issue.
• Make sure you aren't running any other mods along with BeaverBuddies. They will likely cause desyncs.

Q: My game crashed. What do I do?

• File a bug report. See above.