AmongUs/Impostor
1
0 Fork 0
mirror of https://github.com/Impostor/Impostor.git synced 2026-10-19 15:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] Update Building-from-source.md

Browse Source
This commit is contained in:
js6pak authored and GitHub committed 2021-03-03 09:05:33 +00:00
1 parent 87a062c1b3
commit d4bffd20ad
1 file changed
+8 -17
Download Patch File Download Diff File Expand all files Collapse all files
docs/Building-from-source.md
+8 -17
View File
@@ -1,29 +1,20 @@
# Building from source
The solution contains two main projects, the Impostor client and server. The client is built using [.NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework/net472) and the server with [.NET 5](https://dotnet.microsoft.com/download/dotnet/5.0).
Currently .NET 5 is not yet officially released, so in order to build using Visual Studio, you should have Visual Studio 2019 **Preview** installed.
This documentation will go over building both the [Server](#building-the-server) and the [Client](#building-the-client) and their requirements.
The solution contains two main projects, the Impostor server and patcher. The server is built using [.NET 5](https://dotnet.microsoft.com/download/dotnet/5.0) and the winforms patcher is with [.NET Framework 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework/net472).
## Cloning Impostor
You need to clone Impostor with all submodules.
You need to clone Impostor using git.
```bash
git clone --recursive https://github.com/AeonLucid/Impostor.git
```
If you already have cloned Impostor but have errors related to Hazel, run the following.
```bash
git submodule update --init
git clone https://github.com/AeonLucid/Impostor.git
```
## Building the server
### Dependencies
- [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0)
- [Visual Studio Preview](https://visualstudio.microsoft.com/vs/preview/) (Optional, only if you want the full IDE experience)
- [Rider](https://www.jetbrains.com/rider/) or [Visual Studio](https://visualstudio.microsoft.com/vs/) (Optional, only if you want the full IDE experience)
### Build using the CLI
@@ -33,13 +24,13 @@ dotnet build
```
To setup the server, please look at [Running the server](Running-the-server.md).
## Building the client
## Building the winforms patcher
### Dependencies
* [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer)
* [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer) or [Mono](https://www.mono-project.com/download/)
### Build using the CLI
```bash
cd src/Impostor.Client/Impostor.Client.WinForms
cd src/Impostor.Patcher/Impostor.Patcher.WinForms
dotnet build
```
```