From 54b62d0739ad7237e06d8950ef8d3736237a50f7 Mon Sep 17 00:00:00 2001 From: Benjamin Cronin Date: Sun, 14 Jun 2020 14:45:29 -0700 Subject: [PATCH] update files for release --- KerbalChangelog.version | 4 +-- KerbalChangelogv2Changelog.cfg | 26 ++++++++++++++++++ LICENSE | 2 +- README.md | 49 +++++++++++----------------------- 4 files changed, 45 insertions(+), 36 deletions(-) diff --git a/KerbalChangelog.version b/KerbalChangelog.version index d5dfa12..5d2b493 100644 --- a/KerbalChangelog.version +++ b/KerbalChangelog.version @@ -11,8 +11,8 @@ "VERSION": { "MAJOR":1, - "MINOR":2, - "PATCH":1, + "MINOR":3, + "PATCH":0, "BUILD":0 }, "KSP_VERSION": diff --git a/KerbalChangelogv2Changelog.cfg b/KerbalChangelogv2Changelog.cfg index 6f09b32..df23103 100644 --- a/KerbalChangelogv2Changelog.cfg +++ b/KerbalChangelogv2Changelog.cfg @@ -4,6 +4,32 @@ KERBALCHANGELOG modName = Kerbal Changelog license = MIT author = Benjamin Cronin + website = github.com/BenjaminCronin/KerbalChangelog/releases + VERSION + { + version = 1.3.0 + versionDate = Jun 14, 2020 + versionKSP = 1.9.1 + CHANGE + { + type = Add + change = Add features suggested by zer0Kerbal + subchange = Add versionDate field for release date + subchange = Add versionKSP field for recommended KSP version + } + CHANGE + { + type = Add + change = Add features suggested by GitHub user mwerle + subchange = Add 'visit website' button + subchange = Add change grouping by type of change through the 'type' field in a CHANGE node + } + CHANGE + { + type = Change + change = Display high priority changes before others using the HighPriority setting in 'type' field + } + } VERSION { version = 1.2.1 diff --git a/LICENSE b/LICENSE index 1112369..2798519 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Benjamin Cronin +Copyright (c) 2020 Benjamin Cronin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 11c07b6..6c528c9 100644 --- a/README.md +++ b/README.md @@ -5,41 +5,24 @@ This project is meant to be a simple way for mod creators to add an ingame chang ## Adding a changelog To add a changelog, simply create a config file (.cfg) with the following nodes and fields (as an example): ``` -KERBALCHANGELOG +KERBALCHANGELOG //Required to have this name { - showChangelog = True //optional but strongly recommended (will be created if non-existant) - modName = Kerbal Changelog //required - license = MIT //optional - author = Benjamin Cronin //optional - - VERSION //Node(s) required for anything to show up - { - verison = 1.8 //optional but strongly recommended (will display as version D.N.E otherwise) - versionName = Audacious Apple //optional - CHANGE //required in order to utilize subchanges - { - change = Add features suggested by zer0Kerbal //required in a CHANGE node - subchange = Add new change nodes //optional, as many as you want - subchange = Add license field - subchange = Add author node - subchange = Add version naming field - } - change = Internal code rewrite to improve maintainability //change fields can be outside of CHANGE nodes, but order is not maintained - } - VERSION - { - version = 1.1.7 - CHANGE - { - change = Update for KSP 1.9 - } - CHANGE - { - change = Downgrade to .NET 4.5 for compatibility - } - } + showChangelog = True //To show the changelog, this must be set to True + modName = KerbalChangeLog //Add your mod's name here + VERSION //Declares a version node + { + version = 1.1 //Version number, numbers only with no spaces! + change = Fixed window scrolling //any changes in that version. There can be as many change fields as you want + change = Added shiny buttons + change = Removed bugs + } + VERSION + { + version = 1.0 + change = First release! + } } ``` This will then be outputted in a changelog window that appears in the space center view the first time the user loads a game with a changelog that has the `showChangelog` set to `True`. After this initial load, the user will no longer see the changelog for that mod until the mod creator releases a new version with the changelog cfg file's `showChangelog` field set to `True`. -KCL will handle as many mods as have changelogs the user has installed, but please do not create multiple changelog files for a single mod. This will lead to multiple changelog pages showing up in the window, and confusion for everyone. +This will handle as many mods as have changelogs the user has installed, but please do not create multiple changelog files for a single mod. This will lead to multiple changelog pages showing up in the window, and confusion for everyone.