Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/butr/bannerlord.changelogparser
Simple tool that parses a custom changelog format inspired by Factorio.
https://github.com/butr/bannerlord.changelogparser
bannerlord mount-and-blade-bannerlord tool
Last synced: 9 days ago
JSON representation
Simple tool that parses a custom changelog format inspired by Factorio.
- Host: GitHub
- URL: https://github.com/butr/bannerlord.changelogparser
- Owner: BUTR
- License: mit
- Created: 2020-06-23T22:18:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-07T11:44:27.000Z (over 1 year ago)
- Last Synced: 2024-12-25T02:22:28.487Z (9 days ago)
- Topics: bannerlord, mount-and-blade-bannerlord, tool
- Language: C#
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bannerlord.ChangelogParser
Simple tool that parses a custom changelog format inspired by Factorio.
### Requirements
Requires BUTR GitHub Package Registry to be added.
```shell
nuget sources add -name "BUTR" -Source https://nuget.pkg.github.com/BUTR/index.json -Username YOURGITHUBUSERNAME -Password YOURGITHUBTOKEN
```
### Installation
```shell
dotnet tool install -g Bannerlord.ChangelogParser
```
### Example
When installed as a global tool:
```shell
bannerlord_changelog_parser latestversion -f "$PWD/changelog.txt"
bannerlord_changelog_parser description -f "$PWD/changelog.txt"
bannerlord_changelog_parser description -v "3.1.0" -f "$PWD/changelog.txt"
bannerlord_changelog_parser fulldescription -f "$PWD/changelog.txt"
bannerlord_changelog_parser fulldescription -v "3.1.0" -f "$PWD/changelog.txt"
bannerlord_changelog_parser gameversion -f "$PWD/changelog.txt"
bannerlord_changelog_parser gameversion -v "3.1.0" -f "$PWD/changelog.txt"
```
Check [this](https://github.com/Aragas/Bannerlord.MBOptionScreen/blob/700eb1dd1aec531cfaac242f8273c7a5d58ca6e0/.github/workflows/test-and-publish.yml#L255-L276) for a workflow example.
### Changelog Format
```txt
---------------------------------------------------------------------------------------------------
Version: 3.1.10
Game Versions: e1.4.0,e1.4.1,e1.4.2
* Fixed GroupToggle in Fluent API
* Better Prefab loading
* Fixed Ctrl+V in Edit Box
* Fixed 'random' crash in Edit Box
---------------------------------------------------------------------------------------------------
Version: 3.1.9
Game Versions: e1.4.0,e1.4.1,e1.4.2
* Fixed Group translation bug
* Fixed Fluent API settings loading
* Fixed XML settings reading
---------------------------------------------------------------------------------------------------
```
### fulldescription command output
```txt
For e1.4.0/e1.4.1/e1.4.2
* Fixed Group translation bug
* Fixed Fluent API settings loading
* Fixed XML settings reading
```