mirrors/sociallydistant
1
0
Fork 0
mirror of https://gitlab.acidiclight.dev/sociallydistant/sociallydistant.git synced 2025-01-22 09:31:47 -05:00
Code Issues Projects Releases Packages Wiki Activity

Update README to document adding the custom NuGet source

Browse source 
Signed-off-by: Ritchie Frodomar <alkalinethunder@gmail.com>
This commit is contained in:
Ritchie Frodomar 2024-08-21 21:02:03 -04:00
parent 8d087e37af
commit 169a0a35d4
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -2,13 +2,21 @@
Socially Distant is an up-coming hacking game following the story of a global ransomware attack disrupting a society forced into cyberspace by the spread of a deadly biological threat to humanity.
## Ritchie's Toolbox
This game is made using Ritchie's Toolbox, a defacto custom game engine built on top of MonoGame. We do not directly use the MonoGame Content Pipeline, instead we use AutoPipeline and some custom MSBuild targets to build the game's content. Most of the time, you shouldn't notice - but if you are adding content to the game, you should never directly interact with or commit the `Content.mgcb` file as it'll be wiped and overwritten by AutoPipeline.
This game is made using Ritchie's Toolbox, a defacto custom game engine built on top of a fork of MonoGame. We do not directly use the MonoGame Content Pipeline, instead we use AutoPipeline and some custom MSBuild targets to build the game's content. Most of the time, you shouldn't notice - but if you are adding content to the game, you should never directly interact with or commit the `Content.mgcb` file as it'll be wiped and overwritten by AutoPipeline.
## Building from source
Building Socially Distant from source is moderately simple.
### Pre-requisites
On all platforms, you should have the .NET 8 SDK and Steam installed. You should also install the `dotnet-mgcb` .NET tool globally.
On all platforms, you should have the .NET 8 SDK and Steam installed.
You will need to add a NuGet package source for our MonoGame fork, otherwise `dotnet` will not download the correct version of MonoGame.
```bash
dotnet nuget add source monogame-socially-distant https://gitlab.acidiclight.dev/api/v4/projects/13/packages/nuget/index.json
```
You will need to add the source once for every device you build the game on. You can find the source code for our custom MonoGame fork over [on its GitLab group](https://gitlab.acidiclight.dev/monogame).
> :warning: **Shaders on non-Windows platforms**
>