Giter VIP home page Giter VIP logo

darkrift.documentation's Introduction

DarkRift.Documentation

This is the source repository for DarkRift documentation.

Building the Documentation

This documentation is built using DocFx.

Once you have installed DocFx you can build this project by simply running docfx from the project directory. The built documentation will be output to the _site folder.

Unless you have the source code for DarkRift, DocFx will be unable to generate the reference documentation. This should not stop the build and should only throw warnings you can ignore.

If you do have the source you can edit the metadata/source elements in the docfx.json file to point at the source code and thus build the reference documentation.

Diagrams

Diagrams are made using diagrams.net and the XML save file should be version controlled in the directory the diagrams are used in with the the PNG exports saved in /images.

Source Code License

Documentation is licensed under MIT LICENSE.md. Source code is licensed under MPL 2.0, with some exceptions where MIT applies. See DarkRift's LICENSE.md.

Contributions and Issues

Contributions and issues are most welcome.

Any issues should be solely related to documentation however, issues related to the rest of DarkRift should be posted here instead.

All contributions should be in well written english (we're not currently providing documentation in any other language), we might be quite strict about this in PRs so don't take it personally!

And of course, any spelling/grammar fixes are actively encouraged!

Code of Conduct

Be civil. DarkRift's code of conduct applies here too.

darkrift.documentation's People

Contributors

4real avatar aaronrmm avatar aweidermann avatar brettriekman avatar elginas avatar eliseodiegoviola avatar hukha avatar jamjar00 avatar pekaram avatar penca53 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

darkrift.documentation's Issues

Syntax error in example matchmaker

In the example matchmaker on this page the type parameter on the class is a Player but the ranking function expects a int.

The type parameter on the class should be changed to int.

Tutorial Unity MouseController

Thanks for creating an issue/feature request! Please use the template below to ensure you have all the necessary information.

Quick Description

ControllablePlayer doesn't move with the mouse after adding MouseController to it.

Explanation

Camera.main.ScreenToWorldPoint(Input.mousePosition) always returns zero.

For Issues

Unity version 2018.2.18f1

I resolved ScreenToWorldPoint always returning zero by changing it to:
Camera.main.ScreenToWorldPoint(Input.mousePosition + new Vector3(0, 0, 10))

Parse Error

The default value "localhost" of UnityClient.Host will be parsed incorrectly as "::1" instead of "127.0.0.1" on windows 10 by using darkrift pro.

Increased Clarity for Pro Features in Documentation

Quick Description

Add a stamp, image, or otherwise clear marker at the top of each page of documentation as to whether the specified class, interface, or other is Free or Pro.

For Feature Requests

Entire documentation would benefit from having visual Free/Pro clarification at the top of each page.

Some current examples where it would help are:
Timer Class: Pro, but missing the remark stating that it was Pro, so it isn't known (bug, but pointed out in discord).
Plugin.BadWorldFilter: Pro, but marked at the bottom of the page in plain text as Pro only. Not immediately visible.

No overwrite an object on deserialization in Message

Quick Description

The documentation mentions a function to overwrite an object on deserialization without a reference.

Explanation

The documentation points to the DarkRift.message.Deserialize<T>() : https://www.darkriftnetworking.com/DarkRift2/Docs/2.9.1/advanced/serialization.html
and claims

It is also possible to pass DarkRift an object to overwrite on deserialization to reduce garbage generation.

This functionality is only provided by DarkRiftReader.ReadSerializableInto<T>().

The documentation should best state, that more functionality is provided by DarkRiftReader.

Incompatibility issue Unity 2018.3.8f1 (New Prefab System) in Tutorial

Due to the new prefab system there is now a different hierarchy in prefabs.
Referenced tutorial page is: https://darkriftnetworking.com/DarkRift2/Docs/2.4.0/getting_started/5_movement.html

Before:
Circle(Player) with all the scripts and renderer etc on it.

Now:
Prefab (Parent)
Circle (Child)

Because of this the PlayerSpawner script is giving errors in the SpawnPlayer script when it needs to get the Player and AgarObject component.

Errorlines:
Player player = obj.GetComponent();
AgarObject agarObj = obj.GetComponent();

Fix:
Player player = obj.GetComponentInChildren();
AgarObject agarObj = obj.GetComponentInChildren();

I will try and fix this right now but to be sure I prefer also submitting an issue.

EDIT: Please disregard, false information

IPVersion still used in tutorial

The tutorial still shows the obsolete IP version property in an image of the Unity inspector. This image should be updated and any other references fixed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.