Build doc cleanup (#470)

# Description This pr streamlines the build process by removing the python3 dependency and pointing to the new build scripts.
Vault-Overseers · Jun 16, 2024 · 2c3496b · 2c3496b
1 parent ec6b1e0
commit 2c3496b
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 168 deletions.
diff --git a/BuildChecker/BuildChecker.csproj b/BuildChecker/BuildChecker.csproj
@@ -14,8 +14,6 @@ https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild
 -->
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
-    <Python>python3</Python>
-    <Python Condition="'$(OS)'=='Windows_NT' Or '$(OS)'=='Windows'">py -3</Python>
     <ProjectGuid>{C899FCA4-7037-4E49-ABC2-44DE72487110}</ProjectGuid>
     <TargetFrameworkMoniker>.NETFramework, Version=v4.7.2</TargetFrameworkMoniker>
     <RestorePackages>false</RestorePackages>
@@ -39,7 +37,7 @@ https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild
     <OutputPath>bin\DebugOpt\</OutputPath>
   </PropertyGroup>
   <Target Name="Build">
-    <Exec Command="$(Python) git_helper.py" CustomErrorRegularExpression="^Error" />
+    <Exec Command="git submodule update --init --recursive"/>
   </Target>
   <Target Name="Rebuild" DependsOnTargets="Build" />
   <Target Name="Clean">

diff --git a/BuildChecker/git_helper.py b/BuildChecker/git_helper.py
diff --git a/BuildChecker/hooks/post-checkout b/BuildChecker/hooks/post-checkout
diff --git a/BuildChecker/hooks/post-merge b/BuildChecker/hooks/post-merge
diff --git a/LEGAL.md b/LEGAL.md
@@ -6,9 +6,9 @@ The Authors retain all copyright to their respective work submitted here.
 
 ## Code license
 
-Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated. See [LICENSE-AGPLv3](https://github.com/Simple-Station/Einstein-Engines/blob/master/LICENSE-AGPLv3.txt).
+Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated. See [LICENSE-AGPLv3](./LICENSE-AGPLv3.txt).
 
-Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](https://github.com/Simple-Station/Einstein-Engines/blob/master/LICENSE-MIT.txt).
+Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 is licensed under the MIT license unless otherwise stated. See [LICENSE-MIT](./LICENSE-MIT.txt).
 
 [87c70a89a67d0521a56388e6b1c3f2cb947943e4](https://github.com/Simple-Station/Einstein-Engines/commit/87c70a89a67d0521a56388e6b1c3f2cb947943e4) was pushed on February 17th 2024 at 21:48 UTC
 

diff --git a/README.md b/README.md
@@ -41,27 +41,24 @@ We provide some scripts shown below to make the job easier.
 ### Build dependencies
 
 > - Git
-> - DOTNET SDK 7.0 or higher
-> - python 3.7 or higher
+> - .NET SDK 8.0.100
 
 
 ### Windows
 
 > 1. Clone this repository
-> 2. Run `RUN_THIS.py` to init submodules and download the engine, or run `git submodule update --init --recursive` in a terminal
-> 3. Run the `Scripts/bat/run1buildDebug.bat`
-> 4. Run the `Scripts/bat/run2configDev.bat` if you need other configurations run other config scripts
-> 5. Run both the `Scripts/bat/run3server.bat` and `Scripts/bat/run4client.bat`
-> 6. Connect to localhost and play
+> 2. Run `git submodule update --init --recursive` in a terminal to download the engine
+> 3. Run `Scripts/bat/buildAllDebug.bat` after making any changes to the source
+> 4. Run `Scripts/bat/runQuickAll.bat` to launch the client and the server
+> 5. Connect to localhost in the client and play
 
 ### Linux
 
 > 1. Clone this repository
-> 2. Run `RUN_THIS.py` to init submodules and download the engine, or run `git submodule update --init --recursive` in a terminal
-> 3. Run the `Scripts/sh/run1buildDebug.sh`
-> 4. Run the `Scripts/sh/run2configDev.sh` if you need other configurations run other config scripts
-> 5. Run both the `Scripts/sh/run3server.bat` and `scripts/sh/run4client.sh`
-> 6. Connect to localhost and play
+> 2. Run `git submodule update --init --recursive` in a terminal to download the engine
+> 3. Run `Scripts/bat/buildAllDebug.sh` after making any changes to the source
+> 4. Run `Scripts/bat/runQuickAll.sh` to launch the client and the server
+> 5. Connect to localhost in the client and play
 
 ### MacOS
 
@@ -70,12 +67,12 @@ We provide some scripts shown below to make the job easier.
 ## License
 
 Content contributed to this repository after commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 (`17 February 2024 23:00:00 UTC`) is licensed under the GNU Affero General Public License version 3.0 unless otherwise stated.
-See [LICENSE-AGPLv3](https://github.com/Simple-Station/Einstein-Engines/blob/master/LICENSE-AGPLv3.txt).
+See [LICENSE-AGPLv3](./LICENSE-AGPLv3.txt).
 
 Content contributed to this repository before commit 87c70a89a67d0521a56388e6b1c3f2cb947943e4 (`17 February 2024 23:00:00 UTC`) is licensed under the MIT license unless otherwise stated.
-See [LICENSE-MIT](https://github.com/Simple-Station/Einstein-Engines/blob/master/LICENSE-MIT.txt).
+See [LICENSE-MIT](./LICENSE-MIT.txt).
 
 Most assets are licensed under [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) unless stated otherwise. Assets have their license and the copyright in the metadata file.
-[Example](https://github.com/Simple-Station/Einstein-Engines/blob/master/Resources/Textures/Objects/Tools/crowbar.rsi/meta.json).
+[Example](./Resources/Textures/Objects/Tools/crowbar.rsi/meta.json).
 
 Note that some assets are licensed under the non-commercial [CC-BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/) or similar non-commercial licenses and will need to be removed if you wish to use this project commercially.
diff --git a/RUN_THIS.py b/RUN_THIS.py
diff --git a/Scripts/bat/buildAllDebug.bat b/Scripts/bat/buildAllDebug.bat
@@ -1,7 +1,6 @@
 @echo off
 cd ../../
 
-call python RUN_THIS.py
 call git submodule update --init --recursive
 call dotnet build -c Debug
 

diff --git a/Scripts/bat/buildAllRelease.bat b/Scripts/bat/buildAllRelease.bat
@@ -1,7 +1,6 @@
 @echo off
 cd ../../
 
-call python RUN_THIS.py
 call git submodule update --init --recursive
 call dotnet build -c Release
 

diff --git a/Scripts/bat/buildAllTools.bat b/Scripts/bat/buildAllTools.bat
@@ -1,7 +1,6 @@
 @echo off
 cd ../../
 
-call python RUN_THIS.py
 call git submodule update --init --recursive
 call dotnet build -c Tools
 

diff --git a/Scripts/sh/buildAllDebug.sh b/Scripts/sh/buildAllDebug.sh
@@ -7,6 +7,5 @@ fi
 
 cd ../../
 
-python RUN_THIS.py
 git submodule update --init --recursive
 dotnet build -c Debug
diff --git a/Scripts/sh/buildAllRelease.sh b/Scripts/sh/buildAllRelease.sh
@@ -7,6 +7,5 @@ fi
 
 cd ../../
 
-python RUN_THIS.py
 git submodule update --init --recursive
 dotnet build -c Release
diff --git a/Scripts/sh/buildAllTools.sh b/Scripts/sh/buildAllTools.sh
@@ -7,6 +7,5 @@ fi
 
 cd ../../
 
-python RUN_THIS.py
 git submodule update --init --recursive
 dotnet build -c Tools
diff --git a/shell.nix b/shell.nix
@@ -41,7 +41,6 @@ let
     dbus
     at-spi2-core
     cups
-    python3
   ];
 in pkgs.mkShell {
   name = "space-station-14-devshell";