From 1d227ba27ef3e145d340b51a0b671f33e475a9b5 Mon Sep 17 00:00:00 2001 From: Evan Date: Sun, 2 Mar 2025 11:31:26 -0500 Subject: [PATCH 1/4] Major revamp of dev-server.rst grammar Updated spacing, flow, organization, grammar, and readability --- source/pages/Tutorial/dev-server.rst | 71 +++++++++++++++------------- 1 file changed, 38 insertions(+), 33 deletions(-) diff --git a/source/pages/Tutorial/dev-server.rst b/source/pages/Tutorial/dev-server.rst index 017aa2c..dd24fea 100644 --- a/source/pages/Tutorial/dev-server.rst +++ b/source/pages/Tutorial/dev-server.rst @@ -1,67 +1,72 @@ -Setting up a development game server -================================================ +Setting Up a Development Game Server +==================================== Requirements ------------------------ +------------ -* A C++17 or greater compiler (like Visual Studio or GCC) +* A C++17 or later compiler (e.g., Visual Studio or GCC) * CMake * vcpkg -* git -* A way to launch the game client (see below for the supported methods) +* Git +* A method to launch the game client (see supported methods below) -Cloning the repo ------------------------ +Cloning the Repository +---------------------- -Clone the server repository: - git clone --depth=1 https://github.com/decompfrontier/server +To clone the server repository, run the following command: -Setting up vcpkg -------------------------- + ``git clone --depth=1 https://github.com/decompfrontier/server`` -Clone the `vcpkg repository `_ and bootstrap vcpkg: - bootstrap-vcpkg -disableMetrics +Setting Up vcpkg +---------------- -.. admonition:: Windows-only extra steps +Clone the `vcpkg repository `_ and bootstrap vcpkg with metrics disabled: - You also need to open an elevated command prompt and type `vcpkg integrate install` in your - vcpkg directory. + ``bootstrap-vcpkg -disableMetrics`` -Setup an system or user environment variable called `VCPKG_ROOT` which points to your vcpkg installation directory. +.. admonition:: Windows-Only Extra Steps -Setting up the server ------------------------------ + On Windows, open an elevated Command Prompt and run the following command in your vcpkg directory: -Using cmake, select the preset `Development config for XXXXX (64-bit)` depending on your operative system. (or use cmake --preset debug-win64, debug-lnx64 or debug-osx64) + ``vcpkg integrate install`` -Configure and then generate the target project. +Next, set up a system or user environment variable named ``VCPKG_ROOT`` pointing to your vcpkg installation directory. -Once you build the project, you will have a binary called "gimuserverw", this binary is your -development start that you should run and debug to develop new functionalities. +Setting Up the Server +--------------------- -Download the assets `21900.zip `_ to your `server repository/deploy/system/game_server` (if the folder does not exist create it) +Using CMake, select the preset ``Development config for XXXXX (64-bit)`` based on your operating system. Alternatively, use one of these commands: -Extract `assets.zip` from the `21900.zip` like so: +- ``cmake --preset debug-win64`` (Windows) + +- ``cmake --preset debug-lnx64`` (Linux) + +- ``cmake --preset debug-osx64`` (macOS) + +Configure and generate the target project. After building, you’ll get a binary named ``gimuserverw``. This is your development server executable, which you can run and debug to implement new features. + +Download the assets from `21900.zip `_ and place them in the ``server repository/deploy/system/game_server`` directory. If this folder doesn’t exist, create it. + +Extract ``assets.zip`` from ``21900.zip`` as shown below: .. image:: ../../images/archive_21900.png -Open `assets.zip` and inside, extract the two folders (`content` and `mst`) inside the `deploy/game_content`: +Open ``assets.zip`` and extract the ``content`` and ``mst`` folders into ``deploy/game_content``: .. image:: ../../images/assets_zip.png -You should have two folders called `content` and `mst` inside the `game_content` folder, like so: +After extraction, you should have two folders, ``content`` and ``mst``, inside ``game_content``: .. image:: ../../images/servercontent_root.png -The content of the `content` folder should contain the following assets: +The ``content`` folder should contain the following assets: .. image:: ../../images/servercontent_content.png -The content of the `mst` folder should contain the following assets: +The ``mst`` folder should contain these assets: .. image:: ../../images/servercontent_mst.png -You can modify the server configuration by editing the JSON files contained inside the `system` directory, -you can also setup extra settings inside the `gimuconfig.json` and adjust Drogon-specific settings inside the `config.json`. +To modify the server configuration, edit the JSON files in the ``system`` directory. You can also adjust additional settings in ``gimuconfig.json`` and tweak Drogon-specific options in ``config.json``. -You should now have an environment ready to begin developing the Brave Frontier emulator. +Your environment is now ready for developing the Brave Frontier emulator! From 683c592b31d045c19c2f01c2fd511a95e9024da6 Mon Sep 17 00:00:00 2001 From: Evan Date: Sun, 2 Mar 2025 20:50:41 -0500 Subject: [PATCH 2/4] Major Update to dev-server.rst The tutorial can finally get a complete noob Dev from beginning to end with little extra research or hidden steps. Good lord this took me over 2 hours to pull together, but I quality controlled it as I went along to ensure what I wrote actually happens. By the end I had a functional server. Tomorrow I'll do the client one. I'm going to bed now... lol --- source/pages/Tutorial/dev-server.rst | 180 ++++++++++++++++++++++----- 1 file changed, 146 insertions(+), 34 deletions(-) diff --git a/source/pages/Tutorial/dev-server.rst b/source/pages/Tutorial/dev-server.rst index dd24fea..63402a4 100644 --- a/source/pages/Tutorial/dev-server.rst +++ b/source/pages/Tutorial/dev-server.rst @@ -1,41 +1,114 @@ Setting Up a Development Game Server -==================================== +====================================== -Requirements ------------- +This guide walks you through the chronological steps to set up a development environment for the Brave Frontier emulator server, ensuring all prerequisites are met and potential issues are avoided from the start. -* A C++17 or later compiler (e.g., Visual Studio or GCC) -* CMake -* vcpkg -* Git -* A method to launch the game client (see supported methods below) +Installing Visual Studio 2022 Community with C++ for Developers +----------------------------------------------------------------- -Cloning the Repository ----------------------- +Before cloning the server repository or setting up dependencies, install Visual Studio 2022 Community with the necessary C++ development tools to prevent common build errors, such as the ``missing `rc.exe``` issue. -To clone the server repository, run the following command: +**Steps**: - ``git clone --depth=1 https://github.com/decompfrontier/server`` +1. Download and install Visual Studio 2022 Community from `https://visualstudio.microsoft.com/downloads/`. (For best results, run the installer with Admin Privileges) + +2. During installation, select the following in the Visual Studio Installer: + + - **Workload**: "Desktop development with C++" (ensure this is checked). + + - **Individual Components** (under "Installation details"): + + - "Windows 10 SDK" (select the latest version, e.g., 10.0.22621.0). + + - "MSVC v143 - VS 2022 C++ x64/x86 build tools." (Usually selected by default) + + .. image:: ../../images/VisualStudio2022COptions.png + +3. Click "Install while downloading" or "Modify" to apply changes (approximately 10.7 GB of additional space may be required). + +.. note:: + To verify all files are installed correctly, you can modify your Visual Studio installation at any time using the Visual Studio Installer. Open the installer, select "Modify" for Visual Studio 2022 Community, and ensure the above components are checked. This step can help confirm the presence of critical tools like ``rc.exe``, which is necessary for building C++ projects. + +Cloning the Server Repository +------------------------------ + +Clone the server repository to begin working on the Brave Frontier emulator server. + +**Steps**: + +To clone the server repository, run the following command in a terminal (e.g., Git Bash, Command Prompt, or PowerShell): +:: + git clone --depth=1 https://github.com/decompfrontier/server + + +.. note:: + Ensure Git is installed on your system (a base installation is all you need). Setting Up vcpkg ---------------- -Clone the `vcpkg repository `_ and bootstrap vcpkg with metrics disabled: +Set up `vcpkg`, a C++ library manager, to handle dependencies for the server project. + +**Steps**: + +1. Clone the `vcpkg` repository and bootstrap it with metrics disabled: + + - In a terminal, run: + :: + git clone https://github.com/microsoft/vcpkg.git + cd vcpkg + .\bootstrap-vcpkg -disableMetrics (for Windows, PowerShell) + ./bootstrap-vcpkg.sh -disableMetrics (for Linux/macOS) - ``bootstrap-vcpkg -disableMetrics`` .. admonition:: Windows-Only Extra Steps - On Windows, open an elevated Command Prompt and run the following command in your vcpkg directory: + On Windows, open an elevated PowerShell (Run as Administrator) and run the following command in your `vcpkg` directory: + :: + .\vcpkg integrate install + + +2. Set up a system or user environment variable named ``VCPKG_ROOT`` pointing to your `vcpkg` installation directory: + + - In an admin PowerShell, run: + :: + $env:VCPKG_ROOT = "C:\Projects\vcpkg" + + + - Replace ``C:\Projects\vcpkg`` with the actual path to your `vcpkg` folder (e.g., ``A:\BF\vcpkg`` if that’s where it’s located). + + - Test that it worked: + :: + $env:VCPKG_ROOT + + Example Output: ``C:\Projects\vcpkg`` + - ``vcpkg integrate install`` +.. warning:: + This is a temporary path set in PowerShell. Keep the admin console open until the end of this tutorial, or set it permanently [not recommended] (see below for instructions on making it permanent via the GUI or PowerShell). -Next, set up a system or user environment variable named ``VCPKG_ROOT`` pointing to your vcpkg installation directory. +.. important:: + To make `VCPKG_ROOT` permanent: + - Open `sysdm.cpl` (via `Windows Key + R`), go to “Advanced” > “Environment Variables.” + - Under “User variables” (or “System variables” if needed), click “New”: -Setting Up the Server ---------------------- + - Variable name: ``VCPKG_ROOT`` -Using CMake, select the preset ``Development config for XXXXX (64-bit)`` based on your operating system. Alternatively, use one of these commands: + - Variable value: Your `vcpkg` path (e.g., ``C:\Projects\vcpkg``). + + - Alternatively, use PowerShell (user-level): + :: + [Environment]::SetEnvironmentVariable("VCPKG_ROOT", "C:\Projects\vcpkg", "User") + + +Building the Server Using CMake +------------------------------- + +Configure and build the server project using CMake with a preset for your operating system. + +**Steps**: + +Using CMake, select the preset ``Development config for XXXXX (64-bit)`` based on your operating system. Alternatively, use one of these commands in a terminal (e.g., Developer PowerShell for VS 2022 on Windows): - ``cmake --preset debug-win64`` (Windows) @@ -43,30 +116,69 @@ Using CMake, select the preset ``Development config for XXXXX (64-bit)`` based o - ``cmake --preset debug-osx64`` (macOS) -Configure and generate the target project. After building, you’ll get a binary named ``gimuserverw``. This is your development server executable, which you can run and debug to implement new features. +.. warning:: + If you encounter an error (e.g., "The C++ compiler is not able to compile a simple test program" or a missing `rc.exe` issue), you may be missing critical components in your Visual Studio installation. To resolve this, uninstall all Visual Studio components, then return to the "Installing Visual Studio 2022 Community with C++ for Developers" section and reinstall from scratch, ensuring all required workloads and components (e.g., Windows 10 SDK, MSVC v143) are selected. + + +Once built, you’ll find a binary named ``gimuserverw`` in the ``server\standalone_frontend`` folder. This is your development server executable, which you can run and debug to implement new features. + +.. hint:: + At this point, if there are no errors in the console, you are free to close the admin PowerShell (and remove VCPKG_ROOT from root) + +Double Click ``gimuserverw.vcxproj`` to open Visual Studio 2022 Community. + +In Visual Studio 2022 Community, right click ``gimuserverw`` in the Solution Explorer pane and select ``Set as Startup Project``. + + .. image:: ../../images/SettingUpTheServer1.png + +From here, select the ``Debug`` dropdown menu in the top ribbon. Select ``gimuserverw Debug Properties`` at the bottom of the dropdown. + + .. image:: ../../images/SettingUpTheServer2.png + +In this pop-up window, select ``Debugging`` under ``Configuration Properties``, Change ``Configuration:`` dropdown to ``All Configurations``, then change ``Working Directory`` to the ``server\deploy`` folder. Click ``OK`` to close this window, then click ``Apply`` and finally ``OK`` to return to Visual Studio 2022 Community. + + .. image:: ../../images/SettingUpTheServer3.png + + .. image:: ../../images/SettingUpTheServer4.png + +Final Stretch +------------- + +Complete the server setup by downloading and organizing assets. + +**Steps**: + +1. Download the assets from `21900.zip `_ and place them in the ``server\deploy\system\game_server`` directory. If this folder doesn’t exist, create it. + +2. Extract ``assets.zip`` from ``21900.zip`` as shown below: + + .. image:: ../../images/archive_21900.png -Download the assets from `21900.zip `_ and place them in the ``server repository/deploy/system/game_server`` directory. If this folder doesn’t exist, create it. +3. Open ``assets.zip`` and extract the ``content`` and ``mst`` folders into ``deploy/game_content``: -Extract ``assets.zip`` from ``21900.zip`` as shown below: + .. image:: ../../images/assets_zip.png -.. image:: ../../images/archive_21900.png + After extraction, you should have two folders, ``content`` and ``mst``, inside ``game_content``: -Open ``assets.zip`` and extract the ``content`` and ``mst`` folders into ``deploy/game_content``: + .. image:: ../../images/servercontent_root.png -.. image:: ../../images/assets_zip.png + The ``content`` folder should contain the following assets: -After extraction, you should have two folders, ``content`` and ``mst``, inside ``game_content``: + .. image:: ../../images/servercontent_content.png -.. image:: ../../images/servercontent_root.png + The ``mst`` folder should contain these assets: -The ``content`` folder should contain the following assets: + .. image:: ../../images/servercontent_mst.png -.. image:: ../../images/servercontent_content.png +4. Modify the server configuration by editing the JSON files in the ``system`` directory. You can also adjust additional settings in ``gimuconfig.json`` and tweak Drogon-specific options in ``config.json``. -The ``mst`` folder should contain these assets: +Your environment is now fully set up and ready for developing the Brave Frontier emulator. You can run the server by clicking the ``Green Filled-in Play Button`` at the top of Visual Studio 2022 Community. -.. image:: ../../images/servercontent_mst.png +What's next? +-------------- -To modify the server configuration, edit the JSON files in the ``system`` directory. You can also adjust additional settings in ``gimuconfig.json`` and tweak Drogon-specific options in ``config.json``. +.. important:: + Now that you are done with the server set-up, please make your way over to game client set-up for installation steps. -Your environment is now ready for developing the Brave Frontier emulator! +.. note:: + If you encountered an error in set-up or a bug is preventing you from progressing in one of these tutorials, please create an ``Issue`` on the main repo. Thanks for your interest in our project! From b7d3bf27ae71da021a7370a2a3a2a311444b1629 Mon Sep 17 00:00:00 2001 From: Evan Date: Mon, 3 Mar 2025 10:35:48 -0500 Subject: [PATCH 3/4] Update dev-server.rst for Sphinx Compat Compatibility update for Sphinx and replaced the temporary vcpkg_root variable with a permanent version for later tutorials. --- source/pages/Tutorial/dev-server.rst | 93 ++++++++++++++-------------- 1 file changed, 45 insertions(+), 48 deletions(-) diff --git a/source/pages/Tutorial/dev-server.rst b/source/pages/Tutorial/dev-server.rst index 63402a4..db8a31f 100644 --- a/source/pages/Tutorial/dev-server.rst +++ b/source/pages/Tutorial/dev-server.rst @@ -4,9 +4,9 @@ Setting Up a Development Game Server This guide walks you through the chronological steps to set up a development environment for the Brave Frontier emulator server, ensuring all prerequisites are met and potential issues are avoided from the start. Installing Visual Studio 2022 Community with C++ for Developers ------------------------------------------------------------------ +---------------------------------------------------------------- -Before cloning the server repository or setting up dependencies, install Visual Studio 2022 Community with the necessary C++ development tools to prevent common build errors, such as the ``missing `rc.exe``` issue. +Before cloning the server repository or setting up dependencies, install Visual Studio 2022 Community with the necessary C++ development tools to prevent common build errors, such as the ``missing rc.exe`` issue. **Steps**: @@ -15,11 +15,9 @@ Before cloning the server repository or setting up dependencies, install Visual 2. During installation, select the following in the Visual Studio Installer: - **Workload**: "Desktop development with C++" (ensure this is checked). - - **Individual Components** (under "Installation details"): - "Windows 10 SDK" (select the latest version, e.g., 10.0.22621.0). - - "MSVC v143 - VS 2022 C++ x64/x86 build tools." (Usually selected by default) .. image:: ../../images/VisualStudio2022COptions.png @@ -27,7 +25,7 @@ Before cloning the server repository or setting up dependencies, install Visual 3. Click "Install while downloading" or "Modify" to apply changes (approximately 10.7 GB of additional space may be required). .. note:: - To verify all files are installed correctly, you can modify your Visual Studio installation at any time using the Visual Studio Installer. Open the installer, select "Modify" for Visual Studio 2022 Community, and ensure the above components are checked. This step can help confirm the presence of critical tools like ``rc.exe``, which is necessary for building C++ projects. + To verify all files are installed correctly, you can modify your Visual Studio installation at any time using the Visual Studio Installer. Open the installer, select "Modify" for Visual Studio 2022 Community, and ensure the above components are checked. This step can help confirm the presence of critical tools like ``rc.exe``, which is necessary for building C++ projects. Cloning the Server Repository ------------------------------ @@ -37,15 +35,16 @@ Clone the server repository to begin working on the Brave Frontier emulator serv **Steps**: To clone the server repository, run the following command in a terminal (e.g., Git Bash, Command Prompt, or PowerShell): + :: - git clone --depth=1 https://github.com/decompfrontier/server + git clone --depth=1 https://github.com/decompfrontier/server .. note:: - Ensure Git is installed on your system (a base installation is all you need). + Ensure Git is installed on your system (a base installation is all you need). Setting Up vcpkg ----------------- +----------------- Set up `vcpkg`, a C++ library manager, to handle dependencies for the server project. @@ -54,55 +53,56 @@ Set up `vcpkg`, a C++ library manager, to handle dependencies for the server pro 1. Clone the `vcpkg` repository and bootstrap it with metrics disabled: - In a terminal, run: + :: - git clone https://github.com/microsoft/vcpkg.git - cd vcpkg - .\bootstrap-vcpkg -disableMetrics (for Windows, PowerShell) - ./bootstrap-vcpkg.sh -disableMetrics (for Linux/macOS) + git clone https://github.com/microsoft/vcpkg.git + cd vcpkg + .\bootstrap-vcpkg -disableMetrics (for Windows, PowerShell) + ./bootstrap-vcpkg.sh -disableMetrics (for Linux/macOS) .. admonition:: Windows-Only Extra Steps - On Windows, open an elevated PowerShell (Run as Administrator) and run the following command in your `vcpkg` directory: - :: - .\vcpkg integrate install + On Windows, open an elevated PowerShell (Run as Administrator) and run the following command in your `vcpkg` directory: + + :: + .\vcpkg integrate install -2. Set up a system or user environment variable named ``VCPKG_ROOT`` pointing to your `vcpkg` installation directory: +2. Set up a permanent environment variable named ``VCPKG_ROOT`` pointing to your `vcpkg` installation directory. Choose one of the following methods based on your preference: + + - **User-Level (Recommended)**: Sets the variable for your user account only. In a PowerShell terminal, run: - - In an admin PowerShell, run: :: - $env:VCPKG_ROOT = "C:\Projects\vcpkg" + [Environment]::SetEnvironmentVariable("VCPKG_ROOT", "C:\Projects\vcpkg", "User") - - Replace ``C:\Projects\vcpkg`` with the actual path to your `vcpkg` folder (e.g., ``A:\BF\vcpkg`` if that’s where it’s located). + - **System-Level (Admin Required)**: Sets the variable for all users on the system. In an elevated PowerShell (Run as Administrator), run: - - Test that it worked: :: - $env:VCPKG_ROOT - - Example Output: ``C:\Projects\vcpkg`` + [Environment]::SetEnvironmentVariable("VCPKG_ROOT", "C:\Projects\vcpkg", "Machine") -.. warning:: - This is a temporary path set in PowerShell. Keep the admin console open until the end of this tutorial, or set it permanently [not recommended] (see below for instructions on making it permanent via the GUI or PowerShell). + - Replace ``C:\Projects\vcpkg`` with the actual path to your `vcpkg` folder (e.g., ``A:\BF\vcpkg`` if that’s where it’s located). + - To verify it worked, restart your terminal and run: -.. important:: - To make `VCPKG_ROOT` permanent: - - Open `sysdm.cpl` (via `Windows Key + R`), go to “Advanced” > “Environment Variables.” - - Under “User variables” (or “System variables” if needed), click “New”: + :: - - Variable name: ``VCPKG_ROOT`` + $env:VCPKG_ROOT - - Variable value: Your `vcpkg` path (e.g., ``C:\Projects\vcpkg``). + Example Output: ``C:\Projects\vcpkg`` - - Alternatively, use PowerShell (user-level): - :: - [Environment]::SetEnvironmentVariable("VCPKG_ROOT", "C:\Projects\vcpkg", "User") + - Alternatively, set it via the GUI: + - Open `sysdm.cpl` (via `Windows Key + R`), go to “Advanced” > “Environment Variables.” + - Under “User variables” (for user-level) or “System variables” (for system-level, admin required), click “New”: + - Variable name: ``VCPKG_ROOT`` + - Variable value: Your `vcpkg` path (e.g., ``C:\Projects\vcpkg``). +.. important:: + Setting ``VCPKG_ROOT`` permanently is required for this and subsequent tutorials. Ensure you choose the method (user-level or system-level) that best suits your setup to avoid issues later. Building the Server Using CMake -------------------------------- +-------------------------------- Configure and build the server project using CMake with a preset for your operating system. @@ -111,38 +111,35 @@ Configure and build the server project using CMake with a preset for your operat Using CMake, select the preset ``Development config for XXXXX (64-bit)`` based on your operating system. Alternatively, use one of these commands in a terminal (e.g., Developer PowerShell for VS 2022 on Windows): - ``cmake --preset debug-win64`` (Windows) - - ``cmake --preset debug-lnx64`` (Linux) - - ``cmake --preset debug-osx64`` (macOS) .. warning:: - If you encounter an error (e.g., "The C++ compiler is not able to compile a simple test program" or a missing `rc.exe` issue), you may be missing critical components in your Visual Studio installation. To resolve this, uninstall all Visual Studio components, then return to the "Installing Visual Studio 2022 Community with C++ for Developers" section and reinstall from scratch, ensuring all required workloads and components (e.g., Windows 10 SDK, MSVC v143) are selected. - + If you encounter an error (e.g., "The C++ compiler is not able to compile a simple test program" or a missing `rc.exe` issue), you may be missing critical components in your Visual Studio installation. To resolve this, uninstall all Visual Studio components, then return to the "Installing Visual Studio 2022 Community with C++ for Developers" section and reinstall from scratch, ensuring all required workloads and components (e.g., Windows 10 SDK, MSVC v143) are selected. Once built, you’ll find a binary named ``gimuserverw`` in the ``server\standalone_frontend`` folder. This is your development server executable, which you can run and debug to implement new features. .. hint:: - At this point, if there are no errors in the console, you are free to close the admin PowerShell (and remove VCPKG_ROOT from root) + At this point, if there are no errors in the console, you are free to close the admin PowerShell (and remove VCPKG_ROOT from root) Double Click ``gimuserverw.vcxproj`` to open Visual Studio 2022 Community. In Visual Studio 2022 Community, right click ``gimuserverw`` in the Solution Explorer pane and select ``Set as Startup Project``. - .. image:: ../../images/SettingUpTheServer1.png +.. image:: ../../images/SettingUpTheServer1.png From here, select the ``Debug`` dropdown menu in the top ribbon. Select ``gimuserverw Debug Properties`` at the bottom of the dropdown. - .. image:: ../../images/SettingUpTheServer2.png +.. image:: ../../images/SettingUpTheServer2.png In this pop-up window, select ``Debugging`` under ``Configuration Properties``, Change ``Configuration:`` dropdown to ``All Configurations``, then change ``Working Directory`` to the ``server\deploy`` folder. Click ``OK`` to close this window, then click ``Apply`` and finally ``OK`` to return to Visual Studio 2022 Community. - .. image:: ../../images/SettingUpTheServer3.png +.. image:: ../../images/SettingUpTheServer3.png - .. image:: ../../images/SettingUpTheServer4.png +.. image:: ../../images/SettingUpTheServer4.png Final Stretch -------------- +-------------- Complete the server setup by downloading and organizing assets. @@ -175,10 +172,10 @@ Complete the server setup by downloading and organizing assets. Your environment is now fully set up and ready for developing the Brave Frontier emulator. You can run the server by clicking the ``Green Filled-in Play Button`` at the top of Visual Studio 2022 Community. What's next? --------------- +------------- .. important:: - Now that you are done with the server set-up, please make your way over to game client set-up for installation steps. + Now that you are done with the server set-up, please make your way over to game client set-up for installation steps. .. note:: - If you encountered an error in set-up or a bug is preventing you from progressing in one of these tutorials, please create an ``Issue`` on the main repo. Thanks for your interest in our project! + If you encountered an error in set-up or a bug is preventing you from progressing in one of these tutorials, please create an ``Issue`` on the main repo. Thanks for your interest in our project! From c6c08c15e86367fff57fdc3a5c2bba57e5c88bb7 Mon Sep 17 00:00:00 2001 From: Evan Date: Thu, 6 Mar 2025 20:25:05 -0500 Subject: [PATCH 4/4] Update dev-server.rst Changed spacing to work for Sphinx --- source/pages/Tutorial/dev-server.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/pages/Tutorial/dev-server.rst b/source/pages/Tutorial/dev-server.rst index db8a31f..58540dd 100644 --- a/source/pages/Tutorial/dev-server.rst +++ b/source/pages/Tutorial/dev-server.rst @@ -93,8 +93,10 @@ Set up `vcpkg`, a C++ library manager, to handle dependencies for the server pro Example Output: ``C:\Projects\vcpkg`` - Alternatively, set it via the GUI: + - Open `sysdm.cpl` (via `Windows Key + R`), go to “Advanced” > “Environment Variables.” - Under “User variables” (for user-level) or “System variables” (for system-level, admin required), click “New”: + - Variable name: ``VCPKG_ROOT`` - Variable value: Your `vcpkg` path (e.g., ``C:\Projects\vcpkg``).