DevNotes Server

ASP.NET Core backend server for DevNotes

User Manual

API Documentation

Quick Start

• git clone https://github.com/Crab-Cafe/DevNotes-Server.git
• cd DevNotes-Server
• dotnet run --project DevNotesServer

The server will be built, and a Devnotes.db will be created beside your executable. You will need to use the Admin Tool to create a user

Admin Tool

The DevNotesAdmin program can be used to modify the DevNotes database, by adding and removing users, and resetting passwords.
You will need to create a user to be able to connect to your DevNotes server from Unreal Engine.

Important: The DevNotesAdmin program must be run from the same directory as the Devnotes.db file.

Application Settings

You can configure the server config settings from appsettings.json. The most important settings are:

  "AppSettings": {
    "Port": 7124,
    "PublicKey": "ABC123"
  }

Public Key

The public key is a configurable key that can be used in place of an auth session token, for the sole purpose of pushing a note from an anonymous client. It is only compatible with the /notes/dto endpoint. An example use case for this is adding a "Report Bug" button to your game, where the bug report from a player will be placed as a note in the game editor. As the player cannot 'sign in' to the DevNotes server, a developer can configure the client to use the public key instead.

Easy Mode

• Download an extract the latest DevNotesServer binary from the Releases page
• Run DevNotesAdmin.exe
• Create a new user and close
• Run DevNotesServer.exe