User:Jordie0608

From Yogstation-13
Revision as of 03:05, 18 March 2013 by imported>Jordie0608 (Created page for new source code guide. I don't really know GitHub, so help would be appreciated)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

WIP new guide to downloading source code from Github

This page contains the information and steps needed to download the latest version of the code, compile it and host your own server.

http://baystation12.net/wiki/index.php?title=Installing_TortoiseGit

Licensing

The TG Station 13 source code is open. The license allows you to do most things, but if you're really interested in more, see below.

NOTE! The actual license is located on our code page. (Is there a licence on GitHub?

The license that we use allows you:

  • to Share — to copy, distribute and transmit the work
  • to Remix — to adapt the work
  • to make commercial use of the work

Under the following conditions:

  • Attribution — You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).
  • Share Alike — If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.

Downloading

We use GitHub to host our project.

Follow the steps below to install Tortoise SVN

  • Go to [1]
  • Download the source code as a ZIP file, it is about 32MB
  • Do other stuff (windows github program or whatever)

Updating to the latest revision

Can this be done with github? Or do you just need to download all the files again?

"I did not change anything, but the code does not work anymore!"

This is likely due to corrupted files. To fix this, you need to:

  • Delete tgstation13.dme
  • Update
  • Clean-Compile

Hosting a server

To get a simple server running first

  • Download the source code as explained above
  • Open tgstation13.dme in dream maker (double click it)
  • Once it opens select Build > Compile
  • Wait until it compiles. Once it does a new file "tgstation13.dmb" will be created in the same folder where "tgstation13.dme" is. The dmb file has an orange icon. Compile time usually takes between 1 and 10 minutes, depending on your computer. Dream maker will show as 'not responding' during this time, but it is compiling.
  • Open dream daemon (Win7: start menu > all programs > BYOND > Dream Daemon; Win8: start > type Dream Daemon > Dream Daemon)
  • Select the "..." in the lower right corner and select the file "tgstation13.dmb".
  • Click the "GO" button and wait until it changes to a red "stop" button. Starting the server usually takes between 1 and 5 minutes. It is fully started once you can normally interact with Dream Daemon and a byond://xxx.xxx.xxx.xxx:xxxxx link is present at the bottom.
  • Click the yellow button (former "...") to auto-join
  • Left click the link (byond://xxx.xxx.xxx.xxx:xxxxx) to copy it to clipboard
  • Paste the link (ctrl+v) to your friends so they can join.

Making your server visible on byond.com

You DO NOT NEED to pay for membership to make your server visible on byond.com!

Follow this guide on the forums! Do your best to ignore the tasteless doodles.

Contribution guides
General Hosting a server, Setting up git, Guide to GitKraken, Downloading the source code, Guide to contributing to the game, Reporting issues, Game resources category, Guide to changelogs
Database (MySQL) Setting up the database, MySQL
Coding Understanding SS13 code, SS13 for experienced programmers, Text Formatting
Mapping Guide to mapping, Room Structure, Map merger
Spriting Guide to spriting
Wiki Guide to contributing to the wiki, Wikicode, Styleguide