[1.12.x] Notes (in game notes / notepad / checklist) v0.17.0.0-adoption - Kollege Ruled edition[2022 Mar 02]

[zer0Kerbal]

  
   
   

Notes (NOTE)

Simple plugin to take notes in game for Kerbal Space Program.

formerly KSP_notes and adopted with express permission.

By @zer0Kerbal, originally by @agises (hashashin)

Preamble by @agises

Hi, I want to share this plugin I make for personal use and learning purposes, it is a space to put short notes (some form of notepad). It is hidden by default use <ALT> + <N> keys (by default) to unhide/hide or the toolbar button. The notes are persistent via the save button and the interface shows everywhere in the game. I'm not a programmer and this is my very first approach to c# and unity so suggestions are more than welcome. 

The up and down arrows are usable as text scroll, the next/prev buttons works as the buttons in the normal notes interface, and the green arrow will show some vessel info. You can use the rpm format in the notes, ie:

[hw] half width
<color=#ffffff3e>color test
<color=#f4b541>orange
<color=#4587de>blue
<color=#133a0f>green

[dw] double width

Will print in the screen (RPM version):

Features

• Take in game notes anywhere
• Multiple notes support
• Multiple directories support
• List/open/delete/save notes dialogs
• Optional Blizzy78's Toolbar integration
• Movable windows with position save
• Configurable keybind, font size and mouse button
• Autosave open note when scene changes or game quit, even on <ALT> + <F4>
• Ship's log
• Unity default skin and KSP skin
• Includes workaround for linux version bug
• Basic RasterPropMonitor support
• Rich text support, info here

Screenshots

Help Wanted

• Updated GUI
• More features (code)
• Have a request? Glad to have them, kindly submit through GitHub.

---

Localization - work in progress

•   English
•  your translation here

HELP WANTED - See the README in the Localization folder for instructions for adding or improving translations. GitHub push is the best way to contribute. Additions and corrections welcome!

---

How to support this and other great mods by zer0Kerbal

   

---

See More

• Discussions and news on this mod: See Discussions or KSP Forums
• Changelog Summary for more details of changes : See ChangeLog
• Known Issues for more details of feature requests and known issues : See Known Issues
• GitHub Pages : See Pages

---

Installation Directions

Use CurseForge/OverWolf App (currently does not install dependencies) ¹

or  ²

Dependencies

• Kerbal Space Program  ^3 4
• Toolbar Controller

Suggests

• Module Manager ^{is NOT required}

Supports

• Blizzy78's Toolbar
• Raster Prop Monitor
• MOARdV's Avionics Systems (MAS)

---

*red box below is a link to forum post on how to get support*

Be Kind: Lithobrake, not jakebrake! Keep your Module Manager up to date

Credits and Special Thanks

• Blizzy78 - for creating the toolbar!
• agises(hashashin) - for creating this mod

Legal Mumbo Jumbo (License provenance)

Current (1) - zer0Kerbal

Forum: Thread - Source: GitHub
License:  

Disclaimer(s)

Bundled add-ons/mods are distributed under their own licenses (if any)
Art assets (textures, models, animations, sounds) are distributed under their own licenses

Original (0) - Author: agises(hashashin)

Forum: Thread - Download: SpaceDock - Source: GitHub License:  

Salud.

---

1. this isn't a mod. ;P↩︎

2. this isn't a mod. ;P↩︎

3. may work on other versions (YMMV)↩︎

4. Be Kind: Lithobrake, not jakebrake! Keep your Module Manager up to date!↩︎

 

Edited March 27, 2022 by zer0Kerbal

[zer0Kerbal]

I have received formal written explicit permission from the original author to adopt this wonderful mod!

[zer0Kerbal]

   

---

Version 0.17.0.0-adoption - Kollege Ruled

02 Mar 2022
Release for Kerbal Space Program [KSP 1.12.x]

DO A CLEAN INSTALL:
DELETE EXISTING INSTALLATION THEN RE-INSTALL

Download from CurseForge

SpaceDock / CKAN release will follow shortly.

Changes

Adoption

 

Spoiler

• Update .version file
• Create [readme.md] v1.6.5.8
• create 0.17.0.0.md v1.3.1.0
• create [Create notesRPM.version]
• closes #31 - Create and Update [readme.md] v1.6.5.8
• closes #34 - Create notesRPM.version

Compatibility Patches

• Add :FOR[notes]
• create GameData/Notes/Compatibility/ folder
• move [BasicMFDnotesPatch.cfg] into Compatibility folder
• [notes_home40x20.txt]
  • create [NotePad] folder
  • move [notes_home40x20.txt] into new folder

img

• rename [HERO-1.png]
• rename [HERO-2.png]
• create [HeroLogo+1920x1920.png]
• upload to GitHub

 

Localization

 

Spoiler

