---
# System prepended metadata

title: Requirements
tags: [Guide To Contibuting]

---

###### tags: `Guide To Contibuting`

# Requirements

- BYOND - Development Kit/Engine
- Visual Studio Code - Code editor
- Git - Source control
- A bit of free disk space

## BYOND

Contains the compiler and the means to play and test the game. If you are here, you likely have this, because how else would you play on the server? If not, you can get it from <https://secure.byond.com/download>.

### Dream Seeker

Client application. Usually automatically launched when joining the server. Included in BYOND.

- Command line for test client-server: `dreamseeker.exe -trusted tgstation.dmb`

### Dream Maker

Development IDE, included with BYOND. Pretty terrible compared to Visual Studio Code, but works, and has built in map and sprite editing tools unlike VSC. Included in BYOND.

- Even if you're a VSC user, like it or not, until we get an external DMI editor you will have to touch this once or twice, occasionally.
- **PLEASE USE VISUAL STUDIO CODE.** It may be daunting at first but trust us, **IT WILL SAVE YOU UNIMAGINABLE AMOUNTS OF TIME.**

### Dream Daemon

Server application. Use this to launch test servers outside of Visual Studio Code. Included in BYOND.

## Visual Studio Code)

This is a free, lightweight open source code editor. GET IT. IT WILL MAKE YOUR LIFE AS A CODER EASIER. Download it at <https://code.visualstudio.com/download>.

- I personally still sometimes use Dream Maker depending on the situation but there is almost no situation where you cannot use VSC for coding
- When you open up the repo, install the recommended plugins:
- ![](https://i.imgur.com/WkZUlFZ.png)
- ![](https://i.imgur.com/rETnNmS.png)
- ![](https://i.imgur.com/6fF4l50.png)
- ![](https://i.imgur.com/l5hi6KA.png)
- ![](https://i.imgur.com/ijfW04a.png)

## Git

This is our source control system. You'll need this to submit your code to the Citadel repository as well as keep your local fork up to date with us. Download it at <https://git-scm.com/download/win>.

Got it? The reason I'm telling you to install the command line first is because **the command line is powerful. We do not expect you to use the command line all the time, but it would be nice if you had it so if things break, we can fix it for you just by telling you what commands to run in the command line.**

Now, go install a good GUI client, because if you're a person who can use the command line well you probably are already too good at coding to need a guide :)

This thing's quite good these days. <https://desktop.github.com/> Use it, or another preferred client. We're not picky, although if you use a third-party client **we do not promise that we have the knowledge to help you.** Someone around the Discord probably will be able to, though, and if things truly break, we'll just give you command line instructions to run to fix it in like 5 minutes anyways.
