From 93ff3af3c776dcbba6309c5142017c8a49128884 Mon Sep 17 00:00:00 2001 From: "Mikhail G." Date: Thu, 13 Feb 2025 00:34:03 +0700 Subject: [PATCH] README updates, delete unused scripts (#2210) --- DMCompiler/copy_standard.bat | 5 ----- DMCompiler/copy_standard.sh | 19 ------------------- README.md | 16 ++++++++++------ 3 files changed, 10 insertions(+), 30 deletions(-) delete mode 100644 DMCompiler/copy_standard.bat delete mode 100755 DMCompiler/copy_standard.sh diff --git a/DMCompiler/copy_standard.bat b/DMCompiler/copy_standard.bat deleted file mode 100644 index d53a132c2d..0000000000 --- a/DMCompiler/copy_standard.bat +++ /dev/null @@ -1,5 +0,0 @@ -@echo off -if not exist bin\Debug\net8.0\DMStandard mkdir bin\Debug\net8.0\DMStandard -xcopy DMStandard bin\Debug\net8.0\DMStandard /y /s /e -if not exist bin\Release\net8.0\DMStandard mkdir bin\Release\net8.0\DMStandard -xcopy DMStandard bin\Release\net8.0\DMStandard /y /s /e diff --git a/DMCompiler/copy_standard.sh b/DMCompiler/copy_standard.sh deleted file mode 100755 index 3532579229..0000000000 --- a/DMCompiler/copy_standard.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/bin/sh -set -xe - -SCRIPT=$(readlink -f "$0") -SCRIPTPATH=$(dirname "$SCRIPT") - -if [ -d "$SCRIPTPATH/bin/Debug/net8.0/DMStandard" ]; then - cp -r $SCRIPTPATH/DMStandard $SCRIPTPATH/bin/Debug/net8.0/DMStandard -else - mkdir -p $SCRIPTPATH/bin/Debug/net8.0/DMStandard - cp -r $SCRIPTPATH/DMStandard $SCRIPTPATH/bin/Debug/net8.0/DMStandard -fi - -if [ -d "$SCRIPTPATH/bin/Release/net8.0/DMStandard" ]; then - cp -r $SCRIPTPATH/DMStandard $SCRIPTPATH/bin/Release/net8.0/DMStandard -else - mkdir -p $SCRIPTPATH/bin/Release/net8.0/DMStandard - cp -r $SCRIPTPATH/DMStandard $SCRIPTPATH/bin/Release/net8.0/DMStandard -fi diff --git a/README.md b/README.md index 147d077986..9f2154c342 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![OpenDream](.github/assets/OpenDream.png)](#) +[![OpenDream logo](.github/assets/OpenDream.png)](#) **OpenDream** is a C# project that aims to compile games made in the [DM language], and run them. @@ -13,6 +13,7 @@ A detailed description of differences with BYOND can be found [here](https://git ## Running ### Very Easy Mode + Install the OpenDream vscode extension from [the marketplace](https://marketplace.visualstudio.com/items?itemName=ss13.opendream). Open the folder containing your `.dme` file in vscode. Press the "Start debugging (F5)" button. The extension will automatically handle getting the latest OpenDream and SS14 Launcher binaries, compile and run everything for you. @@ -33,28 +34,31 @@ There's 3 main parts: Compiler, Server, and Client: ## Building -The first step to building OpenDream is initializing the submodule for the game engine, [Robust Toolbox](https://github.com/space-wizards/RobustToolbox). +The first step to building OpenDream is initializing the submodule for the game engine, [Robust Toolbox](https://github.com/space-wizards/RobustToolbox). To do this, simply run `git submodule update --init --recursive` in git bash and let it finish. -**OpenDream requires .NET 8.** You can check your version by running `dotnet --version`. It should be at least `8.0.0`. +**OpenDream requires .NET 9.** You can check your version by running `dotnet --version`. It should be at least `9.0.0`. To build, one can use a C# compiler (such as MSBuild) to compile the various projects described in the solution. To use the .NET build system, simply run `dotnet build -c Release` in the OpenDream directory. This will build all of the solutions in release mode and put the resultant binaries in `bin` ## Testing + OpenDream makes use of a unit testing framework. You can run these unit tests by running `dotnet test` in the OpenDream directory. This will run all of the RobustToolbox tests, as well as the DM language tests which can be found under `Content.Tests/DMProject/Tests/`. To add to the unit tests, simply create a `.dm` file under the Tests directory with `/proc/RunTest()` as the entry point. Optionally you can also add flags to the test, such as `// COMPILE ERROR` to mark that this test should cause a compile error. ## Requests for Comment + New features unrelated to BYOND parity go through an RFC process to solicit input from the wider community. The RFCs and more info on the RFC process can be found [here](https://github.com/OpenDreamProject/rfcs). ## Screenshots -![](./.github/assets/screenshot.png?raw=true) + +![/tg/station screenshot](./.github/assets/screenshot.png?raw=true) _[/tg/station](https://github.com/tgstation/tgstation)_ -![](./.github/assets/screenshot2.png?raw=true) +![Paradise screenshot](./.github/assets/screenshot2.png?raw=true) _Version of [Paradise with a 64-bit rustg DLL](https://github.com/ike709/Paradise/tree/rustg_64)_ -![](./.github/assets/screenshot3.png?raw=true) +![Goonstation screenshot](./.github/assets/screenshot3.png?raw=true) _[Goonstation](https://github.com/goonstation/goonstation)_ [DM Language]: http://secure.byond.com/