Skip to content

Latest commit

 

History

History
103 lines (59 loc) · 5.45 KB

README.md

File metadata and controls

103 lines (59 loc) · 5.45 KB

LootLocker-Godot-SDK

Disclaimer

This was just the beginning of an SDK for Godot. The LootLocker Team said that it has plans for an official Godot SDK, but as for now, this is what ARez came up with.

It also by far does not cover all the LootLocker features as ARez has just added the most important features that are needed. Those include:

  • User authentication (guest login, white label login, Steam & Google will come later)
  • Leaderboards (almost all features)
  • some misc features (ping)

This is a work in progress, it is barely usable for now, so DO NOT report issue as there are plenty, known or not yet known. You still can submit PR for features, bug fix or other things.

Stay tuned.

Quick Start

TODO

Introduction

Installation

Usage

Authentication

Demos included

Links in the title point to the script and not the scene as first, the scene is not very nice to display here, second, I guess the script is most interesting in the purpose of learning how to use this SDK and LootLocker features.

This sample shows how to initialize the SDK in order to use it with your game.

Just a little sample of ping call (see documentation.

As the title suggest, this is the basic authentication to LootLocker backend. It is used to hide auth mechanism from players who just want to play your game without having to create first another account somewhere and give away tons of private informations :).

As opposite to the previous auth method, this one use email/password combination and account creation, with email verification step. It is used to deal with various features like plyers's inventory, progression, mission, and many more, where a dedicated account is more than needed and worth the time spent creating it.

A little program to create many random basic players (no additionnal data except a name) at once and submit random score to a given leaderboard. Mostly for testing purpose.

This is what a game could be regarding player auth (guest) & leaderboard interactions.

Sample game provided (soon)

Dodge the creeps official tutorial game

Here is the repository of the game, it includes guest login and leaderboard. I'll eventually add some bonuses to spice up the game later.

Q & A

What is LootLocker ? What are the benefits from this thing ? And all other LootLocker related questions.

Best answers you can get are already available at LootLocker documentation website, you are strongly advised to go there, read and decide if LootLocker can be of any help to your project.

Does this SDK will be compatible with other platform SDK made by LootLocker ?

Short answer: no. It doesn't make sense to me to replicate the exact same thing of the Unity and Unreal SDK, at least for now, as why on Earth and in the Universe, someone would want easy transition from Unity/Unreal to/from Godot for a given project ? All these engines are competitors on the same field. Of course, for quite an upgrade from a free engine which is not yet mature to a "better" competitor, it make sense, anyway, nothing is carved in stone and also programming, and game programming, is also a matter of adapt and evolve, so anyone good enough could figure out how to use one feature or another no matter how it is implemented in a SDK or another.

Which Godot version is supported ?

This SDK is currently coded using 4.2-dev3 release of Godot engine, it will be most likely compatible with the most up to date 4.x release ONLY. And further releases as they'll come. It has only been tested on Windows for now. It may or may not work on other platforms.

Does this SDK is usable ?

Right now, not really, as error management especially is really really bad (it sucks to be honest) ! DO NOT use it YET, be patient, contribute if you can and will.

What is the plan for the following weeks/months ?

To continue working on the core of the SDK (low-level HTTPRequest handler and error management), add more LootLocker features, in random order:

  • Google Auth,
  • Steam Auth,
  • some Player stuff,
  • things I don't know yet (achievements for instance, if they are added soon)

The feature I want/need is not yet implemented, what should I do ?

Here you have multiple choices according to how bad you need this feature:

  • add it yourself and smbit a PR,
  • ask kindly for it,
  • contribute by giving some money, the more you give, the fastest you may expect to have it

Why asking for money ? Simply because I have my own schedule and tasks to do and also do what it need for living, so in order to spent time working on something not yet planned, which could need quite some time to work on, test it properly and so on and reordering my priorities to match your own, an extra motivation will be fairly needed.

Note: implementing a feature which depend on one or more features not yet implemented themselves will take (a lot) more time to complete.