Skip to content

Comments

Bump-to-1.3.0, and update readme for the new version#298

Merged
Shivansps merged 7 commits intoKnossosNET:mainfrom
Shivansps:bump-to-v1.3.0
Feb 17, 2025
Merged

Bump-to-1.3.0, and update readme for the new version#298
Shivansps merged 7 commits intoKnossosNET:mainfrom
Shivansps:bump-to-v1.3.0

Conversation

@Shivansps
Copy link
Member

Version bump and readme update, not to be merged until 1.3.0 is ready to go.

@Shivansps Shivansps added the documentation Improvements or additions to documentation label Feb 6, 2025
@Shivansps Shivansps added this to the 1.3 milestone Feb 6, 2025
README.md Outdated
## **Software Rendering Mode:**<br />
By default KnossosNET will render the UI in the GPU, can be set to run completely on software rendering what effectively avoids any use of the user GPU, this will come at the cost of increased CPU usage, what should not be a problem when in idle.
## **Tool Quick Launch:**<br />
Just like mods QuickLaunch, you can launch installed mod development tools with a cmdline argument. Windows users have the possibility to create a shortcut to desktop with a click. This may be extended to Linux and Mac later on.<br />
Copy link
Contributor

@wookieejedi wookieejedi Feb 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest changing to
You can launch installed mod development tools with a Command Line argument (just like how you can launch mods with QuickLaunch).

README.md Outdated

<br /><br />
## **Rendering Mode:**<br />
From 1.3.0 KnossosNET will render the UI in software mode by default to avoid use of the user GPU, but it can be set to run on hardware gpu rendering.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reccomend capitalizating the second use of the word gpu to match the first usage.

IE hardware gpu rendering. should ideally be hardware GPU rendering.

README.md Outdated
<br /><br />
## **Tray Icon Mode:**<br />
On 1.3.0 a feature to "close to tray" has been implemented, this can be enabled on global settings.<br />
Additionally, a cmdline argument (-traymode) has been added to Knossos.NET. By starting in this mode the launcher will start to tray and will not load UI resources until the user opens the UI for the first time.<br />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should cmdline be Command Line to match other ways that word is used?

README.md Outdated
<br />
You can force the software rendering mode by using the "-software" Command Line argument or by setting an environment variable "KNET_RENDER_MODE" to "software".
A filter and tags feature offers QOL improvements to mod search and listening.<br />
Filters are a physical button that will display all mods that contain it.<br />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about the following change for clarity?
Filters are a physical button that will display all mods that contain that filter.

README.md Outdated
A filter and tags feature offers QOL improvements to mod search and listening.<br />
Filters are a physical button that will display all mods that contain it.<br />
Tags are words that will be used in the search function to improve search results. Before this only the mod name was used for the search.<br />
To add filters and tags to you mods please consult in the discord or create a PR or issue here: https://github.com/KnossosNET/KNet-General-Resources-Repo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest some small changes:
To add filters and tags to your mods please consult in the Discord channel or create a PR or issue at the GitHub link here:

README.md Outdated
- Right click on the project -> Publish<br />
- Export to folder<br />
- From there you can pick the dest enviroment on the list<br />
- From there you can pick the destiny environment on the list<br />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this say destination environment instead of destiny environment?

README.md Outdated
![CustomLauncher](https://i.imgur.com/uCYnTvD.png)
<br />
<br />
Starting from 1.3.0 Knossos.NET supports "Custom TC Mode" is can be used to provide a customized launcher for a specific Total Conversion mod. Supporting customization by an additional json file or by hard-coding the data in.<br />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Starting from 1.3.0, Knossos.NET supports "Custom TC Mode" which can be used to provide a customized launcher for a specific Total Conversion mod. "Custom TC Mode" supports customization via an additional json file or by hard-coding the data in.

@wookieejedi
Copy link
Contributor

A set of grammar and wording suggestion for your consideration. I'm happy to answer any questions about any of them, too! Sorry if it's a bit much, this kind of clarity writing is actually a big part of my professional job :D

Copy link
Contributor

@JohnAFernandez JohnAFernandez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good to me

@Shivansps Shivansps merged commit 908900b into KnossosNET:main Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants