Skip to content

RenaudRl/TypeWriter-Companion-Public

Repository files navigation

Companion Extension

Java Version Build Status Target

Companion Extension is an entity interaction module for TypeWriter, engineered for BTC Studio infrastructure. It enables the creation of intelligent companion NPCs that can follow players and interact with the environment.


🚀 Key Features

🤝 Companion System

  • Follow Mechanics: NPCs that intelligently follow their owners.
  • Environmental Interaction: Companions that can react to and interact with the world around them.

🧠 Entity Intelligence

  • TypeWriter Entity Integration: Built on top of the robust TypeWriter Entity module.
  • Behavioral Config: Highly configurable behaviors for diverse companion types.

⚙️ Configuration

Companion Extension configuration is managed via TypeWriter's manifest system.

🛠 Building & Deployment

Requires Java 21.

# Clone the repository
git clone https://github.com/RenaudRl/TypeWriter-Companion-Public.git
cd TypeWriter-Companion-Public

# Build the project
./gradlew clean build

Artifact Locations:

  • build/libs/Compagnion-[Version].jar

🤝 Credits & Inspiration

  • TypeWriter - The engine this extension is built for.
  • BTC Studio - Maintenance and specialized optimizations.

📜 License

Licensed under the MIT License.

Documentation

Full documentation available at BTC Studio Docs.