I kind of forgot about this being in the unreleased death pit so there may be some inaccurate / missing information, if there's anything missing that stopped you from having the tools / local server work you can go ahead and ask it in the monkestation discord and perhaps also ask stuff to be added here
This is not to be mistaken with the guide to coding page (not yet done). this is for steps to install git tools, coding tools, explaining full functionality of the tools and troubleshooting issues that come from all of those. guide to coding is more on how to.. code
Also, this is a guide for windows, linux may require more / less steps.
This can also be used as a guide on getting a local server up if you want to
Instructions on how download then set up coding tools and the codebase, to compile the server just run BUILD.cmd in the root folder of the monkestation folder after all of these steps are done, or compile in VScode by clicking ctrl+F5 at once
| Step | Description |
|---|---|
| 1 | Install Visual Studio code Then install the required extensions (goonstation-extpack) if you would like the recommended extenstions of ss13 that are not needed to run but can be helpfull: (vscode-zipfs + esbenp.prettier-vscode) these are the words you need to input in the extension search bar (extenstion tab left of your vs code) |
| 2 | Install Git You can leave everthing default outside of when you get an option to select your default git editor, choose whatever you want to use in this one. if you get an error during this please visit the troubleshooting section |
| 3 | If you don't have a github account made already, please make one. Fork the Monkestation2.0 repository by clicking the fork button on the website while logged in |
| 4 | Get your clone url by visiting your forked repository website again, clicking the green code dropdown menu and copying the https clone url it gives you. Please keep that in your clipboard for the Git integration steps down there for whatever you use |
| 5 | Open git bash and enter * git config --global user.name "<YOUR NAME>" * git config --global user.email "<WHATEVER>"the both are required to be set for you to be able to interact with git, for the email you can use your github private email |
| Step | Description |
|---|---|
| 6 | Open the folder you want to clone the monkestation repo in with VScode (File in the top left and click 'open folder'). |
| 7 | Go to the source control tab of your VScode and initialize the folder |
| 8 | You should have all the simple stuff done now as vscode should have done the rest of making diffrent branches and remotes for you, for more information go to the VScode section |
| Step | Description |
|---|---|
| 6 | Install Github Desktop, follow the installation process |
Try to follow
I don't use github desktop so can't really say anything myself so just when you run into an issue: go ahead and ask in discord coder-think-that in the monkestation discord for help!
for installing the codebase for any other git client that is not listed here you can follow the main steps and try to look for options that are listed in the vscode section in the client then follow em
if you had a problem with something related to git or coding tools and have problems that are not on this table ask on our discord in the coder-think-thank channel. if you encountered an error and fixed it that is not in here and you want it to be here you can go say it in the monke-wiki channel so it gets added
| Platform | Issue | Fix |
|---|---|---|
| VScode | Too many tracked changes | Restart visual studio code |
| Git Git Bash VScode |
Could not find [INSERT HERE] in kernel |
Update windows, if that doesn't work then check for system corruptions (open normal cmd as an administrator and type in sfc /scannow) |
| BUILD.cmd VScode build |
Using vendored Node Access is denied. Access is denied | Run the file as an administrator, if that doesn't work then restart your computer and try again |
| VScode | Variable${workspacefolder} can not be resolved. Please open a folder | Update your VScode. if that no work then go to our discord, the link is on the start of this section. |
| Step | Dream deamon (comes with byond) | VSCode |
|---|---|---|
Build the code via running BUILD.cmd in the root of the code |
Hit the ctrl + f5 keybind in the project, it should build and run dreammaker afterwards. if that doesn't work or you require more advanced options hit f5 to just build |
|
If running BUILD.cmd succeeded, run Dream Dreamon, this should come installed with each byond installation. after running look for the file input box and navigate to the root of your project then again look for the tgstation.dmb file which should have been created after running BUILD.cmd. After selecting the proper file go ahead and hit the green arrow button which should be on the right of other buttons aaanddd after its done with everthing just click the weird yellow escape door button which should replace the green arrow now. |
if the first step didn't fully work but f5 did: go into the debug & run section of vscode which should be at the left then select your preferred running option. - Opendream is experimental and functions of the normal game may lack and or crashed may happen since its built on another engine, although it should run still. - Dreamdreamon well, fully works. - The low memory mode makes you load into runtime station, a minimalistic station which is used for debugging. |
Commands you can use in git bash, those are adjusted for ss13 and no other use. if you would like full functionality please visit https://git-scm.com/docs
Commands that require you to input something will have the required input be enclosed in < and >
| Name | Command | Functionality |
|---|---|---|
| Init | git init |
Create an empty Git repository or reinitialize an existing one |
| Clone | git clone <https clone url> |
Clones a repository into a newly created directory, creates remote-tracking branches for each branch in the cloned repository, and creates and checks out an initial branch that is forked from the cloned repository’s currently active branch. |
| Add | git init -add <FILE>.<EXTENSION> |
updates the index using the current content found in the working tree, to prepare the content staged for the next commit. It typically adds the current content of existing paths as a whole, but with some options it can also be used to add content with only part of the changes made to the working tree files applied, or remove paths that do not exist in the working tree anymore. |
| Status | git status |
shows the differences between the index and head commit. if added -b also displays the current branch that you are in |
| Diff | git diff [<commit>] [--] [<path>] |
Shows the changes between a commit and a path (not really usefull since github does that for you later on) |
| Commit | git commit -m "<COMMIT NAME HERE>"; git push -u upstream master -f |
uhh... commits the changes you have added in git add to a remote and its respective branch |
| Branch | git branch <branchname> |
Adds (?), deletes (--delete) or views |
| Name | Info | Shortcut |
|---|---|---|
| Building | Compiling the project, usefull for testing your code | F5 / ctrl + F5 |
| Running Server | Running the current code, quite usefull |
you can find some git commands in the remote (?) tab on the left of VSCode if you created a git init folder (its hidden, created from the git init command, it also lets you do that from the menu). do make sure you have git installed for this to work
for more commands click the three dots and select what you need! for information on what the buttons are scroll a section up