Merge remote-tracking branch 'origin/master'

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to HyBlockUtils
+
+## Required Hardware and Software
+- [Android Studio](https://developer.android.com/studio)
+- Multible Android Devices or Emulators on different API Levels (API level 16 or higher) for testing
+    - can be created in Android Studion using the included AVD Manager
+- A [Hypixel API key](https://api.hypixel.net/#section/Authentication/ApiKey) for testing
+
+## Getting Started
+1. Log into github
+2. Fork this repository
+3. Clone the project to your local machine 
+    - git command, Android Studio or some GUI (I for example used SourceTree)
+4. Import the projekt into Android Studio
+5. (Wait for the project to fully load)
+6. Select an Android device (physical or emulated) with an api level of 16 or higher
+    - create an emulated one with the AVD manager if you don't have one
+7. Now you can change files and test the app (don't forget to enter the api key in the settings of the app)
+8. Once you are you are happy with your result you can comit and push everything to a new branch of your forked project
+9. If you want to create a pull request you can do that on the github page of your forked project
+    - github automatically offers you that option once you've made changes to your forked project

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present doej1367 and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,28 @@
+![icon](screenshots/screenshot_icon.png)
+
+# HyBlockUtils: An Android App for Hypixel SkyBlock
+An Android app containing a collection of useful tools for Hypixel SkyBlock
+
+![icon](screenshots/screenshot_app_pages.png)
+
+## Pages
+- **Main Menu**
+- **Profile Viewer**  - personal and search
+- **Calender**        - showing upcoming events in the next 48 hours in two columns
+- **Notifications**   - for next Dark Auction and other important events like Spooky Festival, etc.
+- **Bazaar**          - list of all items and prices sorted by category name
+- **AH Price Lookup** - search through all ah items names and lore using space separated keywords; double quotes for grouping
+- **Settings**        - API key, personal user name and an option to limit the ah page requests to 10 instead of the full 70
+
+## First Steps
+1. **API Key**            - look up your hypixel api key or enter `/api` in-game to create a new one
+2. **API Settings**       - go to the gear icon in the top right corner and enter your API key
+3. **User Name Setting**  - go to the gear icon in the top right corner and enter your or any other user name (for the quick access)
+4. Done
+
+## Requirements
+- Most versions of Android (API level 16 and higher)
+    - tested with API level 16-emulated (Jelly Bean 4.1), 17-emulated (Jelly Bean 4.2), 22-emulated (Lollipop 5.1), 23-physical (Marshmallow 6.0), 25-emulated (Nougat 7.1) and 30-physical (Android 11)
+
+## Credits
+TheNullicorn - for this amazing NBT parsing lib https://github.com/TheNullicorn/Nedit