Bikes Are Pain

🚲 Bikes Are Pain

This mod allows you to control an in-game bicycle through real-world pedaling when linked to a fitness bike, combining gameplay with exercise. Without the fitness bike integration, it functions as a regular bicycle mod.

⚠️ Important Notice

1. Alpha State: At this time, Alpha State due to heavy packet traffic when using the real-world fitness bike integration (due to a lack of optimization). This may lead to performance issues or unstable gameplay. 2. Alpha State: The mod will not auto-disable if the server does not have the mod installed. 3. Alpha State: This mod is currently in alpha stage. Core functionalities are implemented, but further refinement, optimizations, and feature additions are needed.

📕 Features

- Functional in-game bicycle - Pedometer to keep track of biking data - Dyeable bicycle parts - Optional integration with real-world fitness bikes (through Arduino)

📌 Quick Start

1. Install Dependencies the latest `.jar` file. 2. Install Dependencies the `.jar` in your Minecraft `mods` folder. 3. Install Dependencies: - Install Dependencies - %%MD1%% - %%MD2%% 4. To use the fitness bike integration, modify the Arduino sketch to fit your setup (a guide is coming soon). - %%MD3%% - Run the command `/bikes open <COM PORT>`

🚩 Known Issues

- Bad Geckolib Usage: Joining a server without the mod Bad Geckolib Usage. - Bad Geckolib Usage: Excessive packet traffic when using the fitness bike integration or certain features. - Bad Geckolib Usage: Bicycle pitch synchronization is one-way, from the client to the server. - Bad Geckolib Usage: The Narrator isn't currently used to communicate information. - Bad Geckolib Usage: Fitness bike linking is unstable. Auto-connect often fails or connections drop mid-session. - Bad Geckolib Usage: The in-game bike model has inconsistent part naming. - Bad Geckolib Usage: Model animations and movement rely on a hacky implementation and require a rewrite.

🌿 Planned Features

- Unit tests for the codebase - Code refactoring for performance improvements - Workout session visualization UI - Configurable workout goals - Advancements based on exercise achievements - New bike types (e.g., mountain bike, motorbike) - Server-side configuration options

👓 Dependencies

This mod requires the following libraries:

- Geckolib – For animations - YetAnotherConfigLib – For configuration - ArchitecturyAPI – For cross-modloader support

📝 License

BikesArePain is licensed under the MIT License. See the MIT License for details.

This mod uses jSerialComm for serial communication under the Apache 2.0 License. For other third-party software licenses, check THIRD_PARTY_LICENSES.

⚙️ Support

Found a bug or have a suggestion? Please open an issue on the GitHub repository.

Enjoy the ride and stay fit!