PluginExample

Example C++ ASI plugin template for the Need for Speed: ProStreet server (bombd.exe).

---

📦 Downloads & Releases

Pre-compiled example plugin binaries (PluginExample.asi) and release packages can be downloaded directly from: 👉 https://weexnes.dev/project/PluginExample#artifacts

---

🚀 Features

• Clean C++ Event API: High-level callbacks for server events defined in bombd_hooks.h.
• Event Interception: Built-in hooks for OnServerInit, OnPlayerLogin, OnPlayerDisconnect, and OnGameCreated.
• Session Querying: Memory inspection routines for active game sessions, player details, and room settings.
• Configurable INI Support: Parses plugin settings directly from config.ini.
• OneDev CI/CD Pipeline: Complete .onedev-buildspec.yml specification for automated builds and releases.

---

🕹️ Requirements & Compatibility

Requires ProStreetServerASILoader (winmm.dll) installed alongside bombd.exe.

• Target Executable: bombd.exe
• Plugin Loader: ProStreetServerASILoader (winmm.dll)

---

🛠️ Installation & Usage

1. Download or build PluginExample.asi.
2. Ensure ProStreetServerASILoader (winmm.dll) is placed in ~/.OpenProStreet/ alongside bombd.exe.
3. Copy PluginExample.asi (and optional config.ini) into ~/.OpenProStreet/scripts/:

   cp build/PluginExample.asi ~/.OpenProStreet/scripts/
   cp config.ini ~/.OpenProStreet/scripts/

4. Start the server (e.g. ./OpenProStreetV start).

---

💻 Building from Source

Linux Cross-Compilation (MinGW-w64 x86)

# Install dependencies
sudo pacman -S cmake make mingw-w64-gcc python

# Run cross-build script
chmod +x build.sh
./build.sh

Output binary will be located in build/PluginExample.asi.

---

📜 License & Repository

• Repository: https://code.weexnes.dev/PluginExample
• Part of the Need for Speed: ProStreet Modding Ecosystem