shiftos-archive/ShiftOS_TheReturn
1
0
Fork 0
mirror of https://git.alee14.me/shiftos-archive/ShiftOS_TheReturn.git synced 2025-01-22 18:02:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
ShiftOS_TheReturn/README.md
Michael VanOverbeek b2e3a661ee Update the compile instructions
2017-07-27 21:48:09 -04:00

1.9 KiB
Raw Blame History

ShiftOS

Discord Build status

The official, open-source, C# revamp of ShiftOS.

License

We are licensed under the MIT license. A simple description is:

  1. Don't steal our code and claim ownership of it
  2. Leave copyright statements and license info at the top of all .cs files. InsertLicense.exe can be used to add the license to all files without it.

Using our code for your own project

You may use the ShiftOS.Engine, ShiftOS.Objects, and ShiftOS.Server projects to create your own games. You must include the original license and link back to ShiftOS in your README and in your game or credits.

Compiling the code

To compile the ShiftOS project, first, make sure you have Visual Studio Community installed (recommended version: 2015). Then, install MonoGame 3.6 from here. After installing these dependencies, open up ShiftOS_TheReturn.sln in Visual Studio.

Then, set the ShiftOS.Frontend project as your startup project, by right-clicking it in Solution Explorer and clicking "Set As StartUp Project". Then, fucking smash that F5 key and watch as ShiftOS comes to life.

Where the hell is the Issues tab? This can't be GitHub!

No, you're wrong. We've actually disabled the Issues tab in place of our own in-place bugtracker. Please post bugs there. It is easier for us to track and integrate with the rest of the community.

Contributing

See CONTRIBUTING.md

Mushroom

I'm a mushroom.