Module Template for Visual Studio and dotnet

Currently viewing this thread:

Aragas

Recruit
M&BWBWF&SNW
Template extension for dotnet, eases the process of creating new mods for M&B 2: Bannerlord.

This is another Module Template for Bannerlord. Just like dealman's template, it can work with Visual Studio, but it's based on the new dotnet template system instead of the classic .vsix extension system.
It has all the features of dealman's template (except the Readme.txt) and more!

Link to the GitHub repository.

unknown.png


Installation
  1. Install the latest .NET Core SDK.
  2. Run `dotnet new --install Bannerlord.Templates` to install the project templates. to install the project templates.


Creating a new Module
Creating from command line:
  1. Choose a project template i.e. `blmodfx`.
  2. Run `dotnet new blmodfx --help` to see how to select the feature of the project.
  3. Run `dotnet new blmodfx --name "Bannerlord.MyModule"` along with any other custom options to create a project from the template.
Creating via Visual Studio
You need to have at least an 16.8.x version to create the template!
You also need to use the new template feature:
clitemplates-option-enable.png



FAQ
What 'Target Framework' should I chose?
If you plan on using Harmony or WinForms, use `.NET Framework 4.7.2`. If not, you can chose `.NET Standard 2.0`.

What are the differences between 'soft-dependency' and 'hard-dependency?
Hard dependency means that an entry will be added to `SubModules.xml`. Your Module will not include the dependency inside it's `/bin` folder (the .dll). It won't allow the game to run your mod without the dependency installed as a separate Module. This is an important feature to prevent having multiple versions of the same dependency running within the game.
Soft dependency means that nothing will be added to `SubModules.xml`. Your Module will include the dependency inside it's `/bin` folder (the .dll).

What is this variable 'Bannerlord Game Folder Location'?
`$(BANNERLORD_GAME_DIR)` is an environment variable. We think that it would be best to set it once on the system instead of hardcoding the game path in the project.
Feel free to replace it with a full folder path like `C:\Program Files (x86)\Steam\steamapps\common\Mount & Blade II Bannerlord` if you don't want to use the environment variable.

What is this variable 'Module Name'?
`$(MSBuildProjectName)` is a MSBuild built-in variable that returns the file name of the project file without the file name extension; for example, `Bannerlord.Module1`.
If you don't plan on keeping the Module folder name the same as the project that is being created, override it.

What is this variable 'Language Version'?
The version of C# that is used. By default, the value is `9.0`, which is the latest currently.

Should I set 'Use Nullable Feature'?
Read the docs on Nullable reference types to decide if you need this feature!

What are those '$SOMETHING$' variables inside SubModules.xml?
Those are variables that will be replaced with real values when the project is built.
  • $modulename$ is the varible you passed in `Module Name` when creating the Module. It is the `<ModuleName>` property used in your project file (`.csproj`)
  • $version$ is the `<Version>` property used in your project file (`.csproj`)

What is the '\_Module' folder inside the project?
It is the root Module folder that copies everything that is placed there inside the output.

I build my project and a folder with my Module was created in `GAMEPATH/Modules`!
This is one of the features that this project template provides.
If the `<ModuleName>` and `<GameFolder>` properties are valid, your Module will be copied in the game's `/Modules` folder automatically. You can test your Module without the need of creating a script that will move everything inside the game's Modules folder.
 
Last edited:
Top Bottom