https://github.com/agroqirax/timberbornstatsviewer
https://github.com/agroqirax/timberbornstatsviewer
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/agroqirax/timberbornstatsviewer
- Owner: Agroqirax
- License: mit
- Created: 2024-07-14T21:02:26.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-15T21:16:10.000Z (11 months ago)
- Last Synced: 2025-02-06T15:19:20.569Z (4 months ago)
- Language: HTML
- Homepage: https://agroqirax.github.io/TimberbornStatsViewer/src/index.html
- Size: 6.18 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# Timberborn Stats Viewer
The Timberborn Stats Viewer aims to give users insight into their Timberborn save file. The project makes it easy to see if your beavers are producing too much or too little of a good, how much they planted, and more.
## Features
- **Save Thumbnail:** Displays the thumbnail of your save file.
- **Statistics:** Basic stats and details such as the timestamp, number of beavers, map name and size, etc...
- **Production Information:** Various stats such as production amounts, required amounts, and storage amounts for each good.
- **Planting Information:** Details how much you have marked to be planted per crop/tree, how much has been planted, and how much has grown.
- **Recent Notifications:** Displays recent in-game notifications.
- **Mod Information:** Lists the mods used in the save.
- **Localization:** Supports multiple languages with translations for all supported languages.
## Installation and Usage
### Using the Site
You can use the site by visiting [Timberborn Stats Viewer](https://Agroqirax.github.io/TimberbornStatsViewer/src/index.html).
### Hosting the Project
For developers who wish to host the project themselves or help developing, clone the repo and host it using a webserver of your choice.
```sh
git clone https://github.com/Agroqirax/TimberbornStatsViewer.git
cd TimberbornStatsViewer
```
## Contributing
See [`/.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md)
## Code of conduct
See [`/.github/CODE_OF_CONDUCT.md`](.github/CODE_OF_CONDUCT.md)
## Localization
See [`/docs/localization.md`](docs/Localization.md)
## License
This project is licensed under the MIT License. See [`LICENSE.md`](LICENSE.md) file for more details.
# Contact
## Bug Reports
Users can submit bugs or problems trough the [google form](https://forms.gle/NyCKFR2kQGNfsajN9)
Developers can create an issue on the [repository](https://github.com/Agroqirax/TimberbornStatsViewer/issues)
The author can be contacted at [[email protected]](mailto:rickiedev60gmail.com).