Skip to content

Commit 3dda67c

Browse files
committed
Updated: Template Mod & Changelog Template
1 parent 2839b6a commit 3dda67c

File tree

2 files changed

+48
-21
lines changed

2 files changed

+48
-21
lines changed

changelog-template.hbs

Lines changed: 47 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,60 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## Release (1.23) Highlights
8+
## Release (1.24) Highlights
99

10-
This release focuses on memory and load speed optimisations.
10+
This is a very small feature update mostly consisting of community PRs.
1111

12-
***Launcher Changes***:
13-
- Added: Support for assigning tags to mods, mods can now use tags to help end users filter their mod collection.
14-
- This includes support for some automated tags, e.g. `Has Code Injection`.
12+
### Custom Controls for Mod Configurations
1513

16-
- Fixed: Bug that prevented users from selecting other mods after updating a mod in `Edit Mod` menu.
14+
@jroweboy added the ability additional controls developers can use in their mods ![image](https://user-images.githubusercontent.com/952515/227748620-6b25b471-12c9-461b-9c8b-d387a716d54f.png);
1715

18-
***Space and Memory Related Changes***:
19-
- Changed: Loader now uses hooking functionality from `Reloaded.SharedLib.Hooks` mod, as opposed to including its own hooking library. (Saves ~1.4MiB)
20-
- Changed: Bootstrapper library now dynamically links with Visual C++ Runtime using custom build of .NET Runtime's `libnethost`. (Saves ~300KiB)
21-
- Removed: JSON parser from boostrapper, now uses Environment Variables (Saves ~200KiB)
22-
- Added: Full GC After Loader Initialisation. In practice most mods idle outside the occasional hooks.
23-
- Mods can now use `ExcludeAssets="runtime"` in NuGet PackageReference(s) to not unnecessarily include DLLs from interfaces/DI packages.
16+
The 3 new custom controls are:
17+
```
18+
Slider: Horizontal Slider with an optional textbox to display the value
19+
FilePicker: Textbox with a button to open a `OpenFileDialog`.
20+
FolderPicker: Textbox with a button to open a custom `FolderSelectDialog`.
21+
```
2422

25-
***Load Speed Related Changes***:
26-
- Changed: Mod loading logic/model now is singlethreaded (again) but with merged preparing and initialising step. Will not interface/DI DLLs unused at runtime from disk.
27-
- Added: Mod loader now caches whether mods can unload and/or have exports as part of `ModConfig.json`.
28-
- This change is what allows for preparing and initialising to be done in one step.
23+
Example usage:
2924

30-
***CI/CD***
31-
- Builds produced by CI should now hopefully be more deterministic.
25+
```csharp
26+
[DisplayName("Int Slider")]
27+
[Description("This is a int that uses a slider control similar to a volume control slider.")]
28+
[DefaultValue(100)]
29+
[SliderControlParams(/* Settings here */)]
30+
public int IntSlider { get; set; } = 100;
3231

33-
***Other***
34-
- Loader: Now prints unsuccessful attempts at calls to GetController API.
32+
[DisplayName("Double Slider")]
33+
[Description("This is a double that uses a slider control without any frills.")]
34+
[DefaultValue(0.5)]
35+
[SliderControlParams(minimum: 0.0, maximum: 1.0)]
36+
public double DoubleSlider { get; set; } = 0.5;
37+
38+
[DisplayName("File Picker")]
39+
[Description("This is a sample file picker.")]
40+
[DefaultValue("")]
41+
[FilePickerParams(title:"Choose a File to load from")]
42+
public string File { get; set; } = "";
43+
44+
[DisplayName("Folder Picker")]
45+
[Description("Opens a file picker but locked to only allow folder selections.")]
46+
[DefaultValue("")]
47+
[FolderPickerParams(/* Settings here */)]
48+
public string Folder { get; set; } = "";
49+
```
50+
51+
### Added Localization for Traditional Chinese (TW)
52+
53+
@EditorKos contributed a localization for `zh-TW` locale.
54+
55+
### Fixes
56+
57+
- Mod Packs can now use custom `ReleaseMetadataFileName(s)`. (thanks @jroweboy)
58+
- Mods from GameBanana which specify custom additional contributors/authors no longer breaks mod search.
59+
- GameBanana (probably unintentionally) made a change to how one of the fields is returned.
60+
- And that broke things... so I added a workaround.
61+
- I also need to update the cache server; please give it a moment after the update goes live.
3562

3663
## Complete Changes
3764

source/Reloaded.Mod.Template/Reloaded.Mod.Template.NuGet.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<PropertyGroup>
44
<PackageType>Template</PackageType>
5-
<PackageVersion>1.5.0</PackageVersion>
5+
<PackageVersion>1.6.0</PackageVersion>
66
<PackageId>Reloaded.Mod.Templates</PackageId>
77
<Title>Reloaded-II Mod Templates</Title>
88
<Authors>Sewer56</Authors>

0 commit comments

Comments
 (0)