Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates, delete unused scripts #2210

Merged
merged 3 commits into from
Feb 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions DMCompiler/copy_standard.bat

This file was deleted.

19 changes: 0 additions & 19 deletions DMCompiler/copy_standard.sh

This file was deleted.

16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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.
Expand All @@ -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/
Loading