Update README.md

This commit is contained in:
Albin Corén 2018-03-08 10:20:49 +01:00 committed by GitHub
parent 1197112d92
commit fc87e69212
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -19,15 +19,13 @@ MLAPI (Mid level API) is a framework that hopefully simplifies building networke
* Targeted messages \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/Targeted-Messages)\] * Targeted messages \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/Targeted-Messages)\]
* Port of NetworkedAnimator \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/NetworkedAnimator)\] * Port of NetworkedAnimator \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/NetworkedAnimator)\]
* Networked Object Pooling \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/Networked-Object-Pooling)\] * Networked Object Pooling \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/Networked-Object-Pooling)\]
* Synced Vars \[[Wiki page](https://github.com/TwoTenPvP/MLAPI/wiki/SyncedVars)\]
## Planned features ## Planned features
* Area of interest * Area of interest
* Encrypted messages / full encryption for all messages. Diffie Hellman key exchange with the option to sign the transaction using RSA. * Encrypted messages / full encryption for all messages. Diffie Hellman key exchange with the option to sign the transaction using RSA.
* Serializer (both for the library to speed up and to allow structs to be sent easily) * Serializer (both for the library to speed up and to allow structs to be sent easily)
* SyncVars (allow variables to automatically be synced to new clients and current clients when it's changed)
_SyncVars will require code injection at compilation with some form of attribute, this is due to limitations of C#. There is no way to have a reference to a variable._
* Message compression * Message compression
## Example ## Example
@ -39,3 +37,5 @@ The example project has a much lower priority compared to the library itself. If
## Issues and missing features ## Issues and missing features
If there are any issues, bugs or features that are missing. Please open an issue on GitHub! If there are any issues, bugs or features that are missing. Please open an issue on GitHub!
## Testing
The project is not extensivley tested. I am however very active on answering and fixing issues. If you are using the library. If you find something doesn't work or throws an exception. Open an issue or submit a PR.