mirror of
https://github.com/BeamMP/Wiki.git
synced 2026-10-25 21:40:11 +00:00
docs: add all untracked content
This commit is contained in:
WikiBot committed
1 parent
6e3dc75228
commit
8c7181c21d
75 files changed
+2937
No files matched your search
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Welcome Page
|
||||
description:
|
||||
published: true
|
||||
date: 2022-12-22T09:23:25.781Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2021-01-11T23:38:32.249Z
|
||||
---
|
||||
|
||||
# Welcome
|
||||
This is the BeamMP Wiki!
|
||||
|
||||
Navigate using the tabs on the left - whilst some pieces of the Wiki are still under construction, you will be able to find all of the information you need to get the mod up and running, as well as a server.
|
||||
|
||||
Any questions or issues? Please had over to our forum and make a post, our community will be able to help :)
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Early Access Setup
|
||||
description: How to setup Early Access
|
||||
published: true
|
||||
date: 2022-12-22T09:23:29.486Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2021-01-16T19:48:17.235Z
|
||||
---
|
||||
|
||||
# Adding the Early Access Group Title!
|
||||
Firstly thank you for supporting the mod!
|
||||
|
||||
Please note you must use the same email to make a account on the fourms as on patreon.
|
||||
|
||||
First click here so that we can edit your profile.
|
||||
|
||||
|
||||
|
||||
Next you will be presented with a page similar to this:
|
||||
|
||||
|
||||
From here you can see the groups that you are a part of and that you can proudly show off.
|
||||
To select one just click on the title button then click one from there.
|
||||
|
||||
Once done click save on the bottom.
|
||||
Thats it :)
|
||||
|
||||
# What Are the Perks of Early Access?
|
||||
You may be wondering whats included in Early Access, After you've linked your Discord and Forum account, you should be able to take full advantage of these perks.
|
||||
|
||||
The things included are as follows:
|
||||
|
||||
- Exclusive access to our EA Discord Channels.
|
||||
|
||||
- Access to BeamMP Pre Release Server and Client Builds.
|
||||
|
||||
- An Early Access in-game badge.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
<!--
|
||||
title: F.A.Q. and Known Issues
|
||||
description: List of commonly asked questions and known bugs
|
||||
published: true
|
||||
date: 2022-12-22T09:23:33.261Z
|
||||
tags:
|
||||
editor: ckeditor
|
||||
dateCreated: 2020-07-02T21:06:26.786Z
|
||||
-->
|
||||
|
||||
<h1>Client</h1>
|
||||
<p><strong>How do I install BeamMP?</strong></p>
|
||||
<ul>
|
||||
<li>There is a full guide on how to install BeamMP on Windows, you can find it <a href="https://wiki.beammp.com/en/home/installation-guide">here</a>.</li>
|
||||
</ul>
|
||||
<p><strong>Does BeamMP works on a cracked version of BeamNG.drive?</strong></p>
|
||||
<ul>
|
||||
<li>BeamMP does not work with cracked versions of BeamNG.drive nor that it does on outdated versions. If you want to use BeamMP please consider buying the game.</li>
|
||||
</ul>
|
||||
<p><strong>Does BeamMP work on Linux?</strong></p>
|
||||
<ul>
|
||||
<li>BeamMP client is not officially supported on Linux. However, you might be able to get it working by running the launcher in the same proton prefix as the game.</li>
|
||||
<li>BeamMP Server builds can be found in the BeamMP_Server.zip download on the <a href="https://beammp.com">BeamMP website</a>, or in the <a href="https://github.com/BeamMP/BeamMP-Server/releases">releases tab on the Github</a>. For building instructions see <a href="https://github.com/BeamMP/BeamMP-Server#how-to-build">here</a>.</li>
|
||||
</ul>
|
||||
<p><strong>Why is the launcher flagged by my antivirus or by Windows Defender?</strong></p>
|
||||
<ul>
|
||||
<li>In order to prevent Windows Defender from flagging a specific .exe, we need to buy a license which is very expensive, therefor, BeamMP might get flagged by Windows Defender.</li>
|
||||
<li>Some antivirus may flag BeamMP as a virus because it does some interactions with network and other stuff. There are <strong>no viruses</strong> in any of the code. The code for the launcher, server, and Lua client can be seen on our <a href="https://github.com/BeamMP">Github</a>.</li>
|
||||
</ul>
|
||||
<p><strong>I have poor performance, what should I do?</strong></p>
|
||||
<ul>
|
||||
<li>We are working hard to make performance as good as possible. Sadly, there isn't a lot you can do about it, if you have already lowered your graphic settings and your performance is still poor, consider playing on a server with less players. The game is mainly CPU bound when you play with lots of people, so older CPUs (even quadcores) will suffer with more than a handful of people.</li>
|
||||
</ul>
|
||||
<h1><strong>Server</strong></h1>
|
||||
<p><strong>How can I setup my own server?</strong></p>
|
||||
<ul>
|
||||
<li>All the information to setup your own server can be found on <a href="https://wiki.beammp.com/en/home/Server_Mod">this page</a> of our wiki.</li>
|
||||
</ul>
|
||||
<p><strong>Is the server working on Linux?</strong></p>
|
||||
<ul>
|
||||
<li>BeamMP server can be built on Linux, however builds are not provided, you should build it yourself. It is officially supported on Debian 9 and Debian 10 a tutorial can be found <a href="https://github.com/BeamMP/BeamMP-Server#how-to-build">here</a>.</li>
|
||||
</ul>
|
||||
<h1>Miscellaneous</h1>
|
||||
<p><strong>Where can I find the code?</strong></p>
|
||||
<ul>
|
||||
<li>All the source code can be found on our <a href="https://github.com/BeamMP">Github</a>.</li>
|
||||
<li>Before doing anything keep in mind that the code is under <a href="https://forum.beammp.com/topic/94/terms-of-use-v1-0">terms of use</a></li>
|
||||
</ul>
|
||||
<p><strong>I have found a bug, an exploit or anything so, what should I do?</strong></p>
|
||||
<ul>
|
||||
<li>If the issue is code related and you know how to use Github, you can post the issue on our <a href="https://github.com/BeamMP">Github</a>.</li>
|
||||
<li>If it is not something sensitive, you can create a post on our <a href="https://forum.beammp.com">forum</a> or you can report this on our <a href="https://discord.gg/beammp">Discord</a>.</li>
|
||||
<li>If the information is sensitive you can directly report the issue to a staff member on our <a href="https://discord.gg/beammp">Discord</a>.</li>
|
||||
</ul>
|
||||
@@ -0,0 +1,85 @@
|
||||
---
|
||||
title: Git Snippets
|
||||
description: Git snippets for frequent git-related issues
|
||||
published: true
|
||||
date: 2022-12-22T09:23:37.803Z
|
||||
tags:
|
||||
editor: markdown
|
||||
dateCreated: 2021-10-04T10:32:51.318Z
|
||||
---
|
||||
|
||||
# Nomenclature
|
||||
|
||||
- `fork`: When forking, this is the resulting fork repository
|
||||
- `upstream`: When forking, this is the original repository that was forked from
|
||||
- `remote`: When you clone a repository, the repository you cloned from is called a `remote`. It's usually the `remote` called `origin`.
|
||||
|
||||
# Setup
|
||||
|
||||
Code in here will be git commands. If you don't have [git for windows](https://gitforwindows.org/) installed, you should do so.
|
||||
|
||||
To open a git terminal in a folder, you should be able to right-click and open a git bash. A terminal (black window) should open.
|
||||
|
||||
You should also have a merge tool installed, such as `kdiff3` or similar. It needs to support 3-way merges. To set a tool as mergetool, run
|
||||
```sh
|
||||
git config --global merge.tool <tool>
|
||||
```
|
||||
For example, for kdiff3:
|
||||
```sh
|
||||
git config --global merge.tool kdiff3
|
||||
```
|
||||
|
||||
# Common Issues
|
||||
|
||||
## Reset a fork to the state of upstream
|
||||
|
||||
Problem: You made a fork but it's not up-to-date with the upstream, and it has changes that you'd like to **get rid of**. Basically, you want to **reset** your fork's status to the one of the upstream repository.
|
||||
|
||||
Assuming
|
||||
- `https://github.com/example/example` is the upstream repo
|
||||
- `https://github.com/me/example` is your fork
|
||||
- `<branch>` is the branch you want to reset
|
||||
|
||||
We're also assuming that your fork's repo is already set up as `origin` (this is usually the case).
|
||||
|
||||
1. Add the upstream repository:
|
||||
```sh
|
||||
git remote add upstream https://github.com/example/example
|
||||
```
|
||||
|
||||
2. Pull from upstream and reset:
|
||||
```sh
|
||||
git pull -f upstream <branch>
|
||||
git reset --hard upstream/<branch>
|
||||
```
|
||||
**This will NUKE your local changes on that branch.**
|
||||
|
||||
3. Push to origin:
|
||||
```sh
|
||||
git push --force-with-lease origin <branch>
|
||||
```
|
||||
|
||||
## Push: Not possible to fast-forward
|
||||
|
||||
Problem: You made a change to `a.txt` on `main`, but the remote also changed `a.txt` on `master`, and you can't push your commit because it fails with `fatal: Not possible to fast-forward, aborting.`.
|
||||
|
||||
In our example, we add `cruel` but origin adds `beautiful` to our `a.txt`.
|
||||
|
||||
To fix:
|
||||
|
||||
1. `git rebase origin main` - Replace `main` with the branch you're working on. This will set our "base" (the starting point for our work) to the latest version of origin's main branch. That way our change to `a.txt` will appear to be *after* the change to `a.txt` from origin's main branch.
|
||||
2. You will likely see something like this:
|
||||
```sh
|
||||
Auto-merging a.txt
|
||||
CONFLICT (content): Merge conflict in a.txt
|
||||
error: could not apply 751b0ad... Added "cruel" to a.txt
|
||||
Resolve all conflicts manually, mark them as resolved with
|
||||
"git add/rm <conflicted_files>", then run "git rebase --continue".
|
||||
You can instead skip this commit: run "git rebase --skip".
|
||||
To abort and get back to the state before "git rebase", run "git rebase --abort".
|
||||
Could not apply 751b0ad... Added "cruel" to a.txt
|
||||
```
|
||||
3. As it says `Resolve all conflicts manually`, we need to resolve them by running `git mergetool`. This should open the merge tool of your choice. How to use your merge tool will not be expanded on here. Resolve all conflicts now. In our example we make it so that the file has both `cruel` and `beautiful`. Once all conflicts are resolved, close your merge tool.
|
||||
4. `git rebase --continue` - If your editor opens after this, just save and close it. If you get the error from 2., go to step 3. and repeat. Do this until you don't get it anymore. This will go through all commits and rebase them onto the newer branch, one-by-one.
|
||||
5. Eventually you should see `Successfully rebased and updated refs/heads/main`.
|
||||
6. You can now push your changes - but it won't let you `push` just like that (thanks, git). Instead, you want to **make sure you have successfully rebased and your history is "ahead" of the remote**. Then `git push --force-with-lease origin main`. **Never force-push to an official branch** (like BeamMP's `development` or BeamMP-Server's `master`), **ever**. Always use a feature-branch and PR it into the branch you want.
|
||||
@@ -0,0 +1,35 @@
|
||||
<!--
|
||||
title: Installation
|
||||
description: Installation guide for the BeamMP mod
|
||||
published: true
|
||||
date: 2022-12-22T09:23:41.349Z
|
||||
tags: install, tutorial
|
||||
editor: ckeditor
|
||||
dateCreated: 2020-06-17T23:04:09.658Z
|
||||
-->
|
||||
|
||||
<h1>Before You Get Started</h1>
|
||||
<ul>
|
||||
<li>This mod is only compatible with legitimate, Steam versions of the game. “Cracked” game copies are not supported.</li>
|
||||
<li>Local mods are not supported, all mods must be server-side mods that are installed on the server. Trying to go around this might lead to suspension of your account.</li>
|
||||
</ul>
|
||||
<h1>Windows Installation</h1>
|
||||
<ol>
|
||||
<li>Go to our <a href="https://beammp.com/">official website</a> and download the latest <code>BeamMP_Installer.zip</code> by clicking the green <strong>Download Client</strong> button.</li>
|
||||
<li>Open the <code>BeamMP_Installer.zip</code> archive.</li>
|
||||
<li>Launch <code>BeamMP_Installer.exe</code> and follow the instructions.</li>
|
||||
<li>An icon should appear on your desktop, double click it to run it. You should see a little black window appear and shortly after BeamNG.drive should start.</li>
|
||||
<li>Once it started, press “Play” and then “Multiplayer”.</li>
|
||||
<li>You will be prompted with a login pop-up, you can either play as a guest (not all servers will allow guests), or create an account on our <a href="https://forum.beammp.com/">forums</a> and then login with those credentials.</li>
|
||||
<li>Select any server you like and join it. Enjoy!</li>
|
||||
</ol>
|
||||
<h2>Known Issues</h2>
|
||||
<ul>
|
||||
<li>If you don't see the multiplayer button, make sure the BeamMP mod is activated, then try pressing CTRL + L.</li>
|
||||
</ul>
|
||||
<p>If you need further help with installation, you are welcome to create a post on our <a href="https://forum.beammp.com/">forum</a> or ask in the <a href="https://discord.com/invite/beammp">official discord server</a>! </p>
|
||||
<p>Have fun!</p>
|
||||
<h1>Linux Installation</h1>
|
||||
<ul>
|
||||
<li>BeamMP should work with <code>wine</code>, but is not officially supported (yet).</li>
|
||||
</ul>
|
||||
@@ -0,0 +1,131 @@
|
||||
<!--
|
||||
title: Server
|
||||
description: Basics of setting up the server application
|
||||
published: true
|
||||
date: 2022-12-22T09:23:45.618Z
|
||||
tags: server, tutorial
|
||||
editor: ckeditor
|
||||
dateCreated: 2020-06-17T21:05:01.162Z
|
||||
-->
|
||||
|
||||
<h1>Overview</h1>
|
||||
<p><span class="text-big">Making a server for BeamMP is very easy and free!</span></p>
|
||||
<p>Servers are an integral part of BeamMP; players are connected to each other through the server. They run natively on Windows and Linux.</p>
|
||||
<p>You can make private servers, which only people you invite can join, or public servers, which will show in our official server list.</p>
|
||||
<p>Getting a server up and running is a process with a few steps! It's quite easy, but if you run into any issues, feel free to ask on our <a href="https://forum.beammp.com">Forum</a> or on our <a href="https://discord.gg/beammp">Discord server</a> in the <code>#server-support</code> channel. Also refer to the <a href="https://wiki.beammp.com/en/home/server-maintenance">Server Maintenance</a> section for more info. </p>
|
||||
<p>Please make sure to read the <a href="https://raw.githubusercontent.com/BeamMP/BeamMP-Server/master/LICENSE">LICENSE</a> of the server before use.</p>
|
||||
<p>Note: <i>The server only supports IPv4. If you don't know which one you have, look at the IP address you see on </i><a href="https://www.whatsmyip.org/"><i>whatsmyip.org</i></a><i> - if it contains </i><code><i>:</i></code><i> colons, it's <strong>IPv6</strong>. In that case, you should investigate further whether you also have an IPv4. You can call your ISP to find this out, or ask someone who lives with you (if they're tech-savvy, they might know!). IPv6 support is planned.</i></p>
|
||||
<h1>Setting up the Server</h1>
|
||||
<p>Setup consists of a few steps, you should follow all of them.</p>
|
||||
<p> </p>
|
||||
<h2>1. Port forwarding</h2>
|
||||
<p><i>If you are on a VPS (Virtual Private Server) or Rootserver, you can usually skip this step. If you're unsure about what a VPS or Rootserver is, you aren't on one.</i></p>
|
||||
<p>This step is necessary if you want someone outside of your household to join ("outside of your local network").</p>
|
||||
<p>This step is the same for almost every game's server, such as Minecraft Servers, so you can find many tutorials online for this, even for your specific router model. A good full guide is <a href="https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/">this tutorial</a>. Make sure you forward port <strong>30814</strong>, as <strong>TCP</strong> and <strong>UDP</strong>. </p>
|
||||
<p>While the default <strong>Port</strong> you want to “forward” is <strong>30814</strong>, you can choose any other number >1024, but you need to note down what you picked if it's not 30814. You need to forward both <strong>TCP</strong> and <strong>UDP</strong>. </p>
|
||||
<p>If you have issues, also feel free to ask on our <a href="https://forum.beammp.com">Forum</a> or on our <a href="https://discord.gg/beammp">Discord server</a> in the <code>#server-support</code> channel.</p>
|
||||
<h3>1.1 Firewall</h3>
|
||||
<p>Depending on your setup, you may need to let BeamMP-Server through your firewall. This is the case on Windows (turning the firewall off does <strong>not</strong> work usually), and on a lot of preinstalled Linux servers. </p>
|
||||
<p>There, just like with the port forwarding, you want to allow the BeamMP-Server through the firewall, <strong>both incoming and outgoing connections</strong>, and <strong>both TCP and UDP</strong>. If your firewall asks for a port instead, that will have to be the same port you used in step “1. Port Forwarding” (usually 30814).</p>
|
||||
<h2>2. Obtaining an Authentication Key</h2>
|
||||
<p>The “Authentication Key”, often called “AuthKey”, is necessary for making a <strong>public</strong> server, but <strong>should</strong> be done for private servers, too.</p>
|
||||
<p>You will need a <a href="https://discord.com">Discord</a> account for this step. This is necessary to prevent spam.</p>
|
||||
<h3>2.1. </h3>
|
||||
<p>To get your key, head to the <a href="https://beammp.com/keymaster">Keymaster</a>, click on "Keys” on the left (key symbol) and then click on the blue '<i>here</i>' text. </p>
|
||||
<figure class="image"><img src="/keymaster1.png"></figure>
|
||||
<h3>2.2.</h3>
|
||||
<p> Next, fill out the Server Name field (this is just the key name not the actual name of the server on the list). Example:</p>
|
||||
<figure class="image image_resized" style="width:44.84%;"><img src="/keymaster_key.png"></figure>
|
||||
<p>It should, in the end, look something like this:</p>
|
||||
<figure class="image"><img src="/keymaster3.png"></figure>
|
||||
<p>Ignore the IP field as it doesn't do anything.</p>
|
||||
<p><strong>DO NOT EVER SHARE THIS KEY OR SHOW IT TO ANYONE. TREAT THIS LIKE A PASSWORD.</strong></p>
|
||||
<p>You have a limited number of keys. One key can be used on one server at a time, so you cannot start two servers at the same time with the same key.</p>
|
||||
<h3>2.3.</h3>
|
||||
<p>Now copy the text in the “Key” field, in this example that is <code>3173a2e-6az0-4542-a3p0-ddqq5ff95558</code> and hold onto it for the next step.</p>
|
||||
<p> </p>
|
||||
<h2>3. Installation</h2>
|
||||
<p>The BeamMP-Server is available for Windows and Linux. The next two sections are dedicated to Windows and Linux each. </p>
|
||||
<p> </p>
|
||||
<h2>3.a. Installation on Windows</h2>
|
||||
<p>For the Linux installation, see the next step.</p>
|
||||
<p>Please ensure you have port-forwarded before attempting to host a server! Without you ports being forwarded, you cannot host a server to the public!</p>
|
||||
<ol>
|
||||
<li>Download the server zip from <a href="https://www.beammp.com/">beammp.com</a>. You should end up with a compressed <code>.zip</code> archive, called something like <code>BeamMP-Server.zip</code>.</li>
|
||||
<li>Extract the <code>BeamMP-Server.zip</code>. You will end up with a <code>BeamMP-Server.exe</code> file, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server.exe</code> there. This is where your server will live.</li>
|
||||
<li>Start the server once by double-clicking on it. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a <code>Server.log</code> file and a <code>ServerConfig.toml</code> file next to your <code>BeamMP-Server.exe</code>.</li>
|
||||
<li>(optional) For quick access in the future you can easily create a desktop shortcut to <code>BeamMP-Server.exe</code> using<strong> [Right click]</strong> > <strong>Send to</strong> > <strong>Desktop (create shortcut).</strong></li>
|
||||
</ol>
|
||||
<p>Now proceed to the next step.</p>
|
||||
<p> </p>
|
||||
<h2>3.b. Installation on Linux</h2>
|
||||
<p>Skip this if you did “Installation on Windows”.</p>
|
||||
<h3>Using our build (recommended)</h3>
|
||||
<p>This step will work on Debian, Ubuntu, and similar Debian-derivatives on x86_64. If you're on a different distribution or architecture, refer to the "Building from source” step below.</p>
|
||||
<ol>
|
||||
<li>Ensure you have the dependencies installed which are listed <a href="https://github.com/BeamMP/BeamMP-Server#prerequisites">here</a>.</li>
|
||||
<li>Download the server zip from <a href="https://www.beammp.com/">beammp.com</a>. You should end up with a compressed <code>.zip</code> archive, called something like <code>BeamMP-Server.zip</code>.</li>
|
||||
<li>Extract the <code>BeamMP-Server.zip</code>. You will end up with a <code>BeamMP-Server-linux</code> file, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server-linux</code> there. This is where your server will live.</li>
|
||||
<li>Open a terminal, go to that folder you put the <code>BeamMP-Server-linux</code> in, and run <code>chmod +x BeamMP-Server-linux</code>. This ensures that you have permissions to run it.</li>
|
||||
<li>Start the server once by running it with <code>./BeamMP-Server-linux</code>. This will generate all the necessary files for you, once you see text you can close it and proceed to the next step. You should see a <code>Server.log</code> file and a <code>ServerConfig.toml</code> file next to your <code>BeamMP-Server-linux</code>.</li>
|
||||
<li>(optional) It is heavily recommended to set up a user called <code>beammpserver</code> (or similar), as we do NOT recommend running the server as root, sudo or with your personal user account. You should then take steps to make sure that you start the server as this user only.</li>
|
||||
</ol>
|
||||
<p>Now proceed to the next step.</p>
|
||||
<p> </p>
|
||||
<h3>Building from source</h3>
|
||||
<p>BeamMP-Server for Linux can be officially built on both Debian, Ubuntu, other Debian-derivatives, and ArchLinux. Other distributions are likely to work, too, but aren't officially supported. If you want to build it yourself you can do it by downloading the source on our <a href="https://github.com/BeamMP/BeamMP-Server">GitHub</a>, a tutorial can be found <a href="https://github.com/BeamMP/BeamMP-Server#build-instructions">here</a>.</p>
|
||||
<p>At the end, make sure to run your server once with <code>./BeamMP-Server</code> and then proceed to the next step.</p>
|
||||
<p> </p>
|
||||
<h2>4. Configuration</h2>
|
||||
<p>Now that you ran the server once, it should have created some files and probably uttered an error or two. This is because we are not yet done. Your folder should have these files:</p>
|
||||
<figure class="image"><img src="/after-running-once.png"></figure>
|
||||
<p>They might be called “ServerConfig”, “Server” and “BeamMP-Server” (no extensions like “.exe”), but that's correct, too!</p>
|
||||
<p>Open the <code>ServerConfig.toml</code> with a text editor such as <code>Notepad</code>. You can do this with [Right Click] → “Open With…” and then selecting a text editor.</p>
|
||||
<p>You should see something like this:</p>
|
||||
<pre><code class="language-c">[General]
|
||||
AuthKey = ''
|
||||
Debug = false
|
||||
Description = 'BeamMP Default Description'
|
||||
Map = '/levels/gridmap_v2/info.json'
|
||||
MaxCars = 1
|
||||
MaxPlayers = 10
|
||||
Name = 'BeamMP Server'
|
||||
Port = 30814
|
||||
Private = false
|
||||
ResourceFolder = 'Resources'</code></pre>
|
||||
<p>This is your configuration file. It uses a format called TOML. Refer to the <a href="https://wiki.beammp.com/en/home/server-maintenance">Server Maintenance</a> section for more info on this file.</p>
|
||||
<p>For now, we only care about the <code>AuthKey</code> field. Between the quotes <code>''</code>, you want to paste in your AuthKey you copied in the first step.</p>
|
||||
<p>For our example key, it should then look like this:</p>
|
||||
<pre><code class="language-c">AuthKey = '3173a2e-6az0-4542-a3p0-ddqq5ff95558'</code></pre>
|
||||
<p>Give your server a name, too, in the <code>Name</code> field. You can format this with colors and more, please refer to <a href="https://wiki.beammp.com/en/home/server-maintenance#customize-the-look-of-your-server-name">this section on Name customization</a> in the server maintenance page.</p>
|
||||
<p>If you picked a different <strong>Port</strong> other than <strong>30814</strong>, make sure to replace it here under <code>Port</code>.</p>
|
||||
<p><strong>IMPORTANT:</strong> Your server will <strong>NOT</strong> show in the server list as long as <code>Private = True</code>. <i>If</i> you want it to show in the list, set that to <code><strong>Private = False</strong></code>.</p>
|
||||
<h2>5. Validation</h2>
|
||||
<p>Now run your server again, and see if it spits out any more <code>[ERROR]</code> messages. It should just stay open. At this point, you can start BeamMP through the BeamMP-Launcher and you should find your server by the Name you entered in the <code>ServerConfig.toml</code> in the server list.</p>
|
||||
<h1>How to add mods to your server</h1>
|
||||
<p>Vehicle mods and map mods are different to install, but both require you to put them in your server's (<code>Resources/Client</code>) folder. Simply slide any mod you want to add in that folder. </p>
|
||||
<p> </p>
|
||||
<h2>General Mods</h2>
|
||||
<p>If you only wanted to add modded vehicles, you simply put the zip file of the mod in the <code>Resources/Client</code> folder. They will automatically be downloaded by anyone who joins your server.</p>
|
||||
<p> </p>
|
||||
<h2>Maps</h2>
|
||||
<p>All default maps (maps which aren't mods) work out-of-the-box and do not have to be installed. You simply change the <code>Map</code> setting in the <code>ServerConfig.toml</code> file to any of <a href="https://wiki.beammp.com/en/home/server-maintenance#all-vanilla-maps-names">these</a>. For any other modded maps, do this:</p>
|
||||
<ol>
|
||||
<li>Put your map's <code>.zip</code> file in your server's (<code>Resources/Client</code>) folder.</li>
|
||||
<li>Next, have a look inside the map's zip file (don't extract it) and open the <code>levels</code> folder. In this folder there should be simply one other folder with the name of the map, for example “myawesomedriftmap2021”. Make sure to copy or remember this name <i>exactly as it is written in that folder's name.</i></li>
|
||||
<li>Open your <code>ServerConfig.toml</code>. In the <code>Map</code> setting, you should see <code>/levels/MAPNAME/info.json</code>, where <code>MAPNAME</code> is likely something like <code>gridmap_v2</code>. You want to now replace this <code>MAPNAME</code> with the name of the folder from the last step, in that example it was <code>myawesomedriftmap2021</code>. In the end it should look like this (for this example) and <i><strong>should</strong></i> have <code>/info.json</code> at the end.</li>
|
||||
</ol>
|
||||
<pre><code class="language-c">Map = '/levels/myawesomedriftmap2021/info.json'</code></pre>
|
||||
<p>Now, when someone joins your server, it should download the map automatically and work as expected. </p>
|
||||
<p><strong>If this does NOT work</strong>, install the map in your singleplayer BeamNG.drive, launch it and enter the map. Then, open the Console by pressing the <code>~</code> (<i>tilde</i>) key (if you're on a non-US keyboard, look at the <strong>Toggle System Console</strong> action in the <strong>Options > Controls > Bindings</strong> menu, under the <strong>General Debug</strong> section), and run <code>print(getMissionFilename())</code>. This should then show you the name to use. </p>
|
||||
<p>That's it! Your modded map should now be available to join!</p>
|
||||
<h1>How to join your server</h1>
|
||||
<p>How you and other people can join your server.</p>
|
||||
<h2>Joining your own server</h2>
|
||||
<p>You must join your server by direct connecting, to do this, click the <strong>Direct Connect Tab</strong> on the left from the server list. Leave the default info in there (should be 127.0.0.1 and a port of 30814) then hit connect.<strong> </strong>If you server is hosted outside of your house you must <a href="https://whatismyipaddress.com/">find your IP </a>on that machine and direct connect that way.</p>
|
||||
<h2>Other people joining your server (Public)</h2>
|
||||
<p>For anyone else to join your server, it first must be port forwarded (<a href="https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/">A good guide here</a>). To join your public server they can simply go to the server list, type the name of the server, and click connect. If you are unsure of what your server name is, it will be the name you put in the <code>ServerConfig.toml</code></p>
|
||||
<h2>Other people joining your server (Private)</h2>
|
||||
<p>For anyone else to join your server, it first must be port forwarded (<a href="https://www.noip.com/support/knowledgebase/general-port-forwarding-guide/">A good guide here</a>). To join your private server they must go to the <strong>Direct Connect</strong> T<strong>ab</strong> in BeamMP, then type your IP and Port. If you are unsure of your IP <a href="https://whatismyipaddress.com/">here's a good website</a>. If you are unsure of your port the default is 30814, the port will be the same as the port you port forwarded.</p>
|
||||
<h2>Other people joining your server (Hamachi)</h2>
|
||||
<p>For someone to join your server, they must be on your Hamachi network, you do not need to be port forwarded for this. After joining your Hamachi network they will use the Hamachi IP and default port to direct connect to your server. For more info see our <a href="https://forum.beammp.com/t/tutorial-how-to-host-a-server-with-logmein-hamachi/52">Hamachi</a> guide.</p>
|
||||
@@ -0,0 +1,235 @@
|
||||
<!--
|
||||
title: Server Maintenance
|
||||
description: Guides, tips and tricks on how to configure and take care of a BeamMP Server.
|
||||
published: true
|
||||
date: 2022-12-22T09:23:49.906Z
|
||||
tags:
|
||||
editor: ckeditor
|
||||
dateCreated: 2021-06-20T08:48:03.720Z
|
||||
-->
|
||||
|
||||
<h1>How to Install</h1>
|
||||
<p>For installation instructions, please see <a href="https://wiki.beammp.com/en/home/server-installation">server installation</a>.</p>
|
||||
<h1>The ServerConfig File</h1>
|
||||
<p>The server config, which is a file called <code>ServerConfig.toml</code>, uses the <a href="https://toml.io/en/">TOML format</a>. (NOTE: The <i>old</i> server config file was called Server.cfg, but this is no longer used, and the server will warn when this is still present. Please also note that the two config formats are <strong>not</strong> compatible with each other.)</p>
|
||||
<p>The config has one section by default, called <code>[General]</code>, which holds the following values:<br> </p>
|
||||
<figure class="table">
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Key</td>
|
||||
<td>Value Type</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AuthKey</td>
|
||||
<td>
|
||||
<p>AuthKey format ‘xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx’</p>
|
||||
<p>where all x's are alphanumeric characters (numbers and letters). </p>
|
||||
</td>
|
||||
<td>Used to identify your server with the backend. You should have gotten one while following the installation instructions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Debug</td>
|
||||
<td>true / false</td>
|
||||
<td>When enabled (true), will show more messages in the log and provide more information. Enable this if you run into issues. Enabling this will <i>drastically</i> increase the size of the log file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Private</td>
|
||||
<td>true / false</td>
|
||||
<td>When enabled (true), your server will not be shown in the server list. Anyone with the correct IP and port can still connect.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Description</td>
|
||||
<td>Any "text"</td>
|
||||
<td>Shown as the description of the server in the server list (if the server is public). You can use special characters to format this with colors and styles.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Name</td>
|
||||
<td>Any “text”</td>
|
||||
<td>Shown as the name / title of your server in the server list. You can use special characters to format this with colors and styles.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Map</td>
|
||||
<td>A valid map location, such as <code>'/levels/gridmap_v2/info.json'</code></td>
|
||||
<td>The map your server will host. Has to be installed either by default (a list can be found below) or as a server mod.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>MaxCars</td>
|
||||
<td>Any number ≥ 1</td>
|
||||
<td>The maximum number of cars per player. Any additional cars a player tries to spawn will be deleted instantly.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Port</td>
|
||||
<td>1024–65535</td>
|
||||
<td>The networking port on which the server will be accessible. For a player to connect to your server directly, they will need your IP and this port.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</figure>
|
||||
<p>Other sections can and should be used by server plugins (Lua API coming soon), like so: <code>[MyMod]</code>.</p>
|
||||
<p>The AuthKey <strong><u>HAS</u></strong> to be set by you. It will be empty by default, and needs to be filled with your AuthKey from the installation step earlier. Do not share this Key with anyone and, in screenshots, blur it fully.</p>
|
||||
<h2>All Vanilla Maps Names</h2>
|
||||
<p>Here are all the stock maps </p>
|
||||
<ul>
|
||||
<li>/levels/gridmap_v2/info.json</li>
|
||||
<li>/levels/johnson_valley/info.json</li>
|
||||
<li>/levels/automation_test_track/info.json</li>
|
||||
<li>/levels/east_coast_usa/info.json</li>
|
||||
<li>/levels/hirochi_raceway/info.json</li>
|
||||
<li>/levels/italy/info.json</li>
|
||||
<li>/levels/jungle_rock_island/info.json</li>
|
||||
<li>/levels/industrial/info.json</li>
|
||||
<li>/levels/small_island/info.json</li>
|
||||
<li>/levels/smallgrid/info.json</li>
|
||||
<li>/levels/utah/info.json</li>
|
||||
<li>/levels/west_coast_usa/info.json</li>
|
||||
<li>/levels/driver_training/info.json</li>
|
||||
<li>/levels/derby/info.json</li>
|
||||
</ul>
|
||||
<h2>Customize the look of your server name</h2>
|
||||
<p>Use these special symbols before your text and it'll apply an effect to that text in the server list<br> </p>
|
||||
<figure class="table">
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^r</span></td>
|
||||
<td>reset</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^p</span></td>
|
||||
<td>newline (descriptions only)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^n</span></td>
|
||||
<td>underline</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^l</span></td>
|
||||
<td>bold</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^m</span></td>
|
||||
<td>strike-through</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^o</span></td>
|
||||
<td>italic</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^0</span></td>
|
||||
<td>black</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^1</span></td>
|
||||
<td>blue</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^2</span></td>
|
||||
<td>green</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^3</span></td>
|
||||
<td>light blue</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^4</span></td>
|
||||
<td>red</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^5</span></td>
|
||||
<td>pink</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^6</span></td>
|
||||
<td>orange</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^7</span></td>
|
||||
<td>grey</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^8</span></td>
|
||||
<td>dark grey</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^9</span></td>
|
||||
<td>light purple</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^a</span></td>
|
||||
<td>light green</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^b</span></td>
|
||||
<td>light blue</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^c</span></td>
|
||||
<td>dark orange</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^d</span></td>
|
||||
<td>light pink</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^e</span></td>
|
||||
<td>yellow</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span style="font-family:'Courier New', Courier, monospace;">^f</span></td>
|
||||
<td>white</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</figure>
|
||||
<h1>The Server.log file</h1>
|
||||
<p>This file will be generated when the server runs. It's a mirror of the messages you see in the console when you run the server. You should attach this file every time you need support from our support staff, and it will never show your AuthKey, so you can usually send it without modifications.</p>
|
||||
<p>The format is as follows ($ prefix means “variable”, explained below):<br> </p>
|
||||
<pre><code class="language-plaintext">[$DATE $TIME] $CONTEXT [$LOG_LEVEL] $MESSAGE</code></pre>
|
||||
<p>Where:</p>
|
||||
<ul>
|
||||
<li><code>$DATE</code> is the date of the message, for example 21/07/2021</li>
|
||||
<li><code>$TIME</code> is the time of the message, for example 11:05:23</li>
|
||||
<li><code>$CONTEXT</code> (only visible if in Debug mode and mostly relevant to developers) is the context of the message, which is either:<ul>
|
||||
<li><code>(Player ID) “Player Name”</code>, where the Player's ID is useful for moderation</li>
|
||||
<li>A short name such as “HeartbeatThread”</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>$LOG_LEVEL</code> is one of the levels of importance of a message:<ul>
|
||||
<li><code>DEBUG</code>: Only visible in Debug mode, usually spammy and only important to developers</li>
|
||||
<li><code>INFO</code>: General information</li>
|
||||
<li><code>LUA</code>: Message from a Lua plugin</li>
|
||||
<li><code>WARN</code>: Describes something that isn't supposed to happen, usually</li>
|
||||
<li><code>ERROR</code>: Something went very wrong, or was very unexpected</li>
|
||||
<li><code>FATAL</code>: Something happened that causes the server to shut down</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>$MESSAGE</code> the message itself, usually something that you should pay attention to and understand. In some cases this might be cryptic, but the general rule is that, as long as nothing is visibly wrong with the server and there are no <code>ERROR</code>s, all is good.</li>
|
||||
</ul>
|
||||
<h1>Updating The Server</h1>
|
||||
<h2>Why to Update</h2>
|
||||
<p>Whenever a new update is released, you're advised to update your server. Usually this involves bug fixes, stability improvements and security improvements, next to the general new features etc. that are introduced.</p>
|
||||
<p>To receive news about updates when they come out, either follow the discord server's “update” channel, look out for it on the forums, or look at / ask the <a href="https://github.com/BeamMP/BeamMP-Server/releases">GitHub releases page</a>.</p>
|
||||
<h2>How to Update</h2>
|
||||
<p>The server is updated by replacing the old executable with the new one. If you are unsure how to do this, there are step-by-step instructions for Windows and Linux below.</p>
|
||||
<p>If you built from source, you just rebuild. Make sure to run <code>git submodule update --init --recursive</code> before you rebuild.</p>
|
||||
<h3>On Windows</h3>
|
||||
<ol>
|
||||
<li>Go to <a href="https://beammp.com/">BeamMP.com</a> and click the “Download Server” button.</li>
|
||||
<li>Once downloaded, extract the zip file. You should see a few files, one of them the <code>BeamMP-Server.exe</code>. We will call this one the “new executable”.</li>
|
||||
<li>Go to the folder where your current <code>BeamMP-Server.exe</code> executable is located (same folder where your <code>ServerConfig.toml</code> is, usually). We will call this one the “old executable”.</li>
|
||||
<li>Replace the old executable with the new executable (for example by copying or moving the new executable into the folder).</li>
|
||||
</ol>
|
||||
<h3>On Linux</h3>
|
||||
<ol>
|
||||
<li>Go to <a href="https://beammp.com/">BeamMP.com</a> and click the “Download Server” button.</li>
|
||||
<li>Once downloaded, extract the zip file. You should see a few files, one of them the <code>BeamMP-Server-linux</code>. We will call this one the “new executable”.</li>
|
||||
<li>Go to the folder where your current <code>BeamMP-Server-linux</code> executable is located (same folder where your <code>ServerConfig.toml</code> is, usually). We will call this one the “old executable”.</li>
|
||||
<li>Replace the old executable with the new executable (for example by copying or moving the new executable into the folder).</li>
|
||||
<li>Open a terminal in that folder where you just replaced the executable, and run <code>sudo chmod +x BeamMP-Server-linux</code>. This will make sure the server can be run.</li>
|
||||
</ol>
|
||||
<h2>Automated Updates</h2>
|
||||
<p>The server does not support automatic updates or update notifications (yet).</p>
|
||||
<p>You can, however, ask the GitHub API for the lastest release by checking the server's version against the tags. You can get that by GET'ing from <code>https://api.github.com/repos/BeamMP/BeamMP-Server/git/refs/tags</code>.</p>
|
||||
<h1> </h1>
|
||||
@@ -0,0 +1,16 @@
|
||||
<!--
|
||||
title: Launcher Basics
|
||||
description: This will guide you through the different elements of the BeamMP Launcher
|
||||
published: true
|
||||
date: 2022-12-22T09:23:53.339Z
|
||||
tags: launcher
|
||||
editor: ckeditor
|
||||
dateCreated: 2020-06-17T20:56:47.594Z
|
||||
-->
|
||||
|
||||
<p>The launcher is the <strong>main access point to the MP mod</strong>. It updates automatically, and updates the mod automatically too.<br> </p>
|
||||
<p>Since BeamMP Lua V4.0 Discord is not required anymore in order to use the mod.</p>
|
||||
<p> </p>
|
||||
<figure class="image image_resized" style="width:84.59%;"><img src="/launcher_example_better.png">
|
||||
<figcaption>The Launcher</figcaption>
|
||||
</figure>
|
||||
@@ -0,0 +1,16 @@
|
||||
<!--
|
||||
title: General Information about the Mod
|
||||
description: The past, present and future of BeamMP.
|
||||
published: true
|
||||
date: 2022-12-22T09:23:57.075Z
|
||||
tags: project
|
||||
editor: ckeditor
|
||||
dateCreated: 2020-06-17T21:16:54.859Z
|
||||
-->
|
||||
|
||||
<h2>v1.0</h2>
|
||||
<p>BeamMP started late 2019, with the first version being based on JavaScript, and still using the old Bridge (which at the time didn't have a server selection menu). - The bridge was used to suppliment the ingame UI mod, it was the cause of a few problems, and ultimately bulked the ease of installation.<br> </p>
|
||||
<h2>v1.5</h2>
|
||||
<p>It later evolved into a more complex version, featuring a revamped UI (added palyer list, ping, and chat), and the Bridge got a server selection menu. It was still very primitive and hard to use, the syncing was bad as players only teleported. It was still cumbersome to get up and running, requiring a mod to be installed into the mods folder, and for the bridge application to be run simultaneously to the game being launched... sounds complicated? it wasn't ideal.<br> </p>
|
||||
<h2>v2.0</h2>
|
||||
<p>Now the MP mod has been completely rebuilt in C++, introducing a brand new UI fully integrated into the in-game UI, including an in-game server browser. Everything has been packed into a single and easy to use .exe, resulting in a one-click-run mod, making for a super easy to use multiplayer experince. It's just like openining the vanilla game, but now you can play with your friends!</p>
|
||||
Reference in new issue
Block a user