From 128171b748742ab4e9f541e182cf24272c2daeb6 Mon Sep 17 00:00:00 2001 From: O1LER Date: Sun, 23 Jun 2024 21:05:00 +0200 Subject: [PATCH] Fix typos and small changes --- docs/en/guides/beammp-dev/beammp-dev.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/en/guides/beammp-dev/beammp-dev.md b/docs/en/guides/beammp-dev/beammp-dev.md index 79f7ea0d..37a91047 100644 --- a/docs/en/guides/beammp-dev/beammp-dev.md +++ b/docs/en/guides/beammp-dev/beammp-dev.md @@ -30,11 +30,12 @@ BeamMP is split into three main parts: ## Using an unpacked folder for BeamNG In order to efficiently work on mods in BeamNG, it is advised to use an `unpacked` folder, rather than packaging zips after every change. -Further information about the userfolder can be found at [https://documentation.beamng.com/support/userfolder/](https://documentation.beamng.com/support/userfolder/) Open up the BeamNG userfolder by navigating to `%appdata%/Local/BeamNG.drive/0.xx/mods` where `xx` is the most recent BeamNG version. Create a folder called `unpacked` inside the `mods` folder. +Further information about the userfolder can be found at [https://documentation.beamng.com/support/userfolder/](https://documentation.beamng.com/support/userfolder/) + ## Enabling dev mode in BeamMP By starting the launcher with the arguments ` 0 0` its development mode will be enabled. This will do two things, deactivate automatic mod updates and deactivate auto-starting BeamNG. @@ -44,21 +45,23 @@ Once dev mode was succesfully enabled, the launcher will stop with `[DEBUG] Core ## Cloning the BeamMP repo into the unpacked folder -While you can manually copy the BeamMP mod files, it is highly recommended to use a source-control system like git. +While you can manually copy the BeamMP mod files from our github repo, it is highly recommended to use a source-control system like git. First create a fork of [https://github.com/BeamMP/BeamMP](https://github.com/BeamMP/BeamMP) Most efficient would be to clone the repo directly into the `unpacked` folder. For `git`, do `git clone https://github.com/yourName/BeamMP` while in the `unpacked` folder -While in the uderfolder, make sure theres no `multiplayer` folder left in `mods` and that now theres `unpacked/beammp` +While in the userfolder, make sure theres no `multiplayer` folder left in `mods` and that now theres `unpacked/beammp` Now give the dev mode a try. Start the BeamMP launcher, start BeamNG manually, once ingame make sure that BeamMP is the only active mod. You should be able to use BeamMP as usual. +Using a code editor, you can now add or change code directly in the `unpacked` folder, try these changes with minimal effort and then sync them using the source control. + --- # Setting up a local server While working on BeamMP, it can be beneficial to use a local server. You can follow the general [server installation](docs/en/server/create-a-server.md) while omitting the first two steps for purely local connections. -Set the server to private in the `serverConfig.toml` while using any string as the `authKey` +Set the server to private in the `serverConfig.toml` while using any string as the `authKey`.