Home

Welcome to the BattleBit API Runner repository! This project aims to provide a powerful and user-friendly way for server hosts and developers to customize and enhance their BattleBit Remastered game servers using modular components, similar to popular modding tools like uMod.

Check out the Hosting Guide or Module Creation Guide.

Table of content

• What Does BattleBit API Runner Do?
• Key Features
• Getting Started
• Join the Community

What Does BattleBit API Runner Do?

BattleBit API Runner is a tool that lets you tailor your BattleBit Remastered server to your exact specifications. It acts as a bridge between your server and a collection of customizable modules. These modules, which are written in C# (.cs) files, allow you to modify and extend various aspects of your server's gameplay, mechanics, and features.

Key Features

• Modularity: The heart of the project lies in its modular design. This means you can mix and match various modules, creating a unique gameplay experience for your community. Modules can range from simple admin tools and commands to entirely new game modes.

• Easy Customization: You don't need to be an expert developer to create or use modules. With a basic understanding of C# programming, you can easily craft your own modules or integrate existing ones.

• Community Sharing: Imagine having access to a library of modules created by other enthusiasts. With BattleBit API Runner, you can share your modules with others and explore the creations of fellow gamers, enhancing the game for everyone.

• Server Hosters: If you're a server hoster, this tool lets you offer a curated experience to your players. Choose from a variety of modules to cater to different player preferences and styles.

• Developers: As a developer, this platform offers a convenient way to contribute to the community. Create modules that introduce new features, provide functionality, or simply enhance the game in unique ways.

Getting Started

To get started with the BattleBit API Runner, watch the hosting or programming tutorial or follow these simple steps:

1. Download the latest release from the Releases page of this repository.
2. Extract and run the program (BattleBitAPIRunner.exe on Windows or dotnet BattleBitAPIRunner.dll on Linux) to set up the community server API listener. This is where your BattleBit Remastered server can connect to for customization.
3. Explore existing modules in the Modules Repository and integrate them into your server.
4. Start creating your own modules in C# (.cs) files. Check out the Module Creation Guide for helpful tips and guidelines.
5. Share your modules and experiences with the community to help expand the customization options for all players.
6. Check out the documentation for more information on hosting or developing with the BattleBit API Runner.

Join the Community

We're excited to see the BattleBit API Runner community grow. Join us on Discord to connect with other server hosts, developers, and gamers. Share your creations, ask questions, and collaborate on making BattleBit Remastered an even more engaging experience!