diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8726120 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Jakob Hansen + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c9b774 --- /dev/null +++ b/README.md @@ -0,0 +1,130 @@ + + + + +
+
+

Randomized Minigames

+ +

+ This spigot plugin adds a couple of Minigames to Minecraft all based on some sort of randomization. Currently working are two different types of Force Item Battles, a type of minigame where each player has to aquire an item faster than the others. +
+ Explore the docs » There, sadly, are no docs yet. +
+
+ Report Bug + · + Request Feature +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgments
    9. +
+
+ + + + +## About The Project + + + +I got inspired by a streamer and youtuber who plays these kinds of Minigames (BastiGHG). The plugin aims to bring many of these games to his audience and maybe some other people who are interested. There are multiple in-game GUIs that are used for various actions including each part of the setup. +

(back to top)

+ + + + +### Installation +As every Spigot Plugin +1. Download the newest .jar file in the Releases-Tab +2. Place the .jar file inside your Spigot-Server's plugins-folder +3. Enjoy + +

(back to top)

+ + + + +## Usage + +`/minigames` - Opens a GUI of all available Minigames.
+`/minigames killall`- Kills all minigames currently running, will be removed in the future since it shouldn't be necessary
+ + + +## Roadmap + +- [ ] Fully implementing Force-Item-Battle Team variant +- [ ] Add another minigame, not sure which atm +- [ ] Make the GUI easier to work with +- [ ] Adding usefull JavaDocs +- [ ] probably other stuff I currently dont think about. + +

(back to top)

+ + + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ + + + +## License + +Distributed under the MIT License. See `LICENSE.md` for more information. + +

(back to top)

+ + + + + +## Acknowledgments + +* []() othneildrew for the amazing README template + +

(back to top)

+ + +