From e6cf0a5ff13f8dc9c56bd17a1946ff82dc96dab4 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 20:54:45 +0100 Subject: [PATCH 01/25] [rm] Arch AUR due to being out of date --- src/installation.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/installation.md b/src/installation.md index f0a92d8..9633048 100644 --- a/src/installation.md +++ b/src/installation.md @@ -33,10 +33,6 @@ On most distributions, you should be able to open it to install it. If not, run sudo apt install ~/Downloads/brickadia-launcher.deb ``` -### Arch Linux - -Install [`brickadia-launcher`](https://aur.archlinux.org/packages/brickadia-launcher/) from the [AUR](https://wiki.archlinux.org/title/AUR). - ### Other An official package is not available for any other distributions yet, but you can download an archive of the launcher that should work on most Linux distributions, provided that you find the dependencies. From 5987faae0eba8c1db3a7cc3cb95dc4d3d4b5d3a4 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:00:07 +0100 Subject: [PATCH 02/25] [dev] Installation -> Client Installation - Makes it more clear for users who are trying to setup servers --- src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 751e887..56ae990 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,7 +2,7 @@ - [Brickadia](./brickadia.md) - [System Requirements]() -- [Installation](./installation.md) +- [Client Installation](./installation.md) - [Tools](chapter_1.md) - [Placer](tools/placer.md) From 0c9694e87670c9a7696a8ce3321fe7772a3ddd45 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:00:47 +0100 Subject: [PATCH 03/25] [fix] Proton now shows up --- src/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 56ae990..ca252a0 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -3,6 +3,7 @@ - [Brickadia](./brickadia.md) - [System Requirements]() - [Client Installation](./installation.md) + - [Proton](./installation_proton.md) - [Tools](chapter_1.md) - [Placer](tools/placer.md) From ae819a6aceabd5dce4a7bcd4d6d45fb825d2e86f Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:05:21 +0100 Subject: [PATCH 04/25] [upd] Updated mdbook action to 0.4.10, switched to ubuntu-latest --- .github/workflows/deploy.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 8702a9b..ab107ad 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -8,14 +8,14 @@ on: jobs: deploy: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Setup mdBook uses: peaceiris/actions-mdbook@v1 with: - mdbook-version: '0.4.4' + mdbook-version: '0.4.10' - run: mdbook build From 3f587aaf76accfe5b90f541bf72ae52363a867d8 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:07:46 +0100 Subject: [PATCH 05/25] [upd] Checkout v3 --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ab107ad..4375e7a 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -10,7 +10,7 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup mdBook uses: peaceiris/actions-mdbook@v1 From b766d4abddbcc591846cd04326cb3f7bb92f05e1 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:22:02 +0100 Subject: [PATCH 06/25] [fix] Action permission write --- .github/workflows/deploy.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 4375e7a..6d76cd4 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -6,6 +6,9 @@ on: - main workflow_dispatch: +permissions: + contents: write + jobs: deploy: runs-on: ubuntu-latest From ed29909a6db87ff4a526e22e17be2d33006e637c Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:54:33 +0100 Subject: [PATCH 07/25] [dev] Brickadia.vamist.dev --- .github/workflows/deploy.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 6d76cd4..be556cb 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -28,3 +28,4 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./book force_orphan: true + cname: brickadia.vamist.dev From 0a2dd8545a5161d619ee5e89fa497522487e345b Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:55:41 +0100 Subject: [PATCH 08/25] [dev] Chapter 4 and 5 init --- src/SUMMARY.md | 4 ++-- src/chapter_4.md | 5 +++++ src/chapter_5.md | 1 + src/servers/setup_linux.md | 0 4 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 src/chapter_4.md create mode 100644 src/chapter_5.md create mode 100644 src/servers/setup_linux.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index ca252a0..9e14ab6 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -26,12 +26,12 @@ - [Audio](components/audio.md) - [Item Spawn](components/item_spawn.md) -- [Minigames]() +- [Minigames](chapter_4.md) - [Deathmatch]() - [Bricktionary]() - [Sandbox]() -- [Hosting Servers]() +- [Hosting Servers](chapter_5.md) - [Port Forwarding]() - [Dedicated Servers]() - [Roles & Permissions]() diff --git a/src/chapter_4.md b/src/chapter_4.md new file mode 100644 index 0000000..16f56f6 --- /dev/null +++ b/src/chapter_4.md @@ -0,0 +1,5 @@ +# Chapter 4: Minigames + +1. [Deathmatch]() - Deathmatch +2. [Bricktionary]() - Bricktionary +3. [Sandbox]() - Sandbox diff --git a/src/chapter_5.md b/src/chapter_5.md new file mode 100644 index 0000000..1063e6e --- /dev/null +++ b/src/chapter_5.md @@ -0,0 +1 @@ +# Chapter 5: Servers diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md new file mode 100644 index 0000000..e69de29 From c84627735bbcb6fb3b6fd5defed5fd317434bae4 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 21:59:29 +0100 Subject: [PATCH 09/25] [fix] Chapter headers match their SUMMARY counterpart --- src/chapter_5.md | 2 +- src/installation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/chapter_5.md b/src/chapter_5.md index 1063e6e..b885dbc 100644 --- a/src/chapter_5.md +++ b/src/chapter_5.md @@ -1 +1 @@ -# Chapter 5: Servers +# Chapter 5: Hosting Servers diff --git a/src/installation.md b/src/installation.md index 9633048..11ea01e 100644 --- a/src/installation.md +++ b/src/installation.md @@ -1,4 +1,4 @@ -# Installation +# Client Installation Brickadia has a launcher that will update the game for you, so you'll only need to install it once. From fa7ef6f219094abf97100230c6f8fd9dbaea41cf Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 22:34:22 +0100 Subject: [PATCH 10/25] [dev] Server init --- src/SUMMARY.md | 3 ++- src/chapter_5.md | 5 +++++ src/servers/setup_client.md | 2 ++ src/servers/setup_dedicated | 1 + src/servers/setup_dedicated.md | 2 ++ src/servers/setup_linux.md | 0 6 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 src/servers/setup_client.md create mode 100644 src/servers/setup_dedicated create mode 100644 src/servers/setup_dedicated.md delete mode 100644 src/servers/setup_linux.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 9e14ab6..23a8c25 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -32,8 +32,9 @@ - [Sandbox]() - [Hosting Servers](chapter_5.md) + - [Client Hosting](servers/setup_client.md) + - [Dedicated Servers](servers/setup_dedicated.md) - [Port Forwarding]() - - [Dedicated Servers]() - [Roles & Permissions]() - [Moderation Tools]() diff --git a/src/chapter_5.md b/src/chapter_5.md index b885dbc..9fde723 100644 --- a/src/chapter_5.md +++ b/src/chapter_5.md @@ -1 +1,6 @@ # Chapter 5: Hosting Servers +In Brickadia, servers allow you to connect with other players. If you are interested in hosting a server for other players, read on! + +Here's a short summary on the two different types of servers: +1. [Client Hosting](servers/setup_client.md) - Hosted through the in game client, often hosted in short bursts on a home machine. +2. [Dedicated Server](servers/setup_dedicated.md) - Hosted through a command-line interface, often on another machine that is up for longer periods of time. diff --git a/src/servers/setup_client.md b/src/servers/setup_client.md new file mode 100644 index 0000000..5284d4e --- /dev/null +++ b/src/servers/setup_client.md @@ -0,0 +1,2 @@ +# Client Hosting Setup + diff --git a/src/servers/setup_dedicated b/src/servers/setup_dedicated new file mode 100644 index 0000000..c999e9e --- /dev/null +++ b/src/servers/setup_dedicated @@ -0,0 +1 @@ +# Dedicated Servers diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md new file mode 100644 index 0000000..64a2cd2 --- /dev/null +++ b/src/servers/setup_dedicated.md @@ -0,0 +1,2 @@ +# Dedicated Server Setup + diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md deleted file mode 100644 index e69de29..0000000 From 5a64222801fc0a4ce0a523ee665b9d20a89fac58 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 22:42:46 +0100 Subject: [PATCH 11/25] [dev] Very basic README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..61d2287 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Setup Guide +This repo uses [mdBook](https://rust-lang.github.io/mdBook/). Reading the official book is recommended, but as long as you understand how markdown works, you are good to go. + +## Quick Install +If you have [Cargo](https://www.rust-lang.org/tools/install) installed: +`cargo install mdbook` + +Otherwise you can download an executable from the [GitHub Release page](https://github.com/rust-lang/mdBook/releases). From d29c328875fb2938f8a0b0a4c30de54cd0d858a1 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 22:52:51 +0100 Subject: [PATCH 12/25] [rm] Broken file --- src/servers/setup_dedicated | 1 - 1 file changed, 1 deletion(-) delete mode 100644 src/servers/setup_dedicated diff --git a/src/servers/setup_dedicated b/src/servers/setup_dedicated deleted file mode 100644 index c999e9e..0000000 --- a/src/servers/setup_dedicated +++ /dev/null @@ -1 +0,0 @@ -# Dedicated Servers From b46dd693e043ce17a666a81d101163ade19243e4 Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 23:18:48 +0100 Subject: [PATCH 13/25] [dev] Progress on setup_dedi --- src/servers/setup_dedicated.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md index 64a2cd2..b94dbd1 100644 --- a/src/servers/setup_dedicated.md +++ b/src/servers/setup_dedicated.md @@ -1,2 +1,20 @@ # Dedicated Server Setup +Brickadia allows you to host a server on a dedicated machine. You may want to do this if: +- You have a VPS/bare metal server spare +- You want to avoid hosting a server on your own machine/home network +- You want to offload the processing required onto another machine + +## Requirements +Before you start this guide, you will need the following: +1. A machine that is running `Windows` or `Linux` + - For the best reliability, we recommend getting a VPS or a bare metal machine from a server rental company. If you are home hosting off an old laptop, your results may vary. +2. A way to connect to that machine, either through `SSH` or with a keyboard & monitor. + +### Linux Inital Setup +This section covers how to add a new linux user, as we advise you do not host off a root user. You can skip this if you know what you are doing. + +### Linux Setup + + +### Windows Setup From 1ba398d8c5d251a03cde77103732ae5a888b9f5e Mon Sep 17 00:00:00 2001 From: Vamist Date: Thu, 11 May 2023 23:21:22 +0100 Subject: [PATCH 14/25] [dev] Dedicated server header tweak --- src/SUMMARY.md | 2 +- src/servers/setup_dedicated.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 23a8c25..b160af1 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -33,7 +33,7 @@ - [Hosting Servers](chapter_5.md) - [Client Hosting](servers/setup_client.md) - - [Dedicated Servers](servers/setup_dedicated.md) + - [Dedicated Server](servers/setup_dedicated.md) - [Port Forwarding]() - [Roles & Permissions]() - [Moderation Tools]() diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md index b94dbd1..ef31e73 100644 --- a/src/servers/setup_dedicated.md +++ b/src/servers/setup_dedicated.md @@ -1,4 +1,4 @@ -# Dedicated Server Setup +# Dedicated Server Brickadia allows you to host a server on a dedicated machine. You may want to do this if: - You have a VPS/bare metal server spare - You want to avoid hosting a server on your own machine/home network From d300a2101f838e1ba94b0a6f576385b83c3af3fd Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 12:14:36 +0100 Subject: [PATCH 15/25] [dev] addUser init --- src/servers/setup_dedicated.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md index ef31e73..6c8845d 100644 --- a/src/servers/setup_dedicated.md +++ b/src/servers/setup_dedicated.md @@ -10,11 +10,24 @@ Before you start this guide, you will need the following: - For the best reliability, we recommend getting a VPS or a bare metal machine from a server rental company. If you are home hosting off an old laptop, your results may vary. 2. A way to connect to that machine, either through `SSH` or with a keyboard & monitor. -### Linux Inital Setup -This section covers how to add a new linux user, as we advise you do not host off a root user. You can skip this if you know what you are doing. +## Linux +In this tutorial, we assume you are hosting a server on a Debian based distro. + +### User +In general, we recommend installing Brickadia onto a user that isnt `root`[^root]. + +```bash +sudo adduser brickadia +``` + + +### Install -### Linux Setup ### Windows Setup + + + +[^root]: Its good practice in linux not to run applications under `root` unless they require that level of access to the system. There is nothing preventing you from doing so however. From b7f252d56fe8c245332b5a69f10d4036d07d7719 Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 12:19:48 +0100 Subject: [PATCH 16/25] [dev] Summary tweak - Clear titles/separation --- src/SUMMARY.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index b160af1..e588ef9 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,10 +1,12 @@ # Summary +[Brickadia](./brickadia.md) -- [Brickadia](./brickadia.md) +# Installation - [System Requirements]() - [Client Installation](./installation.md) - [Proton](./installation_proton.md) +# Features - [Tools](chapter_1.md) - [Placer](tools/placer.md) - [Painter](tools/painter.md) @@ -31,6 +33,7 @@ - [Bricktionary]() - [Sandbox]() +# Advanced Features - [Hosting Servers](chapter_5.md) - [Client Hosting](servers/setup_client.md) - [Dedicated Server](servers/setup_dedicated.md) @@ -38,4 +41,5 @@ - [Roles & Permissions]() - [Moderation Tools]() +# Misc - [Users](./users.md) From 7b44c2304a2ebc35078f781730134c5801ba6fdd Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 15:18:41 +0100 Subject: [PATCH 17/25] [dev] Enabled editable --- book.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/book.toml b/book.toml index 3a16a01..3f41eff 100644 --- a/book.toml +++ b/book.toml @@ -4,3 +4,7 @@ language = "en" multilingual = false src = "src" title = "Brickadia Manual" + +[output.html.playground] +editable = true +runnable = false From 72f36b2911ce00b9d87fa20a1d66cb608ee82f5e Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 15:18:47 +0100 Subject: [PATCH 18/25] [dev] Server progress --- src/SUMMARY.md | 2 + src/servers/setup_dedicated.md | 24 ++--------- src/servers/setup_linux.md | 73 ++++++++++++++++++++++++++++++++++ src/servers/setup_windows.md | 1 + 4 files changed, 79 insertions(+), 21 deletions(-) create mode 100644 src/servers/setup_linux.md create mode 100644 src/servers/setup_windows.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index e588ef9..21b7a01 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -37,6 +37,8 @@ - [Hosting Servers](chapter_5.md) - [Client Hosting](servers/setup_client.md) - [Dedicated Server](servers/setup_dedicated.md) + - [Linux Setup](servers/setup_linux.md) + - [Windows Setup]() - [Port Forwarding]() - [Roles & Permissions]() - [Moderation Tools]() diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md index 6c8845d..ad7a3b2 100644 --- a/src/servers/setup_dedicated.md +++ b/src/servers/setup_dedicated.md @@ -10,24 +10,6 @@ Before you start this guide, you will need the following: - For the best reliability, we recommend getting a VPS or a bare metal machine from a server rental company. If you are home hosting off an old laptop, your results may vary. 2. A way to connect to that machine, either through `SSH` or with a keyboard & monitor. -## Linux -In this tutorial, we assume you are hosting a server on a Debian based distro. - -### User -In general, we recommend installing Brickadia onto a user that isnt `root`[^root]. - -```bash -sudo adduser brickadia -``` - - -### Install - - - -### Windows Setup - - - - -[^root]: Its good practice in linux not to run applications under `root` unless they require that level of access to the system. There is nothing preventing you from doing so however. +## Guides: +- [Linux Setup](./setup_linux.md) +- [Windows Setup]() diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md new file mode 100644 index 0000000..bfe5b19 --- /dev/null +++ b/src/servers/setup_linux.md @@ -0,0 +1,73 @@ +# Linux Setup + +We assume you are hosting a server on a Debian based distro, on a x86-64 CPU[^arm] + +You can use any linux distro you want to host Brickadia, you will just need to adjust the commands to what your distro provides by default. + +## New User + +Its recommend installing Brickadia onto a user that isn't `root`[^root]. + +```sh +sudo adduser brickadia +``` + +After running this command, you will get the following (shortend) output: + +> Creating home directory `/home/brickadia' ... +> +> New password: + +Enter the users new password, and just press 'ENTER' to skip the questions adduser asks you. + +To access the user, you must use the command: + +```sh +su - brickadia +``` + +From now on, this guide will assume you are logged in as `brickadia`. + +## Installation + +Brickadia does not offer a separate binary for servers, instead you are required to download the launcher. + +Head on over to [Brickadia download page](https://brickadia.com/download) and copy the link to `Linux(Other) .tar.xz` archive. + +On your server, donwload the archive with: +```sh +wget https://static.brickadia.com/launcher/[VERSION]/brickadia-launcher.tar.xz +``` + +This will download `brickadia-launcher.tar.xz`. Next you will need to extract the launcher from tar. + +```sh +tar -xf brickadia-launcher.tar.xz && cd brickadia-launcher +``` + +Inside the new `brickadia-launcher`, run the following command to download the game: + +```sh +./brickadia-launcher --server +``` + +
+ Help, I just got a Permission denied error + + If you get the following error: `./brickadia-launcher: Permission denied`, you will need to run: + + ```sh + chmod +x ./brickadia-launcher + ``` +
+ +Once the game has downloaded, the game will start the server. You should close the server (ctrl + c) and move onto the next step. + +## Startup + + + + + +[^root]: Its good practice in linux not to run applications under `root` unless they require that level of access to the system. There is nothing preventing you from doing so however. +[^arm]: Arm is not supported officially, however [box64](https://github.com/ptitSeb/box64) has been known to work. diff --git a/src/servers/setup_windows.md b/src/servers/setup_windows.md new file mode 100644 index 0000000..3e7d02a --- /dev/null +++ b/src/servers/setup_windows.md @@ -0,0 +1 @@ +# Windows Setup From 5744a479a5ace3dcb98811bc99b0813a8528fd8c Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 15:39:25 +0100 Subject: [PATCH 19/25] [dev] Mention brickadia-community --- src/servers/setup_dedicated.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md index ad7a3b2..ed491a6 100644 --- a/src/servers/setup_dedicated.md +++ b/src/servers/setup_dedicated.md @@ -10,6 +10,9 @@ Before you start this guide, you will need the following: - For the best reliability, we recommend getting a VPS or a bare metal machine from a server rental company. If you are home hosting off an old laptop, your results may vary. 2. A way to connect to that machine, either through `SSH` or with a keyboard & monitor. -## Guides: +## Guides - [Linux Setup](./setup_linux.md) - [Windows Setup]() + +## Brickadia Community +[Brickadia Community](https://github.com/brickadia-community) contains a collection of tools made for Brickadia by the community, some of which relate to dedicated servers. You may be interested in [omegga](https://github.com/brickadia-community/omegga), as it allows you to create & use plugins to extend Brickadia servers. From ed2fe21406f5e367a54bd81a750772999403cb21 Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 15:59:51 +0100 Subject: [PATCH 20/25] [dev] Port forwarding + tweaks --- src/servers/setup_linux.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md index bfe5b19..e171070 100644 --- a/src/servers/setup_linux.md +++ b/src/servers/setup_linux.md @@ -1,6 +1,6 @@ # Linux Setup -We assume you are hosting a server on a Debian based distro, on a x86-64 CPU[^arm] +This guide assumes you are hosting a server on a Debian based distro, on a x86-64 CPU[^arm] You can use any linux distro you want to host Brickadia, you will just need to adjust the commands to what your distro provides by default. @@ -63,11 +63,30 @@ Inside the new `brickadia-launcher`, run the following command to download the g Once the game has downloaded, the game will start the server. You should close the server (ctrl + c) and move onto the next step. +## Port Forwarding + +Read (portforward.brickadia.dev)[https://portforward.brickadia.dev/], as this will always contain the latest ports you will want to port forward. + +We will be using [ufw](https://help.ubuntu.com/community/UFW) to port forward, as most distros tend to include it out of the box. + +```sh +sudo ufw allow 7777/udp +``` + ## Startup +Brickadia servers require authentication before they can appear on the master list. To do so, you must pass your username and password at least once when launching the server.[^password] + +```sh + ./brickadia-launcher --server -- -User=Username -Password="password" +``` + +After this, you do not need to pass your username or password as the file is cached in `~/.config/Epic/Brickadia/Saved/Auth`. +---- +[^arm]: Arm is not supported officially, however [box64](https://github.com/ptitSeb/box64) has been known to work with Brickadia. +[^root]: Its good practice in linux not to run applications under `root` unless they require that level of access to the system. There is nothing preventing you from doing so. -[^root]: Its good practice in linux not to run applications under `root` unless they require that level of access to the system. There is nothing preventing you from doing so however. -[^arm]: Arm is not supported officially, however [box64](https://github.com/ptitSeb/box64) has been known to work. +[^password]: The command includes a space at the start, as it tells bash to not save it in `~/.bash_history` From 04f2e936aaa17282d2575a1e16e999ddf3085afe Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 16:00:49 +0100 Subject: [PATCH 21/25] [fix] Broken url --- src/servers/setup_linux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md index e171070..400265d 100644 --- a/src/servers/setup_linux.md +++ b/src/servers/setup_linux.md @@ -65,7 +65,7 @@ Once the game has downloaded, the game will start the server. You should close t ## Port Forwarding -Read (portforward.brickadia.dev)[https://portforward.brickadia.dev/], as this will always contain the latest ports you will want to port forward. +Read [portforward.brickadia.dev](https://portforward.brickadia.dev/), as this will always contain the latest ports you will want to port forward. We will be using [ufw](https://help.ubuntu.com/community/UFW) to port forward, as most distros tend to include it out of the box. From a7f84ffcd7377daf337d7e5d21e5dfc16332cd05 Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 16:08:01 +0100 Subject: [PATCH 22/25] [dev] Misc and notes --- src/servers/setup_linux.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md index 400265d..e9a351a 100644 --- a/src/servers/setup_linux.md +++ b/src/servers/setup_linux.md @@ -83,6 +83,17 @@ Brickadia servers require authentication before they can appear on the master li After this, you do not need to pass your username or password as the file is cached in `~/.config/Epic/Brickadia/Saved/Auth`. +Assuming all went well, you should now be able to join your server. You can configure your game once you have joined it, by pressing `Esc` and pressing `Edit Game`. + +## Misc + +Files of importance: +- Configs: `~/.config/Epic/Brickadia/` +- Install: `~/.local/share/brickadia-launcher/` + +Commands: +- `quit` - Quit the game + ---- [^arm]: Arm is not supported officially, however [box64](https://github.com/ptitSeb/box64) has been known to work with Brickadia. From 34ba59ad6c9c5a4c7ecc1425b1accbd955e723a8 Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 16:09:39 +0100 Subject: [PATCH 23/25] [dev] Tweak dedicated --- src/servers/setup_dedicated.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/servers/setup_dedicated.md b/src/servers/setup_dedicated.md index ed491a6..b001641 100644 --- a/src/servers/setup_dedicated.md +++ b/src/servers/setup_dedicated.md @@ -1,8 +1,8 @@ # Dedicated Server Brickadia allows you to host a server on a dedicated machine. You may want to do this if: - You have a VPS/bare metal server spare -- You want to avoid hosting a server on your own machine/home network -- You want to offload the processing required onto another machine +- You want to avoid hosting a server on your own machine or home network +- You want to offload the server processing required onto another machine ## Requirements Before you start this guide, you will need the following: From 02882c5801e3c6f8032e213476445af028da2756 Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 16:11:30 +0100 Subject: [PATCH 24/25] [dev] game -> launcher --- src/servers/setup_linux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/servers/setup_linux.md b/src/servers/setup_linux.md index e9a351a..0f06704 100644 --- a/src/servers/setup_linux.md +++ b/src/servers/setup_linux.md @@ -61,7 +61,7 @@ Inside the new `brickadia-launcher`, run the following command to download the g ``` -Once the game has downloaded, the game will start the server. You should close the server (ctrl + c) and move onto the next step. +Once the game has downloaded, the launcher will start the server. You should close the server (ctrl + c) and move onto the next step. ## Port Forwarding From edc7ff3bd44f24035e79b04aebb126e0681142cb Mon Sep 17 00:00:00 2001 From: Vamist Date: Sat, 13 May 2023 16:13:44 +0100 Subject: [PATCH 25/25] [dev] Shortened text --- src/chapter_5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/chapter_5.md b/src/chapter_5.md index 9fde723..1ea0b2e 100644 --- a/src/chapter_5.md +++ b/src/chapter_5.md @@ -1,6 +1,6 @@ # Chapter 5: Hosting Servers In Brickadia, servers allow you to connect with other players. If you are interested in hosting a server for other players, read on! -Here's a short summary on the two different types of servers: +The two types of servers you will see: 1. [Client Hosting](servers/setup_client.md) - Hosted through the in game client, often hosted in short bursts on a home machine. 2. [Dedicated Server](servers/setup_dedicated.md) - Hosted through a command-line interface, often on another machine that is up for longer periods of time.