Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 3.46 KB

README.md

File metadata and controls

60 lines (47 loc) · 3.46 KB
Raw

BDS-Companion

A GUI and companion software for the Minecraft Bedrock Dedicated Server Software.

Setup

Download the exe from the releases page, and move it to an empty folder.
Extract a copy of MCBE's BDS to a folder named BDS within the folder the exe is in.
Then double click the exe to open!

Your folder should look like this:

bds-companion/
    BDS-Companion.exe
    BDS/
        bedrock_server.exe
        server.properties
        (and other BDS files)

(The location of BDS can be changed in settings, but this is the default)
You can find the latest release here. Please note that this application only supports Windows.

Features

Server Management

An image of BDS-UI's main page

  • 🔴 Red: Main server control buttons
  • 🟠 Orange: The server status. E.G: Online, Offline or Backing up.
  • 🔵 Blue: Server Output. Anything with [BDS-UI] is info from bds-ui, the rest is BDS's own output.

Settings

An image of BDS-UI's settings page

  • 🔴 Red: The Backup & Restart Settings. Note: Backup won't work without restart also being enabled.
  • 🟠 Orange: The time (in 24H) that BDS-UI will Restart/Backup. This is ignored if Auto Restarts is disabled
  • 🟡 Yellow: The about tab, with (these) instructions, updates, discord & support the project link.
  • 🟢 Green: The file paths. We recommend having them in the same folder (D:/TAD/bds-ui in the image, for example) for ease of use, but this is not needed
  • 🔵 Blue: Discord Intergration. Allows BDS-Companion to send the console messages and the server status messages (Stop, start & ect) to discord. See here
  • ⚫ Black: The debug tab. Only use these if something is broken!
  • 🟣 Purple: Save settings button. Make sure you save before leaving the tab!

Troubleshooting

  • Q: My PC says this is a virus!

    A: Yup, that's because not many people have downloaded this exe, so windows (amongst others) don't yet trust it. The code is open source on Github, and you're welcome to check it!

  • Q: It can't find (BDS, server.properties, ect)

    A: Check that the folder in settings matches the one with BDS in it, and restart BDS-UI. Please note it needs full (e.g C:/BDS-Companion/BDS) paths, not relative ones (e.g ./BDS).

  • Q: Where can I get help?

    A: You can join our Discord! Make sure you have uploaded the logs using the Upload Logs button in the settings tab, and we'll be able to help you better!

  • Q: Why does it open twice?

    A: When auto-backing up, it'll open a seperate window to run the backup in (in case the backup window crashes). The window will close itself when the backup is done.

Credits