|
1 | | -# Talo dashboard |
| 1 | +# Talo frontend: self-hostable game dev dashboard |
2 | 2 |
|
3 | | -Talo's dashboard lets you see your players and interact with your game directly. |
| 3 | +Talo is a collection of tools and APIs designed to make game development easier and to help you make better data-driven decisions. |
4 | 4 |
|
5 | | -## Features |
6 | | -- ⚡️ [Event tracking](https://trytalo.com/events) |
7 | | -- 👥 [Player management](https://trytalo.com/players) (including cross-session data, groups and identity management) |
8 | | -- 🎮 [Unity package](https://trytalo.com/unity) |
9 | | -- 🎮 [Godot plugin](https://trytalo.com/godot) |
10 | | -- 🗃️ Data exports |
11 | | -- 🕹️ [Leaderboards](https://trytalo.com/leaderboards) |
12 | | -- 💾 [Game saves](https://trytalo.com/saves) |
13 | | -- 📊 [Game stats](https://trytalo.com/stats) (global and per-player) |
14 | | -- ⚙️ [Live config](https://trytalo.com/live-config) (update your game config from the web, no releases required) |
15 | | -- 🔧 [Steamworks integration](https://trytalo.com/steamworks-integration) |
16 | | -- 💬 [Game feedback](https://trytalo.com/feedback) |
| 5 | +The Talo dashboard gives you a visual overview of your game including players, leaderboards, game save data and various analytics. |
17 | 6 |
|
18 | | -## Docs |
| 7 | +Talo is available to use via our [Godot plugin](https://github.com/TaloDev/godot), [Unity package](https://github.com/TaloDev/unity) or [REST API](https://docs.trytalo.com/docs/http/authentication). |
19 | 8 |
|
20 | | -Our docs are [available here](https://docs.trytalo.com). |
| 9 | +## Talo's key features |
21 | 10 |
|
22 | | -## Self-hosting |
| 11 | +- 👥 [Player management](https://trytalo.com/players): Persist player data across sessions, create segments and handle authentication. |
| 12 | +- ⚡️ [Event tracking](https://trytalo.com/events): Track in-game player actions individually and globally. |
| 13 | +- 🎮 [Godot plugin](https://trytalo.com/godot): Easily integrate Talo into your Godot game. |
| 14 | +- 🎮 [Unity package](https://trytalo.com/unity): Easily integrate Talo into your Unity game. |
| 15 | +- 🗃️ **Data exports**: Create CSVs of your Talo data like players, events and feedback. |
| 16 | +- 🕹️ [Leaderboards](https://trytalo.com/leaderboards): Highly customisable leaderboards that can sync with Steamworks. |
| 17 | +- 💾 [Game saves](https://trytalo.com/saves): A simple and flexible way to load/save game state; also works offline. |
| 18 | +- 📊 [Game stats](https://trytalo.com/stats): Track global or per-player stats across your game; also syncs with Steamworks. |
| 19 | +- ⚙️ [Live config](https://trytalo.com/live-config): Update game settings from the web with zero downtime. |
| 20 | +- 🔧 [Steamworks integration](https://trytalo.com/steamworks-integration): Hook into Steamworks for authentication and ownership checks. |
| 21 | +- 💬 [Game feedback](https://trytalo.com/feedback): Collect and manage feedback from your players. |
23 | 22 |
|
24 | | -See the [self-hosting docs](https://docs.trytalo.com/docs/selfhosting/overview) and the [self-hosting example repo](https://github.com/TaloDev/hosting). |
| 23 | +## Documentation |
25 | 24 |
|
26 | | -## Discord |
| 25 | +Check out the [full Talo docs](https://docs.trytalo.com) for setup instructions, detailed API docs/examples and configuration options. |
27 | 26 |
|
28 | | -For help and support, [join our Discord](https://discord.gg/2RWwxXVY3v). |
| 27 | +## Self-hosting your own Talo instance |
29 | 28 |
|
30 | | -## Installing, building & running |
| 29 | +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. |
31 | 30 |
|
32 | | -Run `npm install` to install the dependencies. |
| 31 | +## Contributing to Talo |
33 | 32 |
|
34 | | -### npm run dev |
| 33 | +Thinking about contributing to Talo? We’d love the help! Head over to our [contribution guide](CONTRIBUTING.md) to learn how to set up the project, run tests, and start adding new features. |
35 | 34 |
|
36 | | -Runs the app in the development mode. |
37 | | -Open http://localhost:8080 to view it in the browser. |
| 35 | +## Join our community |
38 | 36 |
|
39 | | -### npm run build |
| 37 | +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. |
40 | 38 |
|
41 | | -Builds a static copy of the site to the `dist/` folder. |
| 39 | +--- |
42 | 40 |
|
43 | | -## Docker? |
44 | | - |
45 | | -We use Docker to build a production image of the dashboard (which is a simple NGINX server that hosts the static build files). It's not needed for development. |
| 41 | +Find all the details about Talo on our [website](https://trytalo.com)! |
0 commit comments