| Name | yaclog-ksp JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Kerbal Space Program changelog file generator |
| upload_time | 2024-10-18 01:34:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
changelog
commandline
markdown
ksp
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# yaclog-ksp
[](https://badge.fury.io/py/yaclog-ksp)
A command line tool based on [yaclog] for converting markdown changelogs to [KerbalChangelog] config files.
*Logo by Erin Cassidy*
## Installation
run `pip install yaclog-ksp`
## Usage
```
Usage: yaclog-ksp [OPTIONS]
Converts markdown changelogs to KSP changelog configs.
Options:
--path FILE Location of the changelog file. [default: CHANGELOG.md]
-o, --output FILE Output file to write to. Uses
'GameData/{name}/Versioning/{name}ChangeLog.cfg' by
default.
-n, --name TEXT The name of the mod. Derived from the current directory
by default.
--version Show the version and exit.
--help Show this message and exit.
```
for example, running `yaclog-ksp --path MyLog.md -n "My KSP Mod"`
would output to `GameData/MyKSPMod/Versioning/MyKSPModChangeLog.cfg`
Input files are in markdown, and use a certain syntax to be readable by the tool. Metadata is included in a table at the
top of the file (which row you make the header doesnt matter). Each version is an subheading with the version, an
optional date, and the KSP version as a tag on the end in brackets
#### Example Changelog:
```markdown
# Changelog
This is the changelog for my cool mod!
| modName | MyCoolMod |
| ------- | ------------- |
| license | CC-By-SA |
| website | Example.com |
| author | A cool person |
## 1.0.0 - 2020-04-16 [KSP 1.11]
First full release
### Fixed
- Nyan Cat now has correct music
### Added
- Multiplayer
## 0.9.1 [KSP 1.10.1]
Supported versions: 0.2.0 beta to 1.10.x
### Changed
A very complicated thing that I can't easily explain in bullet points,
but this paragraph works pretty well to get the point across!
- Another thing that has multiple specific items
- this bullet point
* and this other one
+ oh and another one!
### Removed
- Herobrine
```
[yaclog]: https://github.com/drewcassidy/yaclog
[KerbalChangelog]: https://github.com/HebaruSan/KerbalChangelog
Raw data
{
"_id": null,
"home_page": null,
"name": "yaclog-ksp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "changelog, commandline, markdown, KSP",
"author": null,
"author_email": "Andrew Cassidy <drewcassidy@me.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/ed/a605a4797f91f147dd6756ab7064fa1ca985246d4be1c8e0c858aa23c58d/yaclog_ksp-1.2.0.tar.gz",
"platform": null,
"description": "# yaclog-ksp\n\n[](https://badge.fury.io/py/yaclog-ksp)\n\nA command line tool based on [yaclog] for converting markdown changelogs to [KerbalChangelog] config files.\n\n\n\n*Logo by Erin Cassidy*\n\n## Installation\n\nrun `pip install yaclog-ksp`\n\n## Usage\n\n```\nUsage: yaclog-ksp [OPTIONS]\n\n Converts markdown changelogs to KSP changelog configs.\n\nOptions:\n --path FILE Location of the changelog file. [default: CHANGELOG.md]\n -o, --output FILE Output file to write to. Uses\n 'GameData/{name}/Versioning/{name}ChangeLog.cfg' by\n default.\n\n -n, --name TEXT The name of the mod. Derived from the current directory\n by default.\n\n --version Show the version and exit.\n --help Show this message and exit.\n```\n\nfor example, running `yaclog-ksp --path MyLog.md -n \"My KSP Mod\"`\nwould output to `GameData/MyKSPMod/Versioning/MyKSPModChangeLog.cfg`\n\nInput files are in markdown, and use a certain syntax to be readable by the tool. Metadata is included in a table at the\ntop of the file (which row you make the header doesnt matter). Each version is an subheading with the version, an\noptional date, and the KSP version as a tag on the end in brackets\n\n#### Example Changelog:\n\n```markdown\n# Changelog\n\nThis is the changelog for my cool mod!\n\n| modName | MyCoolMod |\n| ------- | ------------- |\n| license | CC-By-SA |\n| website | Example.com |\n| author | A cool person |\n\n## 1.0.0 - 2020-04-16 [KSP 1.11]\n\nFirst full release\n\n### Fixed\n\n- Nyan Cat now has correct music\n\n### Added\n\n- Multiplayer\n\n## 0.9.1 [KSP 1.10.1]\n\nSupported versions: 0.2.0 beta to 1.10.x\n\n### Changed\n\nA very complicated thing that I can't easily explain in bullet points, \nbut this paragraph works pretty well to get the point across!\n\n- Another thing that has multiple specific items\n - this bullet point\n * and this other one\n + oh and another one!\n\n### Removed\n\n- Herobrine\n\n```\n\n[yaclog]: https://github.com/drewcassidy/yaclog\n[KerbalChangelog]: https://github.com/HebaruSan/KerbalChangelog\n",
"bugtrack_url": null,
"license": null,
"summary": "Kerbal Space Program changelog file generator",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/drewcassidy/yaclog-ksp/blob/main/CHANGELOG.md",
"Forum Post": "https://forum.kerbalspaceprogram.com/index.php?/topic/201784-*",
"Source": "https://github.com/drewcassidy/yaclog-ksp"
},
"split_keywords": [
"changelog",
" commandline",
" markdown",
" ksp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19941cb0bd329772986778c504d407a147c43f99379887c18349075b132d9ad0",
"md5": "5e2c6f7cdfa0be9c8ef21651955777a6",
"sha256": "1981afc6f572ac429a06db704e2562c07dac6811108e447dfdbbdb78f6574857"
},
"downloads": -1,
"filename": "yaclog_ksp-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e2c6f7cdfa0be9c8ef21651955777a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20135,
"upload_time": "2024-10-18T01:34:56",
"upload_time_iso_8601": "2024-10-18T01:34:56.798386Z",
"url": "https://files.pythonhosted.org/packages/19/94/1cb0bd329772986778c504d407a147c43f99379887c18349075b132d9ad0/yaclog_ksp-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5eda605a4797f91f147dd6756ab7064fa1ca985246d4be1c8e0c858aa23c58d",
"md5": "14c08aec4cdfadd52812b8d84c414eff",
"sha256": "fe9c55a66cd473f9255d16eeec706b256f2b47f94bdd61c943795b2fce2fce84"
},
"downloads": -1,
"filename": "yaclog_ksp-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "14c08aec4cdfadd52812b8d84c414eff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22333,
"upload_time": "2024-10-18T01:34:58",
"upload_time_iso_8601": "2024-10-18T01:34:58.858018Z",
"url": "https://files.pythonhosted.org/packages/e5/ed/a605a4797f91f147dd6756ab7064fa1ca985246d4be1c8e0c858aa23c58d/yaclog_ksp-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 01:34:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "drewcassidy",
"github_project": "yaclog-ksp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "yaclog-ksp"
}
