Skip to content

Commit 0b45033

Browse files
committed
Updated: The Changelog Template
1 parent 3ef70d9 commit 0b45033

1 file changed

Lines changed: 62 additions & 35 deletions

File tree

changelog-template.hbs

Lines changed: 62 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,91 @@
1-
If you are updating from version less than 1.28, install the following first
1+
[Read and Discuss in a Browser](https://github.com/Reloaded-Project/Reloaded-II/discussions/473).
2+
[Previous Changelog](https://github.com/Reloaded-Project/Reloaded-II/releases/tag/1.28.8).
23

3-
- [.NET 9 x64 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-9.0.0-windows-x64-installer)
4-
- [.NET 9 x86 Desktop Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-9.0.0-windows-x86-installer)
4+
This release consists of community contributions; cleaned up and merged into the main project.
55

6-
---------
6+
## User Friendly Enums by @RyoTune
77

8-
[Read and Discuss in a Browser](https://github.com/Reloaded-Project/Reloaded-II/discussions/473).
9-
[Previous Changelog](https://github.com/Reloaded-Project/Reloaded-II/releases/tag/1.28.7).
8+
Thanks to @RyoTune it is now possible to give 'enums' user friendly named in mod configs;
9+
before you had:
1010

11-
# 1.28.8: A set of Bug fixes from @RyoTune
11+
```csharp
12+
public enum SampleEnum
13+
{
14+
NoOpinion,
15+
Sucks,
16+
IsMediocre,
17+
IsOk,
18+
IsCool,
19+
ILoveIt,
20+
}
21+
```
1222

13-
A fix for drag/drop:
23+
Which produced
1424

15-
- Fixed: Drag and Drop now works everywhere on the main window for installing mods.
25+
![image](https://github.com/user-attachments/assets/b0e7dba7-4380-4e09-b162-1088f496856d)
1626

17-
And various improvements to the `Edit Mod` dialog:
27+
With the new addition, it's now possible to add user friendly names to each configuration item:
1828

19-
- Fixed: `unknown apps` (games not added to Reloaded) being removed after a mod is edited via the GUI.
20-
- Added: Mods can now add support for `unknown apps` (games not added to Reloaded) via the UI.
21-
- Fixed: The view filter (search) in the `Edit Mod` dialog is reset on switching pages.
22-
- Added: You can now see the `AppId` of enabled games in the `Edit Mod` dialog.
29+
```csharp
30+
public enum SampleEnum
31+
{
32+
[Display(Name = "No Opinion 🤷")]
33+
NoOpinion,
34+
[Display(Name = "It's Sucks! 👎")]
35+
Sucks,
36+
[Display(Name = "It's mediocre 😐")]
37+
IsMediocre,
38+
[Display(Name = "It's okay! 👍")]
39+
IsOk,
40+
[Display(Name = "It's cool! 😎")]
41+
IsCool,
42+
[Display(Name = "I Love It!!! ❤️🔥")]
43+
ILoveIt,
44+
}
45+
```
2346

24-
And lastly, the default NuGet feed has been updated to https://packages.sewer56.moe/v3/index.json,
25-
in both the documentation and program.
47+
![image](https://github.com/user-attachments/assets/c99a1ed1-6b3d-4fa6-928b-b2fecfe2a460)
2648

27-
# 1.28.7: Fix Crash on Load Ordering with Keyboard/Controller
49+
## Explicit Item Ordering by @RyoTune
2850

29-
Moving a mod that was already at the end of the list further down (out of bounds) led to a crash.
51+
![image](https://github.com/user-attachments/assets/466ffc2c-ed19-4ec7-bf05-43d054fbd0e4)
3052

31-
This was somehow overlooked by everyone for years; it's fixed now.
53+
```csharp
54+
[Display(Order = 0)]
55+
public int OrderFirst { get; set; }
3256

33-
# 1.28.6: Path/Location Warnings & Minor Theme Adjustment
57+
[Display(Order = 1)]
58+
public int OrderSecond { get; set; }
3459

35-
- @dreamsyntax added [warnings for when Reloaded and/or the `Mods` folder are placed in OneDrive](https://github.com/Reloaded-Project/Reloaded-II/pull/518), or are placed in a special path.
60+
[Display(Order = 2)]
61+
public int OrderThird { get; set; }
62+
```
3663

37-
![image](https://github.com/user-attachments/assets/7ad44f76-8565-4684-9d03-33cb6fd1dde3)
64+
Lower order means items come first.
3865

39-
![image](https://github.com/user-attachments/assets/f9d3460c-1f6e-4bad-bf9f-a98040fbc8d5)
66+
Do note that this is inverted from the original PR; so if you originally wrote your mod against [Reloaded II.5 ReMIX](https://github.com/RyoTune/Reloaded-II.5) fork, it may be the opposite to what you expected.
4067

41-
OneDrive you want to avoid for performance reasons.
42-
Special paths you want to avoid because some games don't support them well. Some games may fail to load custom assets out of the mod folders; Reloaded now warns about this indiscriminately.
68+
## Launcher Error Reporting by @TheBestAstroNOT + @Sewer56
4369

44-
- @dreamsyntax added [a warning for when a game is places in a path with a special folder](https://github.com/Reloaded-Project/Reloaded-II/pull/516).
70+
![image](https://github.com/user-attachments/assets/83be5235-d6ee-46ee-932d-a2af6cf88c7e)
4571

46-
![image](https://github.com/user-attachments/assets/a3c0ff36-1231-4149-92f2-e96564ff7417)
72+
Launcher errors now give you the option to print the error details to a text file.
4773

48-
Same as above. Sometimes people download old games through 'mysterious ways', place them in a special location and try to mod them before trying even an unmodded game. This way they'll hopefully know that the path may be a problem.
74+
![image](https://github.com/user-attachments/assets/4ebf6b82-498d-4c35-b7b0-01870389dc12)
4975

50-
- @dreamsyntax made [a small adjustment on the UI colours](https://github.com/Reloaded-Project/Reloaded-II/issues/500).
76+
Hopefully this is a bit friendlier for end users 🤞.
5177

52-
Before:
78+
## Improved Missing Loader Error by @TheBestAstroNOT + @Sewer56
5379

54-
![image](https://github.com/user-attachments/assets/753085f5-ad64-4a6b-81d5-d7e9990eca3c)
80+
Sometimes users do the following:
5581

56-
After:
82+
- Use the `Deploy ASI Loader` feature in Reloaded, and then uninstall Reloaded.
83+
- Use the `Deploy ASI Loader` feature and then move the Reloaded folder.
5784

58-
![image](https://github.com/user-attachments/assets/378730d5-f92c-4525-a2b3-738db59060b1)
85+
![image](https://github.com/user-attachments/assets/24d4bb31-ee41-4bd0-8046-f5619a6d513d)
5986

60-
In the interest of accessibility, and people using monitors with interesting contrast ratios; the following adjustment above was made.
61-
The Reloaded theme was originally made on a cheap TN panel; however for some IPS displays and beyond, this change makes a lot of sense.
87+
The error message for missing Mod Loader DLL was updated to account for these situations.
88+
The user is now explicitly let known how to resolve the error.
6289

6390
------------------------------------
6491

0 commit comments

Comments
 (0)