Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 5.03 KB

README.md

File metadata and controls

113 lines (79 loc) · 5.03 KB
Raw

DotNetCore Tutorial for Unity3d for absolute noobs

What is .NET Core

  • Cross Platform C#
  • Runs from a folder on OSX or Linux
  • Stripped down high performance
  • WebApi / MVC is an http framework built on Core

What is this ?

  • A minimalistic HTTP server with...
  • SQL(Lite) Database using Entity Framework
  • High Score Api Controller
  • Chat Websocket service
  • Unity3d client

Prerequisites

Official Links

Tools

Good Samples

Good to knows

Facts

  • All apps in dotnetcore are glorified console apps. Program.cs is our entry point.
  • In Startup.cs we configure the MVC/WebApi part of the app.
  • Besides Startup and Program.cs code exists as /Infrastructure or /Modules
  • Infrastructure includes utilities and componenets
  • Modules includes domain services, controllers, and models
  • MVC has some magic that might be hard to grasp.
  • Routing is the convention to send HTTP requests to 'controllers'
  • View Location is the convention for finding html 'views' from controllers (for non API controller)
  • Entity framework defines a database using annotations
  • ModelState can validate a data object using annotations

Entity Framework

Entity framework is an Database Object Relationship Manager. Simply put, it is a strongly typed api for manipulating and persistent data. With EF you have a DataContext (the database object and unit of work). Inside the context you have DBSets, a collection type, one for each table in the database. DBSets are generic of you entity type. Entities define your table columns by way of properties and annotations. Everything in EF is code first, so, you write a C# file, close your eyes and you have a database. There are many other features such as navigational properties (table joins) and providers for other database types such as postgres.

We will use something called Nuget to import dependencies.

  • Open PackageManagerConsole

  • Type This

Install-Package Microsoft.EntityFrameworkCore -Pre

Install-Package Microsoft.EntityFrameworkCore.Tools -Pre

Install-Package Microsoft.EntityFrameworkCore.Sqlite -Pre

PROTIP Update-Package -reinstall will re-reference all dlls if things break

Define a database

  • Open ScoreModel.cs, this defines our single data table
  • Open ScoreContext.cs, this defines our database
  • Note that we ensure the database is create in Program.cs
  • Generally the database would exist outside in a shared domain and reference models from all domains.
  • The ScoreContext defines that it is using SQLite, this should really be handled by Startup

Test it

  • On the project file, right click, options, set the default url to point to our ScoreController
  • I use POSTMON chrome extension, now make up some HTTP requests to the server
  • Server supports GET/ POST / DELETE verbs
  • GET http://{url}/api/Score
  • GET http://{url}/api/Score/{id}
  • POST http://{url}/api/Score/ (with Json Body
  • Delete http://{url}/api/Score/{id}

Setup socket for real time chat

  • Get the Nuget package

Import-Package Microsoft.AspNetCore.WebSockets.Server -Pre

  • You will need to define a handler for websocket requests (ChatService.cs and ChatClient.cs).

  • You will also need to register this with the web app in Startup.cs

  • You can test it (Websocket extension above) by connectin to ws://{localhost:port}

  • The chat service is a simple broadcast relay

Unity Example

look at the code. Everything runs from Debug ContextMenu commands on the debug behaviour instance (on the main camera). Running the app is required for the chat demo due to main thread callback mechinism.