• add [quickstart.md] v1.0.1.0
• add [readme.md] v2.0.1.]
• [en-us.cfg]
  • create [en-us.cfg]
  • manual lint and style
• Localize [InstallChecker.cs]
• closes #39 - Localize InstallChecker.cs
• closes #11 - Localization - English (United States) <en-us.cfg>
• updates #10 - Localization - Master

 

Code

 

Spoiler

• add [InstallChecker.cs]
  • closes #35 - Update InstallChecker.cs
• update
  • [AssemblyInfo.cs]
    • closes #33 - Update AssemblyInfo.cs
  • update
    • [notes.csproj]
    • [notesRPM.csproj]
    • closes #32 - Update .csprog's and notes.sln
  • update [notes.sln]
    • closes #29 - Version.cs v2.0.2.0
• [notes.cs]
  • add .xml notes
  • update namespace
  • insert [obsolete] (temporarily)
  • make window close button X red
  • change private const string to private readonly string so could localize
• [notesRPM.cs]
  • add .xml notes
  • update namespace
• remove extra code files that are no longer needed
  • closes #38 - Remove extraneous code files
  • closes #28 - Click-Through-Blocker

 

 

Automation

 

Spoiler

• Update
  • [_buildJSON] v1.3.3.6.2
  • [_buildRelease] v1.1.3.1
  • [_deploy] v1.1.1.3
  • [_gitReleaseNotes] v1.1.0.1
  • [_gitPullIssues] v1.1.0.1
  • [_gitReleaseNotes] v1.1.0.1
  • [_gitClean] v1.0.2.0

Notes.version

• change Changelog.cfg --> changelog.md
• update release version
• update minimum KSP version

docs

