-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Description
🎯 Objective
Establish the initial repository structure and configure the MelonLoader mod environment for Multibonk.
This will provide the foundation for future development, including networking, synchronization, and UI systems.
🗓️ Scope
- Create the GitHub repository:
multibonk/Multibonk - Initialize base .NET 6.0 project compatible with MelonLoader (Unity IL2CPP).
- Configure build environment and dependencies.
- Implement base
Multibonk.csentry point. - Add essential project files:
.gitignorefor .NET and Unity.README.mdwith project overview.LICENSE(MIT recommended).docs/folder for documentation..editorconfigfor consistent code style.
- Verify mod loads correctly in Megabonk with a simple “Hello from Multibonk” log message.
- Set up basic dependency injection container using
Microsoft.Extensions.DependencyInjection.
🧩 Deliverables
| File/Folder | Description |
|---|---|
Multibonk/Multibonk.csproj |
Main project definition (.NET 6.0) |
Multibonk/Multibonk.cs |
MelonMod entry point |
Multibonk/Properties/AssemblyInfo.cs |
Metadata for mod |
docs/general.md |
Overview and mod goals |
.gitignore |
Ignore Unity and build artifacts |
.editorconfig |
Code style consistency |
LICENSE |
MIT license |
README.md |
Repo introduction and setup instructions |
✅ Acceptance Criteria
- Repository is public and accessible on GitHub.
- Mod compiles successfully using MelonLoader in the current Megabonk version.
- Game logs display “Multibonk initialized” at launch.
- Project structure matches the expected folder organization.
- Code follows
.editorconfigconventions. - Documentation includes setup instructions for developers.
📘 Additional Notes
- Recommended project naming:
- Namespace:
Multibonk - Main entry class:
Multibonk : MelonMod
- Namespace:
- Ensure that MelonLoader version matches Megabonk’s IL2CPP build.
- Commit message convention:
feat(setup): initial project creation - Example verification log in Megabonk console:
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels