-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #90 from TaloDev/develop
Release 0.28.0
- Loading branch information
Showing
5 changed files
with
46 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,49 @@ | ||
# Talo Unity package | ||
# Talo Unity Package: self-hostable game dev tools | ||
|
||
Build games faster and make better decisions with the [Talo](https://trytalo.com) Unity package. | ||
Talo is a collection of tools and APIs designed to make game development easier and to help you make better data-driven decisions. | ||
|
||
## Features | ||
- ⚡️ [Event tracking](https://trytalo.com/events) | ||
- 👥 [Player management](https://trytalo.com/players) (including cross-session data, groups and identity management) | ||
- 🎮 [Unity package](https://trytalo.com/unity) | ||
- 🗃️ Data exports | ||
- 🕹️ [Leaderboards](https://trytalo.com/leaderboards) | ||
- 💾 [Game saves](https://trytalo.com/saves) | ||
- 📊 [Game stats](https://trytalo.com/stats) (global and per-player) | ||
- ⚙️ [Live config](https://trytalo.com/live-config) (update your game config from the web, no releases required) | ||
- 🔧 [Steamworks integration](https://trytalo.com/steamworks-integration) | ||
- 💬 [Game feedback](https://trytalo.com/feedback) | ||
- 🛡️ [Continuity](https://trytalo.com/continuity) (keeping your data in-sync even when your players are offline) | ||
From essentials like player management, stats and leaderboards to advanced APIs for game saves, event tracking and player authentication. | ||
|
||
## Docs | ||
The Talo Unity Package is a lightweight wrapper around the [REST API](https://docs.trytalo.com/docs/http/authentication). It also includes handy utilities and a collection of ready-to-use samples. | ||
|
||
Our docs are [available here](https://docs.trytalo.com). | ||
This repo is a Unity game (the Talo Playground) that lets you try out and preview functionality from a UI. Within that, Talo is installed as a local package. | ||
|
||
## Discord | ||
## Get the package | ||
|
||
For help and support, [join our Discord](https://discord.gg/2RWwxXVY3v). | ||
- [GitHub releases](https://github.com/TaloDev/unity/releases) | ||
- [itch.io](https://sleepystudios.itch.io/talo-unity) | ||
|
||
## Project structure | ||
## Talo's key features | ||
|
||
The repo itself is a Unity game (the Talo Playground) that lets you try out and preview functionality from a UI. Within that, Talo is installed as a local package. | ||
- 👥 [Player management](https://trytalo.com/players): Persist player data across sessions, create segments and handle authentication. | ||
- ⚡️ [Event tracking](https://trytalo.com/events): Track in-game player actions individually and globally. | ||
- 🕹️ [Leaderboards](https://trytalo.com/leaderboards): Highly customisable leaderboards that can sync with Steamworks. | ||
- 💾 [Game saves](https://trytalo.com/saves): A simple and flexible way to load/save game state; also works offline. | ||
- 📊 [Game stats](https://trytalo.com/stats): Track global or per-player stats across your game; also syncs with Steamworks. | ||
- ⚙️ [Live config](https://trytalo.com/live-config): Update game settings from the web with zero downtime. | ||
- 🔧 [Steamworks integration](https://trytalo.com/steamworks-integration): Hook into Steamworks for authentication and ownership checks. | ||
- 💬 [Game feedback](https://trytalo.com/feedback): Collect and manage feedback from your players. | ||
- 🛡️ [Continuity](https://trytalo.com/continuity): Keep your data in-sync even when your players are offline. | ||
|
||
There are two examples included too: one for a save file system and one for a leaderboards system. | ||
## Samples included with the package | ||
|
||
- 🕹️ Leaderboards: a basic leaderboard UI, allowing you to add and update entries. | ||
- 💾 Game saves: a basic saves UI, allowing you to load, create and update saves. | ||
- 🔒 Authentication: a registration/login flow, showing how to create player accounts and authenticate them. | ||
- 🎮 Playground: a text-based playground allowing you to test identifying, events, stats and leaderboards. | ||
|
||
## Documentation | ||
|
||
Check out the [full Talo docs](https://docs.trytalo.com) for setup instructions, detailed API docs/examples and configuration options. | ||
|
||
## Self-hosting your own Talo instance | ||
|
||
Talo is designed to be easily self-hosted. Take a look at our [self-hosting guide](https://docs.trytalo.com/docs/selfhosting/overview) and the [GitHub repo](https://github.com/TaloDev/hosting) for examples on how to get started. | ||
|
||
## Join our community | ||
|
||
Have questions, want to share feedback or show off your game? [Join us on Discord](https://trytalo.com/discord) to connect with other developers and get help from the Talo team. | ||
|
||
--- | ||
|
||
Find all the details about Talo on our [website](https://trytalo.com)! |