Skip to content

Commit e488678

Browse files
committed
Updated readme links
1 parent bee7b69 commit e488678

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![](https://i.imgur.com/d0amtqs.png)
1+
[![](https://i.imgur.com/d0amtqs.png)](https://midlevel.github.io/MLAPI/)
22

33
MLAPI (Mid level API) is a framework that hopefully simplifies building networked games in Unity. It is built on the LLAPI and is similar to the HLAPI in many ways. It does not however integrate into the compiler and it's meant to offer much greater flexibility than the HLAPI while keeping some of it's simplicity. It offers greater performance over the HLAPI.
44

@@ -11,46 +11,44 @@ MLAPI (Mid level API) is a framework that hopefully simplifies building networke
1111

1212

1313
[![Licence](https://img.shields.io/github/license/MidLevel/MLAPI.svg)](https://github.com/MidLevel/MLAPI/blob/master/LICENCE)
14-
[![Wiki](https://img.shields.io/badge/docs-wiki-green.svg)](https://github.com/MidLevel/MLAPI/wiki)
15-
[![API](https://img.shields.io/badge/docs-api-green.svg)](https://MidLevel.github.io/MLAPI/docs/index.html)
14+
[![Website](https://img.shields.io/badge/docs-website-green.svg)](https://midlevel.github.io/MLAPI/)
15+
[![Wiki](https://img.shields.io/badge/docs-wiki-green.svg)](https://midlevel.github.io/MLAPI/wiki/)
1616

1717
### Documentation
18-
To get started, check the [Wiki](https://github.com/MidLevel/MLAPI/wiki).
18+
To get started, check the [Wiki](https://midlevel.github.io/MLAPI/).
1919
This is also where most documentation lies.
2020

2121
To get the latest features, the CI server automatically builds the latest commits from master branch. Note that this build still requires the other DLL's. It might be unstable. You can download it [Here](https://ci.appveyor.com/project/MidLevel/mlapi/build/artifacts)
2222

23-
There is also a autogenerated Sandcastle [API reference](https://MidLevel.github.io/MLAPI/docs/index.html).
24-
2523
### Support
2624
For bug reports or feature requests you want to propose, please use the Issue Tracker on GitHub. For general questions, networking advice or to discuss changes before proposing them, please use the [Discord server](https://discord.gg/FM8SE9E).
2725

2826
### Requirements
2927
* Unity 2017 or newer
30-
* .NET 4.6 or .NET 3.5 with .NET 2.0 non subset [Issue](https://github.com/MidLevel/MLAPI/issues/43)
28+
* .NET 4.6 or .NET 3.5 with .NET 2.0 non subset
3129

3230
## Feature highlights
3331
* Host support (Client hosts the server)
34-
* Object and player spawning \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Object-Spawning)\]
35-
* Connection approval \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Connection-Approval)\]
36-
* Strongly Typed RPC Messaging \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Message-System)\]
32+
* Object and player spawning \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/object-spawning/)\]
33+
* Connection approval \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/connection-approval/)\]
34+
* Strongly Typed RPC Messaging \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/messaging-system/)\]
3735
* Replace the integer QOS with names. When you setup the networking you specify names that are associated with a channel. This makes it easier to manage. You can thus specify that a message should be sent on the "damage" channel which handles all damage related logic and is running on the AllCostDelivery channel.
3836
* ProtocolVersion to allow making different versions not talk to each other.
3937
* NetworkedBehaviours does not have to be on the root, it's simply just a class that implements the send methods etc.
4038
* Custom tickrate
4139
* Synced network time
4240
* Supports separate Unity projects crosstalking
43-
* Scene Management \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Scene-Management)\]
44-
* Built in Lag compensation \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Lag-Compensation)\]
45-
* NetworkTransform replacement \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/NetworkedTransform)\]
46-
* Port of NetworkedAnimator \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/NetworkedAnimator)\]
47-
* Networked NavMeshAgent \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/NetworkedNavMeshAgent)\]
48-
* Networked Object Pooling \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Networked-Object-Pooling)\]
49-
* Networked Vars \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/NetworkedVar)\]
50-
* Encryption \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Message-Encryption)\]
51-
* Super efficient BitWriter & BitReader \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/BitWriter-&-BitReader)\]
52-
* Custom UDP transport support \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/Custom-Transports)\]
53-
* NetworkProfiler \[[Wiki page](https://github.com/MidLevel/MLAPI/wiki/NetworkProfiler-Editor-Window)\]
41+
* Scene Management \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/scene-management/)\]
42+
* Built in Lag compensation \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/lag-compensation/)\]
43+
* NetworkTransform replacement
44+
* Port of NetworkedAnimator
45+
* Networked NavMeshAgent
46+
* Networked Object Pooling \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/object-pooling/)\]
47+
* Networked Vars \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/networkedvar/)\]
48+
* Encryption \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/message-encryption/)\]
49+
* Super efficient BitWriter & BitReader \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/bitwriter-bitreader-bitstream/)\]
50+
* Custom UDP transport support \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/custom-transports/)\]
51+
* NetworkProfiler \[[Wiki page](https://midlevel.github.io/MLAPI/wiki/network-profiler-window/)\]
5452

5553
## Special thanks
5654
Special thanks to [Gabriel Tofvesson](https://github.com/GabrielTofvesson) for writing the BitWriter, BitReader & ECDH implementation

0 commit comments

Comments
 (0)