README.md

SWMHook

SWMHook is a spigot plugin that utilize SlimeWorldManager for generating template world as an arena for several plugins.
Explore the docs »

Download from GitHub · Report Bug · Request Feature · Discord Support

Table of Contents

1. About SWMHook
2. Supported Arena Provider
3. Getting Started
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact

About SWMHook

SWMHook is a spigot plugin that lets you use the SlimeWorldManager generated template world as an arena for several plugins.

More showcase coming soon :)

(back to top)

Supported Provider

Click here to view all available SWMHook Providers.

More providers will be available soon.

(back to top)

Getting Started

This is an example of how you may give instructions on installing SWMHook in on your server. To get a local copy up and running follow these simple example steps.

Installation

1. Download SWMHook
2. Put SWMHook-VERSION.jar in your plugin folder
3. Start your server
4. After SWMHook files is generated, you would need to configure your worlds in worlds.yml
5. Restart your server after finishing configuration

(back to top)

Usage

1. Create a arena with the supported provider.
2. Finish the arena setup; for example, spawn point, corners, etc.
3. Save the arena but don't enable it just yet (Different provider may vary)
4. Add your SWM world in worlds.yml or use command /swmhook add
5. Restart your server
6. Check if the arena is correctly loaded

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(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)

Support my project

If you want to support future development of SWMHook or this plugin helped you a lot.

Don't forget to give it a star or buy me a coffee in ko-fi.com!

Appreciate for all your support! :)

(back to top)

License

Distributed under the Apache-2.0 license. See LICENSE for more information.

(back to top)

Contact

Discord Support

Project Link: https://github.com/HappyAreaBean/SWMHook

(back to top)