Skip to content

Commit a168fc8

Browse files
committed
Updated installation page
1 parent 40fdaf6 commit a168fc8

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/_docs/getting-started/installation.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,26 @@ title: Installation
33
permalink: /wiki/installation/
44
---
55

6+
### Installer
67
To get started with the MLAPI. You need to install the library. The easiest way is to use the Editor installer. Simply download the MLAPI_Installer unity package from the [here](https://github.com/TwoTenPvP/MLAPI/releases). Then press window at the top of your editor and select MLAPI. Once in the MLAPI window, select the version you wish to use and press install.
8+
9+
710
![Video showing the install process](https://i.imgur.com/zN63DlJ.gif)
811

912

1013
Once imported into the Unity Engine, you will be able to use the components that it offers. To get started, you need a GameObject with the NetworkingManager component. Once you have that, use the Initializing the library articles to continue.
1114

1215

16+
### Files
17+
The MLAPI comes with 3 main components
18+
##### MLAPI.dll + IntXLib.dll
19+
These two DLL's are the runtime portion. The actual library. *IntXLib.dll is the BigInt library used for the ECDHE implementation*. These files are thus **required**.
20+
##### MLAPI-Editor.unitypackage
21+
This unitypackage includes the source files for all the Editor scripts. The UnityPackage will automatically place these source files in the Editor folder to avoid it being included in a build. **While the MLAPI will function without this, it is not designed to work without the editor part and is thus recommended for all users**.
22+
##### MLAPI-Installer.unitypackage
23+
This unitypackage includes the source file for the installer. This component is totally optional. The Installer can help you manage versions. If you don't want to use the installer, you can simply place the MLAPI.dll, IntXLib.dll and the Editor source files in your project and it will work just as well.
1324

1425

15-
**Important note**
1626

27+
### Important note
1728
_The wiki, API references, readme and other documentation like information is not updated on a per commit basis. They are being updated on a per release basis. Thus using in development features on the master branch is not discouraged but there might not be any documentation except the commit messages._

0 commit comments

Comments
 (0)