Bedrock Portal

This project aims to create a fully featured and customizable web portal that can be used to host Minecraft Bedrock Edition dedicated servers. It is written in .Net Core which can run both on Windows and Linux systems.

Features

• Multiple user tiers (regular user, moderator, admin)
• Dynamically updating whitelist
• A web store for buying in game items
  • In game items are created by issueing console commands
  • The store is also used to buy membership time on the server whitelist
• Web access to the server console
  • Moderators can be given a limited subset of commands to use
  • Admins can use any command
• Discord integration
  • Send notifications to a webhook when players log in
  • Players can earn points by chatting (requires the Node.js bot in the DiscordReverseWebhook repo)
• Static pages can be easilly added via html files and can even be added to the menu by modifying the appsettings.json file

Basic Setup (no store)

This software requires both .NET Core and an instance of Microsoft SQL Server Express. You'll need to create a database for the application to use. Also, the most up to date BDS software from Mojang.

SQL Server

Create a new database using SQL Server Management Studio, then create a new login by running the following statements:

CREATE LOGIN PortalUser
WITH PASSWORD = 'Strong Password Goes Here';

-- This is not a great idea as this user has all of the mojo. If you know how to
-- deal with more granular roles, this user needs read/write and ddladmin
ALTER SERVER ROLE sysadmin ADD MEMBER PortalUser;

appsettings.json

Rename appsettings_template.json to appsettings.json. Open it in a text editor and make the following edits:

• ExePath - should be changed to your BDS exe location
• StartDirectory - should be changed to the BDS install folder
• SystemFromEmailAddress - is the From adress on system generated emails.
• WhiteListPath - should be changed to the whitelist.json location
• DiscordWebhookUrl - The portal will use this webhook to post when anyone logs in
• SendGridApiKey - You can create a free account in order to send system generated emails
• ApplicationTitle - Change to your realm name
• MembershipEnabled - false
• StoreEnabled - false
• BackupsToKeep - set to whatever you want, be careful as large numbers could result in low disk space
• ArchivePath - This is where backups will be stored. Make sure that permissions are set to read/write for the web app user
• TempPath - Staging location for backup zips. Make sure that permissions are set to read/write for the web app user
• WorldName - The name of your world, set in server.properties (eventually this will be determined automatically, but this is easier for now)

The following sections are a little more complicated.

StaticMenuLinks

Anything in here will show up on the top nav menu. You can add custom pages here. Anything placed in ~/wwwroot/html_frag can be used here. The install zip contains a community guidelines file. Feel free to edit or remove it, as well as any other content that you wish to add.

CommandWhitelistByRole

Currently the only roles are "Admin" and "Moderator". Admins can use all console commands, Moderators can only use the commands listed here.

ConnectionStrings

Set this to an empty MS SQL Server database. It should look like this:

"DefaultConnection": "Server=localhost\\dev;Database=PortalTest;User ID=PortalUser;Password=Strong Password Goes Here"

Authentication

If you want to enable Google community login, you can use this section.

Usage

Once the site is up and running, create your first user. This user will automatically be promoted to Admin.

Manage Users

Under the Utilities menu, you'll see a "Manage Users" option. This will show you your new user as well as anybody else who registers. Each user has an IsActive flag. Admins and Moderators can toggle the active status of players. Players who are not active will be automatically removed from the whitelist, and toggling a player active will add them to the whitelist. The whitelist checks for user changes every 120 seconds, and refreshes automatically.

Each user can be promoted or demoted as well, using the Toggle Admin or Toggle Moderator buttons. Only Admins can use this feature. Changes to a user's permission level will only take effect after they log out then back in.

Console

This provides direct access to the BDS console. Admins can run any command here, Moderators can run any commands that are made available to them in the appsettings.json file. The bedrock server software will be restarted on failure (graceful or otherwise) so you can safely restart your server by issues the "stop" command.