|
|
@@ -26,15 +26,17 @@ Unlike upstream, this repo has a complete build system that harnesses the power
|
|
|
- **If you are building on Mac OS:** Make sure you have Xcode CLI Tools installed (XCode might also be required).
|
|
|
- **If you are building on Linux:** Make sure you have your repositories' `build-essential` and `cmake` package installed. On Debian and Ubuntu-based distros, you can do `sudo apt -y build-essential cmake` to install the required things.
|
|
|
- **If you are building for Android:** Easiest way is to go into `Sources/Native` and run when `ndk-build`. A fresh batch of ENET DLLs should then be spat out.
|
|
|
-- **If you are building for iOS:** You can use the toolchain definition included under the mobile folder of this repository. Some manual compiling is required - an automated batch script will be provided later.
|
|
|
+- **If you are building for iOS:** Using **Terminal.app** on your MacOS device, navigate to the `Build-iOS` directory and run the command file found inside. You might need to make it executable, however. It will try to auto-pilot a build for you, just make sure you have CMake installed for MacOS and a recent Xcode installation. Library code signing will be disabled for the build.
|
|
|
- **If you are building for Consoles:** Unfortunately, I don't have any instructions here. Please let me know how you go and I'll add some here.
|
|
|
+
|
|
|
+#### Recipe for victory
|
|
|
- Clone a fresh copy of this Git Repo somewhere on your workstation's filesystem.
|
|
|
- Open a command prompt/terminal and change directory into the newly cloned git repository.
|
|
|
-- Run `dotnet build`. **Protip:** You can append `-c Release` or `-c Debug` to your `dotnet build` command to build a release binary or a debug binary of ENET's C library.
|
|
|
+- Run `dotnet build`. **Protip:** You can append `-c Release` or `-c Debug` to your `dotnet build` command to build a release binary or a debug binary of ENET's C library. At the moment, the default build is a Debug build.
|
|
|
|
|
|
You will see an anime babe appear followed by [Ignorance](https://github.com/SoftwareGuy/Ignorance) ASCII art.
|
|
|
|
|
|
-CMake will fire up, configure itself after inspecting your build environment and hopefully spit out a binary blob inside a `Unity/Plugins` directory. On Windows, this will be a DLL, on Mac it will be a `.bundle` file and on Linux it will be a shared object (`.so`). This can be used with Unity or another thing like a C# NET Core application or even other C/C++ apps.
|
|
|
+CMake will fire up, configure itself after inspecting your build environment and hopefully spit out a binary blob inside a `Unity/Plugins` directory. On Windows, this will be a DLL, on Mac it will be a `.bundle` file and on Linux it will be a shared object (`.so`). This can be used with Unity or other applications like a C# NET Core application or C/C++ app.
|
|
|
|
|
|
#### Testing
|
|
|
- `dotnet test` will run some sanity checks and make sure ENET initializes, data is received and sent correctly, etc.
|
|
|
@@ -42,7 +44,7 @@ CMake will fire up, configure itself after inspecting your build environment and
|
|
|
#### Rebuilding
|
|
|
Inside the directory that you cloned the repo to, run:
|
|
|
- `dotnet clean`
|
|
|
-- `dotnet build`
|
|
|
+- `dotnet build` (don't forget about the `-c Release/Debug` argument as mentioned earlier!)
|
|
|
|
|
|
It is recommended to clean the repository work space before building.
|
|
|
|
|
|
@@ -103,7 +105,5 @@ Credits
|
|
|
- Mirror Team & Discord Members
|
|
|
|
|
|
Some thanks to:
|
|
|
-- FSE (actually a helpful person when he's in a good mood)
|
|
|
-- NX (well, he had the original ENet-CSharp repo I manually forked)
|
|
|
-
|
|
|
-Psst... If you want to know what started this repository, go [read my blog post](https://www.coburnsdomain.com/2019/03/getting-blocked-from-an-upstream-github-repo-nx-edition) as it'll detail the whole show. It's a good read.
|
|
|
+- Vincenzo from Flying Squirrel Entertainment
|
|
|
+- nxrighthere
|
Coburn