Skip to content

Commit

Permalink
Build/Run Scripts from Parkstation (#6)
Browse files Browse the repository at this point in the history
# Description

Adds several scripts to make building and running the projects easier
outside of an IDE.
  • Loading branch information
DEATHB4DEFEAT authored May 18, 2024
1 parent 2539714 commit 790fe7d
Show file tree
Hide file tree
Showing 22 changed files with 208 additions and 13 deletions.
25 changes: 25 additions & 0 deletions Scripts/bat/!README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
buildAllDebug
Builds all projects with debug configuration
buildAllRelease
Builds all projects with release configuration
buildAllTools
Builds all projects with tools configuration

The debug vs release build is simply what people develop in vs the actual server.
The release build contains various optimizations, while the debug build contains debugging tools.
If you're mapping, use the release or tools build as it will run smoother with less crashes.


runQuickAll
Runs the client and server without building
runQuickClient
Runs the client without building
runQuickServer
Runs the server without building

runTests
Runs the unit tests, makes sure various C# systems work as intended
runTestsIntegration
Runs the integration tests, makes sure various C# systems work as intended
runTestsYAML
Runs the YAML linter and finds issues with the YAML files that you probably wouldn't otherwise
8 changes: 8 additions & 0 deletions Scripts/bat/buildAllDebug.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@echo off
cd ../../

call python RUN_THIS.py
call git submodule update --init --recursive
call dotnet build -c Debug

pause
8 changes: 8 additions & 0 deletions Scripts/bat/buildAllRelease.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@echo off
cd ../../

call python RUN_THIS.py
call git submodule update --init --recursive
call dotnet build -c Release

pause
8 changes: 8 additions & 0 deletions Scripts/bat/buildAllTools.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@echo off
cd ../../

call python RUN_THIS.py
call git submodule update --init --recursive
call dotnet build -c Tools

pause
6 changes: 6 additions & 0 deletions Scripts/bat/runQuickAll.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@echo off

start runQuickServer.bat %*
start runQuickClient.bat %*

exit
6 changes: 6 additions & 0 deletions Scripts/bat/runQuickClient.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@echo off
cd ../../

call dotnet run --project Content.Client --no-build %*

pause
6 changes: 6 additions & 0 deletions Scripts/bat/runQuickServer.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@echo off
cd ../../

call dotnet run --project Content.Server --no-build %*

pause
8 changes: 8 additions & 0 deletions Scripts/bat/runTests.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cd ..\..\

mkdir Scripts\logs

del Scripts\logs\Content.Tests.log
dotnet test Content.Tests/Content.Tests.csproj -c DebugOpt -- NUnit.ConsoleOut=0 > Scripts\logs\Content.Tests.log

pause
8 changes: 8 additions & 0 deletions Scripts/bat/runTestsIntegration.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cd ..\..\

mkdir Scripts\logs

del Scripts\logs\Content.IntegrationTests.log
dotnet test Content.IntegrationTests/Content.IntegrationTests.csproj -c DebugOpt -- NUnit.ConsoleOut=0 NUnit.MapWarningTo=Failed > Scripts\logs\Content.IntegrationTests.log

pause
8 changes: 8 additions & 0 deletions Scripts/bat/runTestsYAML.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cd ..\..\

mkdir Scripts\logs

del Scripts\logs\Content.YAMLLinter.log
dotnet run --project Content.YAMLLinter/Content.YAMLLinter.csproj -c DebugOpt -- NUnit.ConsoleOut=0 > Scripts\logs\Content.YAMLLinter.log

pause
25 changes: 25 additions & 0 deletions Scripts/sh/!README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
buildAllDebug
Builds all projects with debug configuration
buildAllRelease
Builds all projects with release configuration
buildAllTools
Builds all projects with tools configuration

The debug vs release build is simply what people develop in vs the actual server.
The release build contains various optimizations, while the debug build contains debugging tools.
If you're mapping, use the release or tools build as it will run smoother with less crashes.


runQuickAll
Runs the client and server without building
runQuickClient
Runs the client without building
runQuickServer
Runs the server without building

runTests
Runs the unit tests, makes sure various C# systems work as intended
runTestsIntegration
Runs the integration tests, makes sure various C# systems work as intended
runTestsYAML
Runs the YAML linter and finds issues with the YAML files that you probably wouldn't otherwise
12 changes: 12 additions & 0 deletions Scripts/sh/buildAllDebug.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/env sh

# make sure to start from script dir
if [ "$(dirname $0)" != "." ]; then
cd "$(dirname $0)"
fi

cd ../../

python RUN_THIS.py
git submodule update --init --recursive
dotnet build -c Debug
12 changes: 12 additions & 0 deletions Scripts/sh/buildAllRelease.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/env sh

# make sure to start from script dir
if [ "$(dirname $0)" != "." ]; then
cd "$(dirname $0)"
fi

cd ../../

python RUN_THIS.py
git submodule update --init --recursive
dotnet build -c Release
12 changes: 12 additions & 0 deletions Scripts/sh/buildAllTools.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/env sh

# make sure to start from script dir
if [ "$(dirname $0)" != "." ]; then
cd "$(dirname $0)"
fi

cd ../../

python RUN_THIS.py
git submodule update --init --recursive
dotnet build -c Tools
11 changes: 11 additions & 0 deletions Scripts/sh/runQuickAll.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/usr/bin/env sh

# make sure to start from script dir
if [ "$(dirname $0)" != "." ]; then
cd "$(dirname $0)"
fi

sh -e runQuickServer.sh &
sh -e runQuickClient.sh

exit
9 changes: 9 additions & 0 deletions Scripts/sh/runQuickClient.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/usr/bin/env sh

# make sure to start from script dir
if [ "$(dirname $0)" != "." ]; then
cd "$(dirname $0)"
fi

cd ../../
dotnet run --project Content.Client --no-build
9 changes: 9 additions & 0 deletions Scripts/sh/runQuickServer.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/usr/bin/env sh

# make sure to start from script dir
if [ "$(dirname $0)" != "." ]; then
cd "$(dirname $0)"
fi

cd ../../
dotnet run --project Content.Server --no-build
9 changes: 9 additions & 0 deletions Scripts/sh/runTests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
cd ../../

mkdir Scripts/logs

rm Scripts/logs/Content.Tests.log
dotnet test Content.Tests/Content.Tests.csproj -c DebugOpt -- NUnit.ConsoleOut=0 > Scripts/logs/Content.Tests.log

echo "Tests complete. Press enter to continue."
read
9 changes: 9 additions & 0 deletions Scripts/sh/runTestsIntegration.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
cd ../../

mkdir Scripts/logs

rm Scripts/logs/Content.IntegrationTests.log
dotnet test Content.IntegrationTests/Content.IntegrationTests.csproj -c DebugOpt -- NUnit.ConsoleOut=0 NUnit.MapWarningTo=Failed > Scripts/logs/Content.IntegrationTests.log

echo "Tests complete. Press enter to continue."
read
9 changes: 9 additions & 0 deletions Scripts/sh/runTestsYAML.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
cd ../../

mkdir Scripts/logs

rm Scripts/logs/Content.YAMLLinter.log
dotnet run --project Content.YAMLLinter/Content.YAMLLinter.csproj -c DebugOpt -- NUnit.ConsoleOut=0 > Scripts/logs/Content.YAMLLinter.log

echo "Tests complete. Press enter to continue."
read
6 changes: 0 additions & 6 deletions runclient.bat

This file was deleted.

7 changes: 0 additions & 7 deletions runserver.bat

This file was deleted.

0 comments on commit 790fe7d

Please sign in to comment.