Simple Patch Notes - Display patch notes in-game with ease

# Simple Patch Notes

TLDR: Please refer to the video below:

Youtube:





Discord server: https://discord.gg/SGEVmyJvQG

A professional and feature-rich patch notes system for Minecraft 1.21.1 Paper/Purpur servers.

## ✨ Features

- **In-Game GUI**: Beautiful chest-based interface for viewing patch notes
- **Written Books**: Players receive actual written books with patch note content
- ⏱️ **Cooldown System**: Configurable cooldown between claims (with admin bypass)
- **Clickable Links**: Support for clickable URLs in books
- **Fully Customizable**: Every message, item, and color is configurable
- **Pagination**: Automatic pagination for multiple patch notes
- **Auto-Formatting**: Books automatically format to fit Minecraft's page limits - Doesn't matter how long your text is!
- **Update Checker**: Built-in GitHub update notifications
- ⚡ **Performance Optimized**: Async operations and caching
- **Exploit-Free**: Proper permission checks and validation

## Requirements

- Minecraft 1.21.1 (Paper or Purpur)
- Java 21

## Installation

1. Download the latest `SimplePatchNotes.jar` from [Releases]( https://github.com/kolen/simplepatchnotes/releases)
2. Place the JAR file in your server's `plugins/` folder
3. Restart your server
4. Configure the plugin in `plugins/SimplePatchNotes/config.yml`
5. Add patch note files to `plugins/SimplePatchNotes/patchnotes/`

## Creating Patch Notes

Create YAML files in the `plugins/SimplePatchNotes/patchnotes/` folder. Example:

### File Structure

- **name**: Display name in GUI (optional, defaults to filename)
- **content**: List of text lines for the book description (supports `&` color codes)
- **link**: Optional clickable URL in the book
- **timestamp**: Unix timestamp in milliseconds (optional, defaults to file modification time)
- **priority**: Higher numbers appear first (optional, defaults to 0)

## Commands

| Command | Description | Permission |
|---------|-------------|------------|
| `/patchnotes` | Opens the patch notes GUI | `patchnotes.use` |
| `/patchnotes help` | Shows help menu | `patchnotes.use` |
| `/patchnotes info` | Shows plugin information | `patchnotes.use` |
| `/patchnotes reload` | Reloads configuration | `patchnotes.reload` |

**Aliases**: `/pn`, `/patch`, `/patches`, `/updates`

## Permissions

| Permission | Description | Default |
|------------|-------------|---------|
| `patchnotes.use` | Allows viewing patch notes | Everyone |
| `patchnotes.admin` | Bypass cooldowns | OPs |
| `patchnotes.reload` | Reload configuration | OPs |

## ⚙️ Configuration

The `config.yml` file allows you to customize:

- GUI title, size, and layout
- Navigation arrow items
- Book appearance and content
- Cooldown duration
- Update checker settings
- Performance options
- All messages and colors

## Update Checker

The plugin can automatically check for updates on GitHub:

1. Set `update-checker.enabled: true` in config.yml
2. Configure your GitHub username and repository
3. The plugin will notify admins when updates are available

## ️ Building from Source

### Prerequisites
- Java 21 JDK
- Maven or Gradle

### Using Maven
```bash
mvn clean package
```

### Using Gradle
```bash
./gradlew build
```

The compiled JAR will be in `target/` or `build/libs/`.

## Performance

- **Async Loading**: Patch notes load asynchronously to prevent lag
- **Caching**: Files are cached in memory to reduce disk I/O
- **Optimized GUI**: Efficient inventory management
- **No Database**: Simple file-based system

## Reporting Issues

Found a bug? [Open an issue]( https://github.com/KolenMG/SimplePatchNotes/issues) on GitHub with:
- Minecraft version
- Server software (Paper/Purpur)
- Plugin version
- Steps to reproduce
- Any error messages

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Support

If you find this plugin useful, please:
- ⭐ Star the repository
- Report bugs
- Suggest features
- Share with others

## Contributing

Contributions are welcome! Please:
1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

---

Made with ❤️ for the Minecraft community