BeamMP/Docs
1
0
Fork 0
mirror of https://github.com/BeamMP/Docs.git synced 2025-07-03 16:36:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Docs/server/create-a-server/index.html

3457 lines
96 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="This website serves as the new BeamMP Documentation site for general self serve support, guides and documentation. Best of all it is source available so you the community can help us to A. keep it up-to-date and B. providing the content you require.">
<link rel="canonical" href="https://docs.beammp.com/server/create-a-server/">
<link rel="prev" href="../../game/multiplayer-settings/">
<link rel="next" href="../port-forwarding/">
<link rel="icon" href="../../assets/core/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
<title>Server Installation - BeamMP Docs</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../stylesheets/custom.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-8T6ETLZCMC"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-8T6ETLZCMC",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-8T6ETLZCMC",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
<script>if("undefined"!=typeof __md_analytics){var consent=__md_get("__consent");consent&&consent.analytics&&__md_analytics()}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="Server Installation - BeamMP Docs" >
<meta property="og:description" content="This website serves as the new BeamMP Documentation site for general self serve support, guides and documentation. Best of all it is source available so you the community can help us to A. keep it up-to-date and B. providing the content you require." >
<meta property="og:image" content="https://docs.beammp.com/assets/images/social/en/server/create-a-server.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://docs.beammp.com/server/create-a-server/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Server Installation - BeamMP Docs" >
<meta name="twitter:description" content="This website serves as the new BeamMP Documentation site for general self serve support, guides and documentation. Best of all it is source available so you the community can help us to A. keep it up-to-date and B. providing the content you require." >
<meta name="twitter:image" content="https://docs.beammp.com/assets/images/social/en/server/create-a-server.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#server-installation" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="/" title="BeamMP Docs" class="md-header__button md-logo" aria-label="BeamMP Docs" data-md-component="logo">
<img src="../../assets/core/beammp_dark.png" alt="logo" class="logo-light" />
<img src="../../assets/core/beammp_light.png" alt="logo" class="logo-dark" />
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
BeamMP Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Server Installation
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<div class="md-header__option">
<div class="md-select">
<button class="md-header__button md-icon" aria-label="Select language">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12.87 15.07-2.54-2.51.03-.03A17.5 17.5 0 0 0 14.07 6H17V4h-7V2H8v2H1v2h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2zm-2.62 7 1.62-4.33L19.12 17z"/></svg>
</button>
<div class="md-select__inner">
<ul class="md-select__list">
<li class="md-select__item">
<a href="./" hreflang="en" class="md-select__link">
English
</a>
</li>
<li class="md-select__item">
<a href="../../es/server/create-a-server/" hreflang="es" class="md-select__link">
Español
</a>
</li>
<li class="md-select__item">
<a href="../../de/server/create-a-server/" hreflang="de" class="md-select__link">
Deutsch
</a>
</li>
<li class="md-select__item">
<a href="../../fr/server/create-a-server/" hreflang="fr" class="md-select__link">
Français
</a>
</li>
<li class="md-select__item">
<a href="../../it/server/create-a-server/" hreflang="it" class="md-select__link">
Italiano
</a>
</li>
<li class="md-select__item">
<a href="../../ru/server/create-a-server/" hreflang="ru" class="md-select__link">
Pусский
</a>
</li>
</ul>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/beammp/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
beammp/docs
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../game/getting-started/" class="md-tabs__link">
Support
</a>
</li>
<li class="md-tabs__item">
<a href="../../FAQ/How-to-check-for-CGNAT/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../guides/" class="md-tabs__link">
Development Guides
</a>
</li>
<li class="md-tabs__item">
<a href="../../beamng/" class="md-tabs__link">
BeamNG Documentation
</a>
</li>
<li class="md-tabs__item">
<a href="../../scripting/mod-reference/" class="md-tabs__link">
Scripting Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../../contributing/" class="md-tabs__link">
Contributing
</a>
</li>
<li class="md-tabs__item">
<a href="../../community/" class="md-tabs__link">
Community
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="/" title="BeamMP Docs" class="md-nav__button md-logo" aria-label="BeamMP Docs" data-md-component="logo">
<img src="../../assets/core/beammp_dark.png" alt="logo" class="logo-light" />
<img src="../../assets/core/beammp_light.png" alt="logo" class="logo-dark" />
</a>
BeamMP Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/beammp/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
beammp/docs
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Support
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Support
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_1" >
<label class="md-nav__link" for="__nav_2_1" id="__nav_2_1_label" tabindex="">
<span class="md-ellipsis">
Playing BeamMP
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_1">
<span class="md-nav__icon md-icon"></span>
Playing BeamMP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../game/getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Installing BeamMP
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../game/error-codes/" class="md-nav__link">
<span class="md-ellipsis">
Error Codes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../game/multiplayer-settings/" class="md-nav__link">
<span class="md-ellipsis">
Multiplayer Settings
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
<label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="">
<span class="md-ellipsis">
Running a BeamMP-Server
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2_2">
<span class="md-nav__icon md-icon"></span>
Running a BeamMP-Server
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Server Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Server Installation
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#creating-a-server" class="md-nav__link">
<span class="md-ellipsis">
Creating a Server
</span>
</a>
<nav class="md-nav" aria-label="Creating a Server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setting-up-the-server" class="md-nav__link">
<span class="md-ellipsis">
Setting up the Server
</span>
</a>
<nav class="md-nav" aria-label="Setting up the Server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-port-forwarding" class="md-nav__link">
<span class="md-ellipsis">
1. Port forwarding
</span>
</a>
<nav class="md-nav" aria-label="1. Port forwarding">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#partnered-hosting-services-paid" class="md-nav__link">
<span class="md-ellipsis">
Partnered Hosting Services (paid):
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#11-firewall" class="md-nav__link">
<span class="md-ellipsis">
1.1 Firewall
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-obtaining-an-authentication-key" class="md-nav__link">
<span class="md-ellipsis">
2. Obtaining an Authentication Key
</span>
</a>
<nav class="md-nav" aria-label="2. Obtaining an Authentication Key">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#21-accessing-the-keys-page" class="md-nav__link">
<span class="md-ellipsis">
2.1. Accessing the keys page
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#22-creating-a-key" class="md-nav__link">
<span class="md-ellipsis">
2.2. Creating a key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#23-filling-out-the-key-information" class="md-nav__link">
<span class="md-ellipsis">
2.3. Filling out the key information
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#24-copying-the-key" class="md-nav__link">
<span class="md-ellipsis">
2.4. Copying the key
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-installation" class="md-nav__link">
<span class="md-ellipsis">
3. Installation
</span>
</a>
<nav class="md-nav" aria-label="3. Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#3a-installation-on-windows" class="md-nav__link">
<span class="md-ellipsis">
3.a. Installation on Windows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3b-installation-on-linux" class="md-nav__link">
<span class="md-ellipsis">
3.b. Installation on Linux
</span>
</a>
<nav class="md-nav" aria-label="3.b. Installation on Linux">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#using-our-build-recommended" class="md-nav__link">
<span class="md-ellipsis">
Using our build (recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#building-from-source" class="md-nav__link">
<span class="md-ellipsis">
Building from source
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-configuration" class="md-nav__link">
<span class="md-ellipsis">
4. Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-validation" class="md-nav__link">
<span class="md-ellipsis">
5. Validation
</span>
</a>
<nav class="md-nav" aria-label="5. Validation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#51-how-to-add-mods-to-your-server" class="md-nav__link">
<span class="md-ellipsis">
5.1 How to add mods to your server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#52-general-mods" class="md-nav__link">
<span class="md-ellipsis">
5.2 General Mods
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#53-maps" class="md-nav__link">
<span class="md-ellipsis">
5.3 Maps
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#6-how-to-join-your-server" class="md-nav__link">
<span class="md-ellipsis">
6. How to join your server
</span>
</a>
<nav class="md-nav" aria-label="6. How to join your server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#6a-joining-your-own-server-both-private-and-public" class="md-nav__link">
<span class="md-ellipsis">
6.a. Joining your own server (both private and public)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6b-other-people-joining-your-private-server" class="md-nav__link">
<span class="md-ellipsis">
6.b. Other people joining your private server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6c-other-people-joining-your-public-server" class="md-nav__link">
<span class="md-ellipsis">
6.c. Other people joining your public server
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#still-facing-issues" class="md-nav__link">
<span class="md-ellipsis">
Still facing issues?
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../port-forwarding/" class="md-nav__link">
<span class="md-ellipsis">
Port Forwarding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../server-maintenance/" class="md-nav__link">
<span class="md-ellipsis">
Server Maintenance
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../error-codes/" class="md-nav__link">
<span class="md-ellipsis">
Error Codes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../manual/" class="md-nav__link">
<span class="md-ellipsis">
Server Manual
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
<label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="">
<span class="md-ellipsis">
Mod & Resource Creation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_3">
<span class="md-nav__icon md-icon"></span>
Mod & Resource Creation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guides/mod-creation/server/getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Server Side
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
FAQ
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
FAQ
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../FAQ/How-to-check-for-CGNAT/" class="md-nav__link">
<span class="md-ellipsis">
How to check for CGNAT?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/where-to-find-my-IP/" class="md-nav__link">
<span class="md-ellipsis">
Where can I find my IP address?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/How-to-deactivate-mods/" class="md-nav__link">
<span class="md-ellipsis">
How to deactivate my mods?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/Update-launcher/" class="md-nav__link">
<span class="md-ellipsis">
Manually updating the Launcher
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/Change-launcher-port/" class="md-nav__link">
<span class="md-ellipsis">
Changing the Launcher port
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/Defender-exclusions/" class="md-nav__link">
<span class="md-ellipsis">
Creating Exclusions (Defender)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/player-faq/" class="md-nav__link">
<span class="md-ellipsis">
Player FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/game-faq/" class="md-nav__link">
<span class="md-ellipsis">
Game FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../FAQ/server-faq/" class="md-nav__link">
<span class="md-ellipsis">
Server FAQ
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<div class="md-nav__link md-nav__container">
<a href="../../guides/" class="md-nav__link ">
<span class="md-ellipsis">
Development Guides
</span>
<span class="md-status md-status--new" title="Recently added">
</span>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Development Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guides/beammp-dev/beammp-dev/" class="md-nav__link">
<span class="md-ellipsis">
Development Environment Setup
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Mod Creation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Mod Creation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../scripting/mod-reference/" class="md-nav__link">
<span class="md-ellipsis">
Client Scripting Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Resource Creation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Resource Creation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guides/mod-creation/server/getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Server Side
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<div class="md-nav__link md-nav__container">
<a href="../../beamng/" class="md-nav__link ">
<span class="md-ellipsis">
BeamNG Documentation
</span>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
BeamNG Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_2" >
<div class="md-nav__link md-nav__container">
<a href="../../beamng/dev/" class="md-nav__link ">
<span class="md-ellipsis">
Content Development
</span>
</a>
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_2">
<span class="md-nav__icon md-icon"></span>
Content Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_2_2" >
<label class="md-nav__link" for="__nav_5_2_2" id="__nav_5_2_2_label" tabindex="0">
<span class="md-ellipsis">
Programming
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_2_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_2_2">
<span class="md-nav__icon md-icon"></span>
Programming
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../beamng/dev/modding/ui-apps/" class="md-nav__link">
<span class="md-ellipsis">
UI Apps (HTML)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../beamng/dev/modding/imgui-windows/" class="md-nav__link">
<span class="md-ellipsis">
IMGUI Windows (Lua)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../beamng/dev/modding/lua-mods/" class="md-nav__link">
<span class="md-ellipsis">
Lua Mods (Scripts)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_2_3" >
<label class="md-nav__link" for="__nav_5_2_3" id="__nav_5_2_3_label" tabindex="0">
<span class="md-ellipsis">
Content
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_5_2_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_2_3">
<span class="md-nav__icon md-icon"></span>
Content
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../beamng/dev/content/maps/" class="md-nav__link">
<span class="md-ellipsis">
Maps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../beamng/dev/content/props/" class="md-nav__link">
<span class="md-ellipsis">
Props
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../beamng/dev/content/vehicles/" class="md-nav__link">
<span class="md-ellipsis">
Vehicles
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../beamng/snippets/" class="md-nav__link">
<span class="md-ellipsis">
Helpful Code Snippets
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Scripting Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Scripting Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../scripting/mod-reference/" class="md-nav__link">
<span class="md-ellipsis">
Client Scripting Reference
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
<label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
<span class="md-ellipsis">
Server
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
Server
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../scripting/server/latest-server-reference/" class="md-nav__link">
<span class="md-ellipsis">
Version 3.X (Latest)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../scripting/server/v2-server-reference/" class="md-nav__link">
<span class="md-ellipsis">
Version 2.X (Deprecated)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../contributing/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<div class="md-nav__link md-nav__container">
<a href="../../community/" class="md-nav__link ">
<span class="md-ellipsis">
Community
</span>
</a>
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Community
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../community/rules/" class="md-nav__link">
<span class="md-ellipsis">
Rules
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#creating-a-server" class="md-nav__link">
<span class="md-ellipsis">
Creating a Server
</span>
</a>
<nav class="md-nav" aria-label="Creating a Server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setting-up-the-server" class="md-nav__link">
<span class="md-ellipsis">
Setting up the Server
</span>
</a>
<nav class="md-nav" aria-label="Setting up the Server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-port-forwarding" class="md-nav__link">
<span class="md-ellipsis">
1. Port forwarding
</span>
</a>
<nav class="md-nav" aria-label="1. Port forwarding">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#partnered-hosting-services-paid" class="md-nav__link">
<span class="md-ellipsis">
Partnered Hosting Services (paid):
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#11-firewall" class="md-nav__link">
<span class="md-ellipsis">
1.1 Firewall
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-obtaining-an-authentication-key" class="md-nav__link">
<span class="md-ellipsis">
2. Obtaining an Authentication Key
</span>
</a>
<nav class="md-nav" aria-label="2. Obtaining an Authentication Key">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#21-accessing-the-keys-page" class="md-nav__link">
<span class="md-ellipsis">
2.1. Accessing the keys page
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#22-creating-a-key" class="md-nav__link">
<span class="md-ellipsis">
2.2. Creating a key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#23-filling-out-the-key-information" class="md-nav__link">
<span class="md-ellipsis">
2.3. Filling out the key information
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#24-copying-the-key" class="md-nav__link">
<span class="md-ellipsis">
2.4. Copying the key
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-installation" class="md-nav__link">
<span class="md-ellipsis">
3. Installation
</span>
</a>
<nav class="md-nav" aria-label="3. Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#3a-installation-on-windows" class="md-nav__link">
<span class="md-ellipsis">
3.a. Installation on Windows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3b-installation-on-linux" class="md-nav__link">
<span class="md-ellipsis">
3.b. Installation on Linux
</span>
</a>
<nav class="md-nav" aria-label="3.b. Installation on Linux">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#using-our-build-recommended" class="md-nav__link">
<span class="md-ellipsis">
Using our build (recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#building-from-source" class="md-nav__link">
<span class="md-ellipsis">
Building from source
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-configuration" class="md-nav__link">
<span class="md-ellipsis">
4. Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-validation" class="md-nav__link">
<span class="md-ellipsis">
5. Validation
</span>
</a>
<nav class="md-nav" aria-label="5. Validation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#51-how-to-add-mods-to-your-server" class="md-nav__link">
<span class="md-ellipsis">
5.1 How to add mods to your server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#52-general-mods" class="md-nav__link">
<span class="md-ellipsis">
5.2 General Mods
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#53-maps" class="md-nav__link">
<span class="md-ellipsis">
5.3 Maps
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#6-how-to-join-your-server" class="md-nav__link">
<span class="md-ellipsis">
6. How to join your server
</span>
</a>
<nav class="md-nav" aria-label="6. How to join your server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#6a-joining-your-own-server-both-private-and-public" class="md-nav__link">
<span class="md-ellipsis">
6.a. Joining your own server (both private and public)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6b-other-people-joining-your-private-server" class="md-nav__link">
<span class="md-ellipsis">
6.b. Other people joining your private server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6c-other-people-joining-your-public-server" class="md-nav__link">
<span class="md-ellipsis">
6.c. Other people joining your public server
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#still-facing-issues" class="md-nav__link">
<span class="md-ellipsis">
Still facing issues?
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/beammp/docs/edit/main/docs/en/server/create-a-server.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
</a>
<a href="https://github.com/beammp/docs/raw/main/docs/en/server/create-a-server.md" title="View source of this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
</a>
<h1 id="server-installation">Server Installation</h1>
<h2 id="creating-a-server"><strong>Creating a Server</strong></h2>
<p>Basics of setting up the server application</p>
<hr />
<h3 id="overview"><strong>Overview</strong></h3>
<p><strong>Creating a Home Server is free, hosting one with a VPS is easier and more secure</strong></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 of a few steps! 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>#support</code> channel. Also refer to the <a href="../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: <em>The server only supports IPv4. If you don't know which one you have, look at the IP address you see on <a href="https://www.whatsmyip.org/"><em>whatsmyip.org</em></a> - if it contains</em> <code>_:_</code> <em>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.</em></p>
<h2 id="setting-up-the-server">Setting up the Server</h2>
<p>The setup consists of the following steps, you should follow all of them.</p>
<h3 id="1-port-forwarding"><strong>1. Port forwarding</strong></h3>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>If you are on a VPS (Virtual Private Server), Rootserver, or plan on hosting this server locally (with players in the same house as you), you can skip this step.
This step is necessary if you want someone <strong>outside</strong> of your household to join your home-hosted server (outside of your local network).</p>
<div class="admonition danger">
<p class="admonition-title"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 3c-1.27 0-2.4.8-2.82 2H3v2h1.95L2 14c-.47 2 1 3 3.5 3s4.06-1 3.5-3L6.05 7h3.12c.33.85.98 1.5 1.83 1.83V20H2v2h20v-2h-9V8.82c.85-.32 1.5-.97 1.82-1.82h3.13L15 14c-.47 2 1 3 3.5 3s4.06-1 3.5-3l-2.95-7H21V5h-6.17C14.4 3.8 13.27 3 12 3m0 2a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-6.5 5.25L7 14H4zm13 0L20 14h-3z"/></svg></span> DISCLAIMER:</p>
<p><strong>Port forwarding is a risk</strong>.</p>
<p>By port forwarding, you understand the risks of opening up ports on your home network to the public and therefore void the right to hold BeamMP accountable for <strong>any and all</strong> damages that may happen to you or your household.</p>
<p>We take no responsibility for any content on any externally linked services or websites.</p>
</div>
<p>It is therefore recommended to host a server with one of our partnered services!</p>
<p><em>Please see <a href="../port-forwarding/">this guide on how to port forward</a></em></p>
</div>
<h4 id="partnered-hosting-services-paid">Partnered Hosting Services (paid):</h4>
<ul>
<li><a href="https://hrzn.link/beammp">Horizon Hosting</a></li>
<li><a href="https://rackgeni.us/beammp-plans">RackGenius</a></li>
<li><a href="https://connecthosting.net/beammp">Connect Hosting</a></li>
<li><a href="https://assettohosting.com/en/games/beamng">Assetto Hosting</a></li>
<li><a href="https://zap-hosting.com/en/beammp-server-hosting/">Zap Hosting</a></li>
<li><a href="https://hosthavoc.com/">HostHavoc</a></li>
<li><a href="https://pedal.host/">PedalHost</a></li>
<li><a href="https://vyperhosting.com/r/beammp">Vyper Hosting</a></li>
<li><a href="https://www.bisecthosting.com/beammp-server-hosting">BisectHosting</a></li>
<li><a href="https://fourseasonshosting.com">Four Seasons Hosting</a></li>
<li><a href="https://vertuohosting.com">Vertuo Hosting</a></li>
<li><a href="https://winheberg.fr/offres/gaming/beammp?lang=en">Winheberg</a></li>
</ul>
<h4 id="11-firewall">1.1 Firewall</h4>
<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 usually does <strong>not</strong> work), and on a lot of preinstalled Linux servers. </p>
<p>There 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>
<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>#support</code> channel.</p>
<h3 id="2-obtaining-an-authentication-key"><strong>2. Obtaining an Authentication Key</strong></h3>
<p>The “Authentication Key”, often called “AuthKey”, is necessary for making a <strong>public</strong> server accessible by the serverlist. Though it is recommended to add the authkey to private servers as well.
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.
More keys can be obtained by supporting the project. Read <a href="https://docs.beammp.com/support/player-faq/">this article</a> for more information.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>DO NOT EVER SHARE THIS KEY OR SHOW IT TO ANYONE. TREAT THIS LIKE A PASSWORD.</p>
</div>
<p>You will need a <a href="https://discord.com">Discord</a> account for this step. This is necessary to prevent spam.</p>
<h4 id="21-accessing-the-keys-page">2.1. Accessing the keys page</h4>
<p>Login with Discord to the <a href="https://beammp.com/keymaster">Keymaster</a>.
From the Keymaster homepage click on "Keys" on the left of the screen:</p>
<figure>
<p><img alt="" src="../../assets/content/keymaster_homepage.png" /></p>
</figure>
<h4 id="22-creating-a-key">2.2. Creating a key</h4>
<p>To create your key, click on the green "+" button in the top right. </p>
<figure>
<p><img alt="" src="../../assets/content/keymaster_new_key.png" /></p>
</figure>
<h4 id="23-filling-out-the-key-information">2.3. Filling out the key information</h4>
<p>Next, fill out the Server Name field (this is just the keys name and not the actual name of the server on the list), then click "Create". Example:</p>
<figure class="image image_resized" style="width:44.84%;">
<p><img alt="" src="../../assets/content/keymaster_server_name.png" /></p>
</figure>
<p>It should, in the end, look something like this:</p>
<figure>
<p><img alt="" src="../../assets/content/keymaster_key_done.png" /></p>
</figure>
<h4 id="24-copying-the-key">2.4. Copying the key</h4>
<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. You can do this by clicking the clipboard on the right of the key:</p>
<figure>
<p><img alt="" src="../../assets/content/keymaster_copy_key.png" /></p>
</figure>
<h3 id="3-installation"><strong>3. Installation</strong></h3>
<p>The BeamMP-Server is available for Windows and Linux. The next two sections are dedicated to Windows and Linux each. </p>
<h4 id="3a-installation-on-windows">3.a. Installation on Windows</h4>
<p>For the Linux installation, see the next step.</p>
<p>Please ensure you have port-forwarded before attempting to host a server at home! Without you ports being forwarded, you cannot host a server to the public!</p>
<ol>
<li>Ensure you have installed the <a href="https://aka.ms/vs/17/release/vc_redist.x64.exe">Visual C++ Redistributables</a> in order to run the server.</li>
<li>Download the server executable from <a href="https://www.beammp.com/">beammp.com</a>. You should end up with an executable file, called something like <code>BeamMP-Server.exe</code>.</li>
<li>Once downloaded, 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>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> &gt; <strong>Send to</strong> &gt; <strong>Desktop (create shortcut).</strong></li>
</ol>
<p>Now proceed to step <a href="#4-configuration">4. Configuration</a>.</p>
<h4 id="3b-installation-on-linux">3.b. Installation on Linux</h4>
<h5 id="using-our-build-recommended">Using our build (recommended)</h5>
<p>This step will work on all distributions we provide binaries for <a href="https://github.com/BeamMP/BeamMP-Server/releases/latest">here</a>. 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#runtime-dependencies">here</a>.</li>
<li>Go to <a href="https://beammp.com/">beammp.com</a> and click the “Download Server” button, you will be redirected to the server's Github release page.</li>
<li>Download the correct version for your distro. For sake of semplicity it will be called <code>BeamMP-Server-xxx</code> from now on, where <code>xxx</code> denotes the version for the distro you're using.</li>
<li>Once downloaded, you should see one file called <code>BeamMP-Server-xxx</code>, among others which you can ignore for now. Make a folder somewhere and put the <code>BeamMP-Server-xxx</code> there. This is where your server will live.</li>
<li>Open a terminal, go to that folder you put the <code>BeamMP-Server-xxx</code> in, and run <code>chmod +x BeamMP-Server-xxx</code>. This ensures that you have permissions to run it.</li>
<li>Start the server once by running it with <code>./BeamMP-Server-xxx</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>ServerConfig.toml</code> file next to your <code>BeamMP-Server-xxx</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 step "4. Configuration".</p>
<h5 id="building-from-source">Building from source</h5>
<p>Other distributions in addition to the ones that already have a binary <a href="https://github.com/BeamMP/BeamMP-Server/releases/latest">here</a> 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>
<h3 id="4-configuration"><strong>4. Configuration</strong></h3>
<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>
<p><img alt="" src="../../assets/content/after-running-once.png" /></p>
</figure>
<p>They are called “ServerConfig.toml”, “Server.log” and “BeamMP-Server.exe”! (Depending on your settings, you might not see the [.toml] [.log] [.exe] extentions)</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>
<div class="language-TOML highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">[General]</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="n">AuthKey</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;&#39;</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="n">Debug</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">Description</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;BeamMP Default Description&#39;</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="n">Map</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;/levels/gridmap_v2/info.json&#39;</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="n">MaxCars</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="n">MaxPlayers</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">10</span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="n">Name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;BeamMP Server&#39;</span>
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="n">Port</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">30814</span>
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="n">Private</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span>
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="n">ResourceFolder</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;Resources&#39;</span>
</span></code></pre></div>
<p>This is your configuration file. It uses a format called TOML. Refer to the <a href="../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:
<div class="language-TOML highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">AuthKey</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;3173a2e-6az0-4542-a3p0-ddqq5ff95558&#39;</span>
</span></code></pre></div>
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="../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>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>Your server will <strong>NOT</strong> show in the server list as long as <code>Private = true</code>. <em>If</em> you want it to show in the list, set that to <strong><code>Private = false</code></strong>.</p>
</div>
<h3 id="5-validation"><strong>5. Validation</strong></h3>
<p>Now run your server again, and see if it spits out any more <code>[ERROR]</code> or <code>[WARN]</code> messages. The server should stay open now. In the following steps (6.) below you can find out how to join the server.</p>
<hr />
<h4 id="51-how-to-add-mods-to-your-server">5.1 How to add mods to your server</h4>
<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>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Should you receive a "done" or "start" message when trying to join your server after adding mods, you likely added an incompatible or broken mod to your server.
Mod incompatibilities can also occur between 2 or more mods. If you have client mods installed, check <a href="../../FAQ/How-to-deactivate-mods/">this guide</a> about removing mods from your game.</p>
</div>
<h4 id="52-general-mods">5.2 General Mods</h4>
<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>
<h4 id="53-maps">5.3 Maps</h4>
<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="../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 <em>exactly as it is written in that folder's name.</em></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 <em><strong>should</strong></em> have <code>/info.json</code> at the end.</li>
</ol>
<div class="language-TOML highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="n">Map</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">&#39;/levels/myawesomedriftmap2021/info.json&#39;</span>
</span></code></pre></div>
<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> (<em>tilde</em>) key (if you're on a non-US keyboard, look at the <strong>Toggle System Console</strong> action in the <strong>Options &gt; Controls &gt; 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>
<h3 id="6-how-to-join-your-server"><strong>6. How to join your server</strong></h3>
<p>How you and other players can join your server.</p>
<h4 id="6a-joining-your-own-server-both-private-and-public">6.a. Joining your own server (both private and public)</h4>
<p>If your server is hosted on the same PC as the game runs on, 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 corresponding port) then hit connect.</p>
<p>If your server is hosted on another PC in your local network, you must find the local IP of that machine and direct connect using this local IP.</p>
<p>If your server is hosted outside of your house (e.g. VPS) you must find the <a href="https://whatismyipaddress.com/">public IP</a> of that machine and direct connect that way.</p>
<h4 id="6b-other-people-joining-your-private-server">6.b. Other people joining your private server</h4>
<p>You have to give other users the public IP Address of your Server. However, be careful sharing your public IP address with strangers! To join your private server the players must go to the <strong>Direct Connect Tab</strong> in BeamMP, then type your IP and Port.</p>
<h4 id="6c-other-people-joining-your-public-server">6.c. Other people joining your public server</h4>
<p>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>.
Make sure search filters are disabled and the Map set to "Any" if you can't find it.
You can also check the <a href="https://beammp.com/keymaster">Keymaster</a> Website for the Servers IP Address.</p>
<p>Should you or your friends experience a "Connection Failed!" Error, check the Launcher Window for codes like 10060, 10061, 10030.
This means you eihter have a CGNAT IPv4, or you have done something wrong during Step <strong>1 Port Forwarding</strong> or <strong>1.1. Firewall</strong>.
To check if you have a CGNAT IPv4, look up the WAN IP Address on your routers interface. Compare it to your <a href="https://www.whatsmyip.org/">public IP</a>. If they're the same, you are not behind a CGNAT.
IPv6 Support is <strong>NOT</strong> yet implemented.</p>
<div class="admonition warning">
<p class="admonition-title">I want to use a VPN such as RadminVPN, Hamachi, or similar.</p>
<p>BeamMP does not support these VPNs, as they often cause issues. One of these issues is UDP traffic not being forwarded. To resolve this, refer to section 1.</p>
<div class="admonition question">
<p class="admonition-title">But why has it worked in the past?</p>
<p>This is due to the developers of these applications updating their software and implementing changes which BeamMP has no control over.
It is up to the developers of these applications to provide support for specific use cases like a BeamMP-Server.</p>
</div>
</div>
<h2 id="still-facing-issues">Still facing issues?</h2>
<p>Open a Thread on the <a href="https://forum.beammp.com">Forum</a> or on our <a href="https://discord.gg/beammp">Discord server</a> in the <code>#support</code> channel.</p>
<aside class="md-source-file">
<span class="md-source-file__fact">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="June 21, 2025 18:28:09 UTC">June 21, 2025</span>
</span>
<span class="md-source-file__fact">
<span class="md-icon" title="Created">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="June 21, 2025 18:28:09 UTC">June 21, 2025</span>
</span>
</aside>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../../game/multiplayer-settings/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Multiplayer Settings">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Multiplayer Settings
</div>
</div>
</a>
<a href="../port-forwarding/" class="md-footer__link md-footer__link--next" aria-label="Next: Port Forwarding">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Port Forwarding
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2019 - 2024 BeamMP Mod Team
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/beammp" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
<a href="https://twitter.com/beamng_mp" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"/></svg>
</a>
<a href="https://discord.gg/beammp" target="_blank" rel="noopener" title="discord.gg" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485 485 0 0 0 404.081 32.03a1.82 1.82 0 0 0-1.923.91 338 338 0 0 0-14.9 30.6 447.9 447.9 0 0 0-134.426 0 310 310 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.7 483.7 0 0 0-119.688 37.107 1.7 1.7 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.02 2.02 0 0 0 .765 1.375 487.7 487.7 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348 348 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321 321 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251 251 0 0 0 9.109-7.137 1.82 1.82 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.81 1.81 0 0 1 1.924.233 235 235 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.4 301.4 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391 391 0 0 0 30.014 48.815 1.86 1.86 0 0 0 2.063.7A486 486 0 0 0 610.7 405.729a1.88 1.88 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541M222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241m195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<div class="md-consent" data-md-component="consent" id="__consent" hidden>
<div class="md-consent__overlay"></div>
<aside class="md-consent__inner">
<form class="md-consent__form md-grid md-typeset" name="consent">
<h4>Cookie consent</h4>
<p>We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.</p>
<input class="md-toggle" type="checkbox" id="__settings" >
<div class="md-consent__settings">
<ul class="task-list">
<li class="task-list-item">
<label class="task-list-control">
<input type="checkbox" name="analytics" checked>
<span class="task-list-indicator"></span>
Google Analytics
</label>
</li>
<li class="task-list-item">
<label class="task-list-control">
<input type="checkbox" name="github" checked>
<span class="task-list-indicator"></span>
GitHub
</label>
</li>
</ul>
</div>
<div class="md-consent__controls">
<button class="md-button md-button--primary">Accept</button>
<label class="md-button" for="__settings">Manage settings</label>
</div>
</form>
</aside>
</div>
<script>var consent=__md_get("__consent");if(consent)for(var input of document.forms.consent.elements)input.name&&(input.checked=consent[input.name]||!1);else"file:"!==location.protocol&&setTimeout((function(){document.querySelector("[data-md-component=consent]").hidden=!1}),250);var form=document.forms.consent;for(var action of["submit","reset"])form.addEventListener(action,(function(e){if(e.preventDefault(),"reset"===e.type)for(var n of document.forms.consent.elements)n.name&&(n.checked=!1);__md_set("__consent",Object.fromEntries(Array.from(new FormData(form).keys()).map((function(e){return[e,!0]})))),location.hash="",location.reload()}))</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["search.suggest", "search.highlight", "search.share", "content.code.annotate", "content.code.copy", "content.action.edit", "content.action.view", "content.tooltips", "navigation.footer", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.path", "navigation.tracking", "navigation.indexes", "toc.follow"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.13a4f30d.min.js"></script>
<script src="../../javascript/custom.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink