Skip to content

Commit

Permalink
fixed theme selector & added daisyui (#20)
Browse files Browse the repository at this point in the history
- updated README.md
- updated DaisyUI
- fixed inconsistencies
- fixed theme selector
  • Loading branch information
JakePIXL committed Nov 13, 2023
1 parent fe20d9d commit 5130fdb
Show file tree
Hide file tree
Showing 20 changed files with 349 additions and 142 deletions.
Binary file modified .DS_Store
Binary file not shown.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 21 additions & 9 deletions README.md
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.

Binary file added assets/chunkvault-banner.jpg
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.
2 changes: 1 addition & 1 deletion teller/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "teller"
version = "0.2.3"
version = "0.2.4"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
5 changes: 3 additions & 2 deletions teller_desktop/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "teller-desktop",
"version": "0.2.3",
"version": "0.2.4",
"private": true,
"scripts": {
"dev": "vite dev",
Expand All @@ -21,7 +21,7 @@
"@tauri-apps/cli": "^1.5.6",
"@zerodevx/svelte-toast": "^0.9.5",
"autoprefixer": "^10.4.15",
"daisyui": "^3.7.5",
"daisyui": "^4.0.1",
"eslint": "^8.49.0",
"eslint-config-prettier": "^8.10.0",
"eslint-plugin-svelte3": "^4.0.0",
Expand All @@ -43,6 +43,7 @@
"dependencies": {
"@tauri-apps/api": "^1.5.1",
"dayjs": "^1.11.9",
"postcss-color-function": "^4.1.0",
"sortablejs": "^1.15.0",
"svelte-modals": "^1.3.0"
}
Expand Down
Loading

0 comments on commit 5130fdb

Please sign in to comment.