-
Notifications
You must be signed in to change notification settings - Fork 0
Settings
Welcome to the official settings documentation for NetBeams. This is fairly simple, this project supports most of the official settings options provided by the BeamMP mod, as well as providing a rich set of additional options for managing who can (or cannot) join your server!
| Option | Default | Description |
|---|---|---|
| Name | NetBeams Server | The name of the server. This is displayed on the server list and in the server browser., see the BeamMP Documentation for more information. |
| Description | N/A | A description of the server. This is displayed on the server list and in the server browser. |
| Tags | N/A | A comma-separated list of tags that are associated with the server. |
| Port | 30814 | The port that the server will listen on. |
| AuthKey | N/A | A key that is required to allow your server to be listed on the BeamMP server browser. Get on using the KeyMaster service. |
| Password | N/A | A password that is required to join your server. |
| MaxPlayers | 10 | The maximum number of players that can join your server. |
| MaxCars | 2 | The maximum number of cars permitted for each player. |
| LogChat | true | Whether or not chat messages should be logged in the server log file. |
| Debug | false | Whether or not debug messages should be logged in the server log file. Note: This option is overridden by the NetBeams.LogLevel setting. |
| Map | /levels/gridmap_V2/info.json | The map that the server will use. |
| Private | false | If this option is set to true, players will only be able to join the server if they know the IP address and port. We recommend using this option for testing purposes. |
| ResourceFolder | Resources | The folder that contains the server resources. This folder should contain a "Client" and "Server" folder, see the BeamMP mod for more information. |
Note: The following options have no effect in NetBeams but are documented as part of the original settings file
| Option | Default | Description |
|---|---|---|
| ImScaredOfUpdates | false | Not Supported in NetBeams |
| SendErrorsShowMessage | true | Not Supported in NetBeams |
| SendErrors | true | Not Supported in NetBeams |
| Option | Default | Description |
|---|---|---|
| MasterNode | localhost | The ip address of the master node. Localhost sets the server to act as a master node. |
| MasterPort | 30815 | The port to use when communicating with the master node. |
| LogLevel | info | The log level to use. |
| LogFile | N/A | The file to use for logging. |
| ModServer | N/A | Where to collect the mods from |
At this time, these options are all unsupported, as the server has not implemented them yet.
| Option | Default | Description |
|---|---|---|
| AllowGuests | true | Whether guests are allowed to join the server or not |
| AllowContentCreators | true | Whether content creators are allowed to join the server |
| AllowStaff | true | Whether BeamMP staff are allowed to join the server |
| MinimumAccountAge | N/A | The minimum age of an account to be able to join the server |
| MaxIdleTime | N/A | The maximum amount of time a player is allowed to be idle before being kicked |
| MaxOnlineTime | N/A | The maximum amount of time a player is allowed to be on the server before being kicked |
| DefaultKickDuration | N/A | The amount of time a player is prevented from joining the server after being kicked |
| AllowVPN | true | If VPN connections are allowed to join the server |
| AllowProxy | true | If proxy connections are allowed to join the server |
This document is still under construction, please be patient while we work on awesome things!
This project is in no way associated with the BeamNG.Drive game, or BeamMP mod. It is a standalone implementation of the multiplayer protocol provided by the BeamMP team, and as such any issues with servers running on NetBeams should be reported here, in the issues, anyone reaching out to the BeamMP team will be directed to this repository to report their problem.