Skip to content

Home

Jump to bottom
Alvydas Poškevičius edited this page Mar 17, 2017 · 6 revisions

⚠️ ⚠️ ⚠️ This Documentation Is For The Older Version Of The Framework (V1.03)

Contents Of The Wiki

Under the hood, framework is quite simple, but variety of different concepts might be a bit difficult to grasp at first - these guides are here to help you find your away around it.

If you found a section that's lacking, or if you want something covered in the documentation, post a feature request here, in GitHub (Issues tab), or send me a personal message. I know how awesome it is to own a product with great documentation, so I'll be more than happy to assist. 🌞

  1. Introduction to the framework - great read to understand "The Big Picture"
  2. ⚠️ 🔴 Important Stuff
  3. Updates (v1.03.1) 🆕
  4. 🆕 🔥 From Scratch -Great place to understand the framework
    1. Introduction
    2. Setting Up Unity Projects
    3. Basic Master Server
    4. Basic Client
    5. Adding Authentication module
    6. Adding Games Module
    7. Registering Game Server 🆕 - guide on how to register any kind of game server (even a fake one) to the master server
    8. Automating game server launching ( ⚠️ I'm working on the V1.04 update, which will slightly change the way the framework sets up. It's going to take about a week to finish. (Date of writing: 2017.02.02). I'll finish this tutorial when the update is completed)
    9. Using what we know to setup an existing uNet game server (WIP)
  5. Demo Related
    1. [Demo Explained] (https://github.com/alvyxaz/barebones-master-v1/wiki/Demo-Explained)
    2. [Launching The Demo] (https://github.com/alvyxaz/barebones-master-v1/wiki/Launching-The-Demo) - good place to start if you like to learn from an example
  6. Development / Getting Started
    1. Master Server And Modules - a short guide that will help you better understand what is the Master Server and how modules work
    2. Integrating to uNET game - short guide on implementing master server functionality in a simple uNET game.
    3. Creating Modules - tutorial on how to extend master server functionality with your own modules
    4. Networking API. Send, receive and handle messages - this guide contains examples that will help you get familiar with networking abstraction layer.
    5. Tips on how to structure your project/scenes
    6. Database 🆕
    7. Command Line Arguments - a list of default arguments you can use when starting servers
  7. Modules
    1. [Authentication] (https://github.com/alvyxaz/barebones-master-v1/wiki/Authentication)
    2. [Profiles Module] (https://github.com/alvyxaz/barebones-master-v1/wiki/Player-Profiles)
    3. Chat Module
    4. Game Rooms Module - general overview, describing how game servers register to master.
    5. Lobbies Module 🆕
    6. Spawner Server - describes inner workings of spawner server and how you can use it to spawn game servers.
  8. Platform Specific
    1. Mac OS Ceveats
  9. Production
    1. Hosting your game

Editing Source code

It's highly advised that you don't make any changes to source code. In most cases, you should be able to make changes by implementing interfaces, extending classes or subscribing to events. If you edit the source, it's possible that your project will break when you download an update, because your changes will be overwritten.

With that said, it's still possible that you might stumble upon an issue where there's no work around. In that case, make the changes and contact me, I'll try to provide a better access to what you need in the next update.

Clone this wiki locally