💡 progreso

Table of contents

• Introduction
• Prerequisites
• Installation
• Launching IRC server
• Development
• Contributing
• License
• Contact
• Links

Introduction

Progreso is a Minecraft Utility Mod designed for anarchy servers. It offers a range of features to enhance gameplay and provide utility functions for players.

Prerequisites

• Java 21 or higher
• Docker and Docker Compose (for running the IRC server)

Installation

• Install fabric 1.21
• Download the latest release from releases or dev build from actions
• Place the downloaded jar file in the .minecraft/mods folder
• Launch Minecraft using the Fabric 1.21 profile

Launching IRC server

• Clone the repository
• Navigate to the project directory
• Rename .env.example to .env and set SERVER_PORT
• Run the following command to start the IRC server using Docker Compose:

  docker-compose up -d

• The IRC server will be available at ws://localhost:${SERVER_PORT}

Development

• progreso-api (source) - Api for progreso-client. Shouldn't interact with minecraft/modding api classes.
• progreso-client (source) - Client. Uses progreso-api as base.
• progreso-irc (source) - IRC server and client.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Make your changes
4. Commit your changes (git commit -m 'Add new feature')
5. Push to the branch (git push origin feature-branch)
6. Open a pull request

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE.md file for details.

Contact

For any questions or support, please open an issue on the GitHub repository.

Links

• progreso-plugin-template