diff --git a/getting-started/install.md b/getting-started/install.md index e8bc702..816abf3 100644 --- a/getting-started/install.md +++ b/getting-started/install.md @@ -1,23 +1,43 @@ --- -description: Learn how to install Buckshot++ +description: Learn how to install BuckshotPlusPlus --- # Install +Welcome to the [BuckshotPlusPlus ](https://bpplang.com/)installation guide. This document provides step-by-step instructions to set up [BuckshotplusPlus ](https://bpplang.com/)on your system. Whether you prefer using the latest binary or compiling from the source, we've got you covered. + ### Use latest binary -The simplest method to get started with Buckshot++, simply download the lastest binary on our GitHub repo or on the official website +For a quick and hassle-free installation, you can use the latest binary of [BuckshotPlusPlus](https://bpplang.com/). + +**Steps**: + +1. Navigate to the [official BuckshotPlusPlus GitHub repository](https://github.com/BuckshotPlusPlus/BuckshotPlusPlus) or the [official website](https://bpplang.com/). +2. Locate and download the latest binary suitable for your operating system. +3. Once downloaded, ensure the binary is executable (you might need to adjust permissions on certain operating systems). ### Compile from the source -If you want you can build your own binary for Buckshot++ using the official source code available on [our GitHub repo](https://github.com/BuckshotPlusPlus/BuckshotPlusPlus) +For those who prefer a hands-on approach or need a custom build, [BuckshotPlusPlus ](https://bpplang.com/)can be compiled directly from the source. +**Steps**: +1. Visit the [BuckshotPlusPlus GitHub repository](https://github.com/BuckshotPlusPlus/BuckshotPlusPlus) and clone or download the source code. +2. Navigate to the directory containing the source code. +3. Open visual studio and compile the project. -### Run your BuckShot++ server +### Run your BuckShotPlusPlus server -To run your bpp server you just have to run the BuckShotPlusPlus executable with your main.bpp file path as first argument. +After installation, you can run the [BuckshotplusPlus ](https://bpplang.com/)server using the compiled executable. + +**Steps**: + +1. Open a terminal or command prompt. +2. Navigate to the directory containing the BuckshotPlusPlus executable. +3. Run the following command: ```sh BuckShotPlusPlus.exe "path/to/your/main.bpp" ``` + +Replace `path/to/your/main.bpp` with the actual path to your primary [BuckshotPlusPlus ](https://bpplang.com/)file.