-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add a bit more details to the readme (#776)
- Loading branch information
1 parent
ccfcd7b
commit 144f124
Showing
3 changed files
with
34 additions
and
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,36 @@ | ||
# Takaro | ||
|
||
Takaro is a web-based, multi-gameserver manager. It features a web interface to manage your gameservers, and a REST API to interact with them. See [the docs](https://docs.takaro.io) for more info | ||
|
||
## Development setup | ||
<p align="center"> | ||
<img align="center" src="https://github.com/gettakaro/takaro/blob/main/logo.png?raw=true" width="200" height="200" /> | ||
<h2 align="center">Takaro</h2> | ||
</p> | ||
|
||
[Getting started](https://docs.takaro.io/development/getting-started) | ||
Takaro is a web-based, multi-gameserver manager. It features a web interface to manage your gameservers, and a REST API to interact with them. For detailed information, visit our [documentation](https://docs.takaro.io). | ||
|
||
## Modules | ||
|
||
The core of Takaro is built around Modules. Modules offer a very powerful and flexible way of creating features. | ||
|
||
Here are some examples: | ||
|
||
- **AFK-kick module**: tracks player activity and automatically removes inactive players. | ||
|
||
- **Teleport module**: offers set of in-game commands enabling players to create their own teleport points and teleport to them. | ||
|
||
- **Economy module**: introduces a virtual currency, actively engaging players in earning and spending currency. Players can accumulate currency through diverse activities. E.g. defeating entities, earning daily login rewards and participating in bounty hunting. Additionally, players can transact currency among themselves or use it to purchase items from a customizable shop. | ||
- **Bounty module**: builds upon the Economy module, this feature allows players to set bounties on other players. When a player with a bounty is defeated, the bounty reward is transferred to the victor. | ||
|
||
|
||
|
||
### Custom modules | ||
The above modules represent only a **tiny fraction** of the modules maintained by the Takaro team. | ||
To explore all the modules we offer, visit our [full List of Built-In Modules](https://docs.takaro.io/built-in-modules) | ||
|
||
If however the current modules don't cater to your specific needs, don't worry. Takaro also provides a development environment to create your own custom modules. | ||
|
||
|
||
## Contributions | ||
We welcome contributions from the community! Whether you're a developer, designer, or gamer, your input can help shape the future of Takaro. | ||
|
||
### Code contributions | ||
Begin your journey with Takaro's development by visiting our [Getting started](https://docs.takaro.io/development/getting-started) guide. |
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