README.md
<div id="top"></div>
<br />
<div align="center">
<a href="https://github.com/leonitousconforti/tinyburg">
<img src="docs/tinyburgBanner.png" alt="Logo">
</a>
<h3 align="center">Tinyburg</h3>
<p align="center">
Api and trading platform for the mobile game Tiny Tower by Nimblebit
<br />
<a href="https://github.com/leonitousconforti/tinyburg/tree/main/docs"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://tinyburg.app/">Interactive Demo</a>
·
<a href="https://github.com/leonitousconforti/tinyburg/issues">Report a Bug</a>
·
<a href="https://github.com/leonitousconforti/tinyburg/issues">Request a Feature</a>
</p>
</div>
## About Tinyburg
Tinyburg is a collection of javascript projects centered around the mobile games TinyTower, LegoTower, and TinyTowerVegas by Nimblebit. What started as a small idea, wanting to be automatically entered into the raffle every hour, has grown over time into this monorepo.
The initial desire for creating this library came from wanting to build an application that automatically entered me into the raffle every hour. While I am aware that you could achieve some of the same results by running Tiny Tower on your computer with an emulator like blue stacks and writing a simple script to make your mouse enter the raffle every hour, that really wasn't as exciting/what I really wanted to do. Some notable projects I found on GitHub that take this approach include [Cydia--Script-TinyTowerBot](https://github.com/egold555/Cydia--Script-TinyTowerBot), [TinyClicker](https://github.com/filadog/TinyClicker), [SortTinyTowerWorkers](https://github.com/andagr/SortTinyTowerWorkers), [Tiny-Tower-Bot](https://github.com/CeHaga/Tiny-Tower-Bot), and [tiny-tower-bot](https://github.com/jacdavwill/tiny-tower-bot). Tinyburg, however, is unique because it enables you to do anything you can do on the mobile game and more from anywhere with an internet connection without needing to open the app. Not to mention there are some things that you simply cannot do with just an emulator, mouse scripts, and screen recording/video processing. Tinyburg achieves all this by utilizing the same API that Tiny Tower to make requests to Nimblebit’s servers.
### How tinyburg works
Tinyburg works by utilizing the cloud sync feature in Tiny Tower; without it Tinyburg would not be possible. If you are not familiar with the cloud sync feature, it allows you to sign in and sync your tower across multiple devices. Although some people have trouble getting their towers to sync properly when signed in to multiple devices, I have had no problem using tinyburg as long as you follow the best practices. Tinyburg is very robust and has a large test suite. Of note is that if you never push a save using the tinyburg library, then there is absolutely no way for your tower to stop syncing or for you to get banned for cheating. This means that you can still use every other feature available and be 100% confident that you won't screw anything up. If you are trying to build a project or mess around with tinyburg, I recommend starting with a dummy account first either in an emulator or somewhere else so just in case you mess something up it isn't on your main tower - you can use @tinyburg/architect for quite prototyping.
### :dart: Features of the @tinyburg/core library
- Downloading, decompressing, parsing, modifying, compressing, and uploading save game data (your tower)
- Typed save data - save data is parsed into objects with types so that you can easily tell what you are modifying
- Getting visits + visiting friends
- Sending gifts (bitizens) + receiving gifts (bitizens, raffle tickets, gold/coins)
- Check entered raffle status, enter raffle, enter multi-raffle, and get raffle details
- Pulling your snapshot list, pulling snapshot data, and pushing snapshots (rebuilds)
- Adding friends, pulling friend meta data, pulling friends tower, pulling friends snapshot list
- bitbook cloud posts (there is a bitbook cloud feed apart from the posts in your save data)
- cloud gifts feed (a feed where nimblebit can send gifts to everyone)
- Registering cloud sync email, verifying cloud sync email (used for the cloud sync sign in process and authentication workflow)
- Extracted data about all in game items (floors, roofs, lobbies, elevators, costumes, pets, etc)
- Send gifts to yourself by proxying them through a burn-bot
- Configurable logging (pino, debug, or bring your own logger)
see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the features/architecture of all the other projects in this repo
### Things I am not going to support/add
- Signing in through facebook/gamecenter/google play
## Less talk, where's a working demo?
[](https://repl.it/github/leonitousconforti/tinyburg)
[](https://npm.runkit.com/tinyburg)
A working demo can be found on REPL: <https://replit.com/@LeoConforti1/tinyburg-demo?v=1>, it features the CLI app from the most recent version of Tinyburg. Feel free to mess around on REPL and if you end up breaking something just refresh the page. Additionally, if you prefer a more condensed view, you can use the [lite REPL](https://replit.com/@LeoConforti1/tinyburg-demo?lite=1&outputonly=1) option
There is also RunKit example at <https://npm.runkit.com/tinyburg> although it is not sophisticated as the REPL demo. The RunKit example is more just for people to be able to mess around with the code and get a feel for the library, while the REPL is an actual demo.
The tinyburg site is in the works. [https://tinyburg.app](https://tinyburg.app) will hopefully be a place where players can go to trade in game items with each other - anything from singular bitizens to entire floors or costumes or lobbies and so much more! You could really trade anything from the entire game, as long as there is someone willing to trade with you.
## :memo: Have Questions or Need Help? Check out the docs
Most of the information is documented in the [/docs](/docs) folder, so please try to read them first. If you still can't find the information you are looking for, feel free to open a [discussion](https://github.com/leonitousconforti/tinyburg/discussions) post and try to leave issues to bug reports or other problems.
## :bulb: Fun projects you could actually make
- A discord RaffleBot
The current raffle bot is a little simple and I feel you could enhance it with some new features. Why not have the bot be able to query if you are currently entered in the raffle or not.
- A player stats leader board
Collect player stats and display who has the most of a particular thing, or something similar.
- A bitbook post tweeter
Collect bitbook posts from your save data or other players save data and create a Twitter feed using them
- An auto gold bit farm
A tower where when you send your bitizens to it, it sends them back as gold bitizens. (Example, see: [examples/auto-gold-bits](./examples/auto-gold-bits.js))
## :wave: Interested in Contributing?
There is a [Contributing Guide](docs/CONTRIBUTING.md) to help with you with pull requests, issues, commit messages, and style guides. And there is a [Dev Guide](docs/DevGuide.md) to help you with setting up your dev environment and containers.
I want your help. No really, I do.
There might be a little voice inside that tells you you're not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.
I assure you, that's not the case.
And you don't just have to write code. You can help out by writing documentation, tests, or even by giving feedback about this work.
Thank you for contributing!