-
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.
fixed theme selector & added daisyui (#20)
- updated README.md - updated DaisyUI - fixed inconsistencies - fixed theme selector
- Loading branch information
Showing
20 changed files
with
349 additions
and
142 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,32 +1,44 @@ | ||
![ChunkVault Banner](assets/chunkvault-banner.jpg) | ||
|
||
# Teller | ||
|
||
Teller is a comprehensive Minecraft backup solution. It is designed to facilitate both local backups and interfacing with the ChunkVault Backend. This dual functionality allows users to maintain local copies of their Minecraft worlds while also leveraging the secure storage capabilities of the ChunkVault Backend. | ||
|
||
# The Teller Library | ||
## Table of Contents | ||
- [Teller Library](#the-teller-library) | ||
- [Teller_Desktop](#teller_desktop) | ||
- [The Vault Backend](#the-vault-backend) | ||
- [CommandBlock Library](#commandblock-library) | ||
- [License](#license) | ||
- [Contributing](#contributing) | ||
- [Shoutout](#shoutout) | ||
|
||
## The Teller Library | ||
|
||
Teller is a comprehensive library designed for processing and backing up Minecraft worlds. It provides robust functionality to handle various aspects of world backup, including local backups, private server backups, and public ChunkVault backups. | ||
|
||
# Teller_Desktop | ||
## Teller_Desktop | ||
|
||
Teller_Desktop is a Tauri application that serves as the ChunkVault App a user-friendly interface for backing up Minecraft worlds. It leverages the power of the Teller library to provide an all-in-one tool for Minecraft world backup. | ||
[![ChunkVault Desktop for MacOS](assets/chunkvault-desktop-marketing-screenshot.png)](https://docs.chunkvault.com) | ||
|
||
# The Vault Backend | ||
Teller_Desktop is a Tauri/SvelteKit application that serves as the ChunkVault App - a user-friendly interface for backing up Minecraft worlds. It leverages the power of the Teller library to provide an all-in-one tool for Minecraft world backup. | ||
|
||
## The Vault Backend | ||
|
||
While Teller and Teller_Desktop handle the backup process, [The Vault Backend](https://github.com/Valink-Solutions/vault) ensures secure storage of these world backups in the cloud. | ||
|
||
# CommandBlock Library | ||
## CommandBlock Library | ||
|
||
The [CommandBlock](https://github.com/Valink-Solutions/commandblock) library is a rust library that provides functionality for parsing and executing Minecraft data such as NBT, LevelDB and more. It is used by Teller to parse Minecraft world data and extract the necessary information for backups. It is in development but its functionality is already being used by Teller. | ||
|
||
# License | ||
## License | ||
|
||
This project is licensed under the [GNU General Public License v3.0](LICENSE.txt). | ||
|
||
# Contributing | ||
## Contributing | ||
|
||
Follow the [contributing guidelines](https://docs.chunkvault.com/teller/contributing/) to contribute to this project. | ||
|
||
# Shoutout | ||
## Shoutout | ||
|
||
A special shoutout to the development team behind [Modrinth's Theseus Minecraft Launcher](https://github.com/modrinth/theseus). We've modeled our application setup/structure after theirs, as it is both easy to follow and use. Their work has greatly influenced the development of Teller and we appreciate their contribution to the Minecraft community, as well as their support of open-source software. | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Oops, something went wrong.