A plugin introducing vanilla-based tweaks.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Stweaks is a Minecraft plugin developed for PaperMC servers. This plugin introduces various silly custom items, mechanic modifications and additional add-ons to make playing Vanilla a bit more fun.

Why Stweaks?

• We're looking to balance game time and promote more social gameplay through time-based mechanic implementations.
• We're looking to make our users laugh with inside-joke custom recipes that still add practical value to the game.
• We're looking to express ourselves both creatively through custom texturing, programming through datapacks, and scripting through plugin implementation.

Contributions, ideas, or feature requests are always welcome!

(back to top)

Built With

• — Core language used to develop the plugin.

• — Minecraft server API used for plugin development.

• — Build automation tool used for compiling and packaging.

• — Used for automatic code formatting during builds.

• — Windows batch scripting for automating plugin deployment.

• — Used for zipping assets and other deployment tasks.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

To build and deploy ks locally, ensure the following tools are installed:

• Java 21+ Required to compile and run the plugin.

• Gradle (or use the included gradlew wrapper)
  Used to build the project and apply formatting.

• PowerShell 5.1+ (for Windows users)
  Required for deployment zip compression.

• .env file in the project root
  Must define:

  SERVER_PATH=path\to\your\server
  RESOURCE_PATH=path\to\your\resourcepacks

Installation

1. Clone the repository locally.

2. Assuming the current structure of the project, you may add-on functionality right away.

3. For resource pack implementation, you can refer to the src/main/resources/st-respack folder.

4. For datapack implementation, you can refer to the src/main/resources'st-datapack folder.

5. The deploy.bat script, located in root, can be used to update the plugin, resource pack, and datapack respectively, assuming correct paths are provided in the .env file.

6. Run the following command in your terminal to enable project-specific Git hooks:

   ./set-hooks-path.sh

(back to top)

Roadmap

• Add Illegal Water
• Add Lebron James armor set
• Add FBI Disc
• Add Cow Skinner
• Add 1-hour Timer
• Add Nature Compass

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

Top contributors:

(back to top)

License

See LICENSE.txt for more information.

(back to top)

Contact

Nirav Patel - @Niravanaa - niravp0703@gmail.com

StoryTime Productions: Portfolio Link

(back to top)