• create [404.md]
• create [Attribution.md]
• create [LegalMumboJumbo.md]
• create [Localization.md]
• create [\Code[Notes.xml]
• create [\Code[notesRPM.xml]

Status

• closes #9 - Adoption - social media

• closes #8 - Release 0.17.0.0-adoption - Kollege Ruled

• closes #7 - Adoption Documentation

• closes #6 - Adoption - GitHub

• closes #5 - Adoption Legal MumboJumbo

• closes #14 - Version 0.17.0.0-adoption

• closes #15 - 0.17.0.0-adoption Social

• closes #16 - 0.17.0.0-adoption Release

• closes #17 - 0.17.0.0-adoption Update documentatio

• closes #18 - 0.17.0.0-adoption Legal MumboJumbo

• closes #41 - Adoption and Initial Release Notes and NotesRPM

• #1 - sidestream - contributed by zer0Kerbal

• #4 - [ImgBot] Optimize images - contributed by imgbot[bot]

• #27 - upstream master - contributed by zer0Kerbal

• #30 - Create JSON - contributed by zer0Kerbal

 

---

See More

• Changelog Summary for more details of changes : See ChangeLog
• Discussions and news on this mod: See Discussions or KSP Forums
• Known Issues for more details of feature requests and known issues : See Known Issues
• GitHub Pages : See Pages

Localization

•   English
•  your translation here

HELP WANTED - See the README in the Localization folder for instructions for adding or improving translations. GitHub push is the best way to contribute. Additions and corrections solicited and welcome!

---

How to support this and other great mods by zer0Kerbal

   

---

*red box below is a link to forum post on how to get support*

 

Be Kind: Lithobrake, not jakebrake! Keep your Module Manager up to date

---

Edited March 5, 2022 by zer0Kerbal

[Stone Blue]

NIce.

Now, any chance it *might* be within scope to combine this with this?:

Was originally from the same author, so code style should be/was similar?..
I always use both together. ImageViewer is good for reading image-converted .pdfs inflight, as well as deltaV maps & other stuff...

Plus, *maybe* LGG would agree to pass it on to you, & maybe be happy to get a mod off his unbelievably huge mod list?

Edited March 5, 2022 by Stone Blue

[zer0Kerbal]

5 hours ago, Stone Blue said:

NIce

+1  @Stone Blue

Thank you. was well written by @agises.

Now onto the crux of your post.

So are you asking for

1.  two mods to function from one button? (left click for notes, (which I am considering renaming to SimpleNotes!) right click (or middle click) for imgViewer?)
2. or are you asking for a button to be put on the Notes primary GUI to use imgViewer? 
3. two mods, two buttons, one .dll?
4. or are you asking to be able to embed img in the rtf notes?
5. other?

the first three are within my current abilities, providing you can convince @linuxgurugamer to do as you suggest.

the fourth would require me to add markdown formatting.. and images would probably just show up in a separate imgViewer window (just spitballing)

IF @linuxgurugamer agrees, and he might, then I could do this to it:

1. email @agises for explicit permission
2. then localize it
3. add a RPM/MAS version of it (probably)
4. and do something (one or more) from the above list.

and I could do it relatively quickly (relativel to my normal adoption pace) since as you point out it is the same author, code style as Notes.

 

Edited March 5, 2022 by zer0Kerbal

[Stone Blue]

@zer0Kerbal you know.... *any* of the five options...lol
Even just bundling both togther, as-is, in *one* release, maybe?...
Whatever would be easiest/quickest for *all* parties involved

[linuxgurugamer]

My 2 cents worth:

These are two totally different mods.  One designed to show images (not take images) in a specific directory, the other designed to take notes.  I'm going to put in a plug here for my mod which I have plans to add the ability to take images and store with a specific note. 

 

3 hours ago, zer0Kerbal said:

two mods to function from one button? (left click for notes, (which I am considering renaming to SimpleNotes!) right click (or middle click) for imgViewer?)

Other than removing a button, there is nothing connecting the two.

3 hours ago, zer0Kerbal said:

or are you asking for a button to be put on the Notes primary GUI to use imgViewer? 

Quite possible to do without merging the two mods, it could be done to only show the button if ImgViewer is installed

3 hours ago, zer0Kerbal said:

two mods, two buttons, one .dll?

Why?  This gains nothing from a functionality point

3 hours ago, zer0Kerbal said:

• or are you asking to be able to embed img in the rtf notes?
• other?

Sounds like you are suggesting the ability to take a picture and embed it

3 hours ago, zer0Kerbal said:

add a RPM/MAS version of it (probably)

This is the first thing that really makes sense, for people who use RPM/MAS.

 

Anyway, if @zer0Kerbalwants to merge the two, I'm not going to object.  And the license for ImgViewer is MIT, and since I already had permission, I don't really think you need to ask  again

[zer0Kerbal]

2 hours ago, Stone Blue said:

Whatever would be easiest/quickest for *all* parties involved

+

1 hour ago, linuxgurugamer said:

Anyway, if @zer0Kerbalwants to merge the two, I'm not going to object.  And the license for ImgViewer is MIT, and since I already had permission, I don't really think you need to ask  again

 

Permission granted. Thank you.

 

[million_lights]

First of all , Thank you so much for reviving it.

 

 

I noticed your "Changelogs" link under SEE MORE doesnt work. It links to https://github.com/zer0Kerbal/Notes/changelog.md

You probably want to link to https://raw.githubusercontent.com/zer0Kerbal/Notes/master/changelog.md

or https://github.com/zer0Kerbal/Notes/releases or https://zer0kerbal.github.io/Notes/ReleaseNotes/

 

 

 

Have a great weekend!

Edited March 6, 2022 by million_lights

[zer0Kerbal]

43 minutes ago, million_lights said:

First of all , Thank you so much for reviving it.

Thank you!

43 minutes ago, million_lights said:

"Changelogs" link under SEE MORE

+`  thank you. the release notes version was, but the readme wasn't. corrected.

[eightiesboi]

I am going to add my thanks to @zer0Kerbalfor reviving another languishing mod. Between ZK and @linuxgurugamer, the number of mods that have been updated and maintained long after their authors have taken a break from the community is inspiring (and let's not forget the number of original mods ZK and LGG have authored).

Not only that, but the cooperation and coordination between the two of them is much appreciated. I can't speak for anyone else, but I find myself constantly revisiting old mods, comparing them to new ones, and feeling quite fortunate that I have different feature sets to choose from. I can Play My Way (tm), and that's not a bad thing. 

Just waiting for ZK to release his take on Office 365 for KSP. 

[zer0Kerbal]

7 hours ago, eightiesboi said:

I am going to add my thanks to @zer0Kerbalfor reviving another languishing mod. Between ZK and @linuxgurugamer, the number of mods that have been updated and maintained long after their authors have taken a break from the community is inspiring (and let's not forget the number of original mods ZK and LGG have authored).

Not only that, but the cooperation and coordination between the two of them is much appreciated. I can't speak for anyone else, but I find myself constantly revisiting old mods, comparing them to new ones, and feeling quite fortunate that I have different feature sets to choose from. I can Play My Way (tm), and that's not a bad thing. 

Just waiting for ZK to release his take on Office 365 for KSP. 

Thank you @eightiesboi! +1

I wouldn't be where I am without the mentoring of @linuxgurugamer and others in this glorious community along with the great authors like @blizzy78, @agises and many others; some active, some not so much.

I hear you about O-CDXXVIS or O-426.5

 

[zer0Kerbal]

I have to say, been using Notes! in my development process - allowing me to take notes that persist outside the game priceless! especially for parts addons!

[tuxuera]

Hello very good job, I wanted to ask you, how do I see the notes in RPM?

 

[zer0Kerbal]

On 6/7/2023 at 12:31 PM, tuxuera said:

Hello very good job, I wanted to ask you, how do I see the notes in RPM?

 

Why thank you! 

Needs to be added to an IVA attached to existing buttons/prop screen. Unsure how to do this.