Skip to content

Latest commit

 

History

History
33 lines (18 loc) · 1.61 KB

README.md

File metadata and controls

33 lines (18 loc) · 1.61 KB

OpenDream

OpenDream is a C# project that aims to compile games made in the DM language, and run them.

This project is currently in early stages, and is not feature-complete.

The compiler and server should work fine for Linux-based machines, but we currently rely on WPF and WebView2 for the client, so it's Windows-only.

For more information or if you'd like to contribute, join our Discord server.

A detailed description of differences with BYOND can be found here.

Building

OpenDream requires .NET 5. To build, one can use a C# compiler (such as MSBuild) to compile the various projects described in the solution.

There's 3 main parts: Compiler, Server, and Client

Running

Compiler: Run DMCompiler.exe, and pass any number of .dm or .dme files to compile as arguments.

Server: Run OpenDreamServer.exe and pass the compiled JSON file you got as a result of running the compiler above as the first argument.

Client: Run OpenDreamClient.exe. You will be prompted to choose a server address, port, and username. The defaults should work for a locally hosted server.

Screenshots

The following screenshots are taken from a stripped-down version of /tg/station available here.