{"id":15510316,"url":"https://github.com/haggen/bannerlord-module-template","last_synced_at":"2025-08-12T00:11:53.649Z","repository":{"id":56691448,"uuid":"255076621","full_name":"haggen/bannerlord-module-template","owner":"haggen","description":"Template of a module for Mount \u0026 Blade II Bannerlord.","archived":false,"fork":false,"pushed_at":"2023-12-28T11:55:06.000Z","size":21,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-10T08:34:33.083Z","etag":null,"topics":["bannerlord","csharp","game-mod","mount-and-blade"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haggen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-12T12:22:45.000Z","updated_at":"2024-06-24T05:46:54.000Z","dependencies_parsed_at":"2023-12-28T13:08:41.672Z","dependency_job_id":null,"html_url":"https://github.com/haggen/bannerlord-module-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/haggen/bannerlord-module-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haggen%2Fbannerlord-module-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haggen%2Fbannerlord-module-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haggen%2Fbannerlord-module-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haggen%2Fbannerlord-module-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haggen","download_url":"https://codeload.github.com/haggen/bannerlord-module-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haggen%2Fbannerlord-module-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269976970,"owners_count":24506496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bannerlord","csharp","game-mod","mount-and-blade"],"created_at":"2024-10-02T09:47:40.618Z","updated_at":"2025-08-12T00:11:53.624Z","avatar_url":"https://github.com/haggen.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ExampleModule\n\n\u003e Example of a module for Mount \u0026 Blade II Bannerlord.\n\n---✂️--- Below is the instruction for the module template, remove before release. ---✂️---\n\n# Getting Started\n\nThis repository is a starting point for developing your own module (mod) for Mount \u0026 Blade II Bannerlord with **MSBuild**, **.NET Core SDK** and **VSCode** but **without Visual Studio**. If you're new to software development in general I suggest you follow [a more straightforward guide](https://docs.bannerlordmodding.com/_tutorials/basic-csharp-mod), this one's a bit more involved.\n\nFrom a clean Windows installation you'll need:\n\n1. [Git](https://git-scm.com/download/win)\n2. [VSCode](https://code.visualstudio.com/download)\n3. [Build Tools for Visual Studio](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools\u0026rel=16)\n\nFollow the links to download the software, and install everything.\n\nOn the Visual Studio Installer window you should select **Individual Components** and then pick these:\n\n- .NET Core SDK\n- .NET Framework 4.7.2 targeting pack\n\nOnce everything is installed, launch VSCode, install the most popular C# extension and follow any instructions.\n\nFinally clone this repository somewhere, open the folder in VSCode, replace every instance of the following, and you're good to go. Remember to rename the files as well.\n\n- `ExampleModule` with the actual module name.\n- `YourName` with, you guessed it, your name.\n\nHere's a rundown of the repository:\n\n- The `ExampleModule.csproj` is the entrypoint of the building process and holds all the details of your project.\n- The `env.xml` file holds any build configuration particular to your environment, like where the game's installed. It doesn't exist by default though, you have to create it from `env.example.xml`.\n- The module's files go into the `Module` directory. Everything there will be copied as-is to the final distributable folder, with just one exception...\n- The `SubModule.xml` will have macros, like `$(Name)` and `$(Version)` replaced with their actual value by the `PostBuild.ps1` script.\n- The `ExampleModuleSubModule.cs` is the entrypoint of your source code. The resulting DLL will also be copied into the final distributable folder by `PostBuild.ps1` script.\n- You build the project using the [MSBuild CLI](https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-command-line-reference?view=vs-2019). See the [Development section](#Development) below.\n\n---✂️--- Above is the instruction for the module template, remove before release. ---✂️---\n\n# Installation\n\nDownload the latest release from [Releases](releases) and extract into the `Modules` directory inside your game installation folder. e.g. `C:\\Steam\\steamapps\\common\\Mount \u0026 Blade II Bannerlord`.\n\nOpen the game launcher, enable the module and click Play.\n\n# Usage\n\n_Write instructions for the player..._\n\n# Development\n\nCopy `env.example.xml` to `env.xml` and edit the settings according to your environment. Watch out for the ampersand in XML files.\n\nThe `PostBuild.ps1` script will auto execute on successful builds, and assemble the final distributable folder of the module inside the `.\\dist` directory.\n\n## Debug\n\n```ps1\nPS C:\\\u003e dotnet build -c Debug\n```\n\nWhen you build in `Debug` configuration the `PostBuild.ps1` script will also copy the module folder in place and launch the game loading a bare minimum set of modules for a quick test run.\n\n## Release\n\n```ps1\nPS C:\\\u003e dotnet build -c Release\n```\n\nWhen you build in `Release` configuration the `PostBuild.ps1` script will also produce an archive in the `.\\dist` directory, specific to the version being built. That's what you upload to the internet.\n\nRemember to bump the version inside the `csproj` file, tag the commit--like this `v1.0.0`--and rebuild.\n\n# Legal\n\nMIT © 2020 YourName\n\nThis modification is not created by, affiliated with or sponsored by TaleWorlds Entertainment or its affiliates. The Mount \u0026 Blade II Bannerlord API and related logos are intelectual property of TaleWorlds Entertainment. All rights reserved.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaggen%2Fbannerlord-module-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaggen%2Fbannerlord-module-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaggen%2Fbannerlord-module-template/lists"}