Add build instructions

Instructions from #866
This commit is contained in:
ORelio 2020-03-28 00:00:46 +01:00
parent 00112e4c6a
commit 90c6e776e1
2 changed files with 23 additions and 1 deletions

View file

@ -239,7 +239,7 @@ namespace MinecraftClient
/// Perform an internal MCC command (not a server command, use SendText() instead for that!) /// Perform an internal MCC command (not a server command, use SendText() instead for that!)
/// </summary> /// </summary>
/// <param name="command">The command to process</param> /// <param name="command">The command to process</param>
/// <param name="localVars">Local variables passed along with the script</param> /// <param name="localVars">Local variables passed along with the internal command</param>
/// <returns>TRUE if the command was indeed an internal MCC command</returns> /// <returns>TRUE if the command was indeed an internal MCC command</returns>
new public bool PerformInternalCommand(string command, Dictionary<string, object> localVars = null) new public bool PerformInternalCommand(string command, Dictionary<string, object> localVars = null)
{ {

View file

@ -20,6 +20,28 @@ This exe file is a .NET binary which also works on Mac and Linux.
Check out the [sample configuration files](MinecraftClient/config/) which includes the how-to-use README. Check out the [sample configuration files](MinecraftClient/config/) which includes the how-to-use README.
Help and more info is also available on the [Minecraft Forum thread](http://www.minecraftforum.net/topic/1314800-/).<br/> Help and more info is also available on the [Minecraft Forum thread](http://www.minecraftforum.net/topic/1314800-/).<br/>
## Building from source
First of all, get a [zip of source code](https://github.com/ORelio/Minecraft-Console-Client/archive/master.zip), extract it and navigate to the `MinecraftClient` folder.
Edit `MinecraftClient.csproj` to set the Build target to `Release` on [line 4](https://github.com/ORelio/Minecraft-Console-Client/blob/master/MinecraftClient/MinecraftClient.csproj#L4):
```xml
<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
```
### On Windows
1. Locate MSBuild.exe for .NET 4 inside `C:\Windows\Microsoft.NET\Framework\v4.X.XXXXX`
2. Drag and drop `MinecraftClient.csproj` over `MSBuild.exe` to launch the build
3. If the build succeededs, you can find `MinecraftClient.exe` under `MinecraftClient\bin\Release`
### On Mac and Linux
1. Install the [Mono Framework](https://www.mono-project.com/download/stable/#download-lin) if not already installed
2. Run `msbuild MinecraftClient.csproj` in a terminal
3. If the build succeededs, you can find `MinecraftClient.exe` under `MinecraftClient\bin\Release`
## How to contribute ## How to contribute
If you'd like to contribute to Minecraft Console Client, great, just fork the repository and submit a pull request. The *Indev* branch for contributions to future stable versions is no longer used as MCC is currently distributed as development builds only. If you'd like to contribute to Minecraft Console Client, great, just fork the repository and submit a pull request. The *Indev* branch for contributions to future stable versions is no longer used as MCC is currently distributed as development builds only.