Jibble

Author Topic: EDITOR PLUGIN: Notes 1.1  (Read 3289 times)

Gurok

  • Rottwheelers
  • When life hands you lemons, combine them with the mop
    • I can help with AGS tutoring
    • Best Innovation Award Winner 2016, for improving and extending the AGS scripting language
    • I can help with proof reading
    • I can help with scripting
    • Gurok worked on one or more games that won an AGS Award!
    •  
    • Gurok worked on one or more games that was nominated for an AGS Award!
EDITOR PLUGIN: Notes 1.1
« on: 26 Oct 2014, 02:36 »
Notes for AGS

Ever wanted to attach arbitrary text files to your AGS project? Do you find yourself putting comments in odd places, like a to do list in your global script header? Notes is a plugin for the AGS editor that allows you to tie text documents closely to your project while maintaining the semantic separation between text file and source code that you crave.

Here are some screenshots of it in action:





Known Issues
  • AGS will automatically close one of your text files when you close the editor. Not sure why this happens. I believe it's an editor issue and I'm looking into it
  • Renaming text files is suboptimal right now. AGS doesn't seem to expose a way to handle renaming like the Scripts branch does

Planned Features
  • Reordering text files, placing them in folders (may not be possible due to plugin limitations)
  • Providing access to the editor's Find/Replace tools and other edit menu items (or at least a reasonable facsimile)

Download

Notes for AGS 1.1 (21 KB)
« Last Edit: 11 Jun 2016, 16:04 by Gurok »

monkey0506

  • SEND PIZZA.
    • Best Innovation Award Winner 2017, for his work to help AGS games reach the widest possible audience - through popular distribution platforms (Steam, Galaxy) as well as other operating systems (Android, Linux)
    • monkey0506 worked on one or more games that won an AGS Award!
    •  
    • monkey0506 worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #1 on: 26 Oct 2014, 07:53 »
AGS will automatically close one of your text files when you close the editor. Not sure why this happens. I believe it's an editor issue and I'm looking into it

I've actually experienced this ever since the docking tabs were introduced. Whenever I close the editor the right-most tab disappears (while the others stay) prior to the prompt to save and then the editor actually closing.

Other than that, this looks like a pretty cool thing to have. Might be worth implementing in the main code base if it's a popular feature.

Dualnames

  • Local Moderator
  • Pretty Badass
    • Dualnames worked on one or more games that won an AGS Award!
    •  
    • Dualnames worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #2 on: 26 Oct 2014, 22:43 »
+1 this is so useful, I can't even.
No more military army stuff. I'm alive and back.

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    • I can help with proof reading
    • I can help with translating
    • I can help with web design
    • selmiak worked on one or more games that won an AGS Award!
    •  
    • selmiak worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #3 on: 27 Oct 2014, 19:26 »
sounds really useful. Would it be possible to have a general notepad (for to do lists and notes) and also specific notes, like you attach a note to a room, when you open the room in the editor the note pops up or is attached next to the room. Or for a character (draw down walkframes). or for everything else. And in case you forget where there are still specific to do notes you look them all up in a general place via one of the dropdown menus or the notes node.

Gurok

  • Rottwheelers
  • When life hands you lemons, combine them with the mop
    • I can help with AGS tutoring
    • Best Innovation Award Winner 2016, for improving and extending the AGS scripting language
    • I can help with proof reading
    • I can help with scripting
    • Gurok worked on one or more games that won an AGS Award!
    •  
    • Gurok worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #4 on: 28 Oct 2014, 13:24 »
Thanks for the words of encouragement, guys!

Yes, monkey_05_06, that's the exact bug! I don't know what causes it, but it's so irritating.

Selmiak, I was actually thinking I could try linking a text file to a specific room, but I don't think the plugin API lets me capture the event of a room being opened. We could possibly go the other way though, i.e. click on a button in the note file to go to the attached room. I'll look into it.
« Last Edit: 28 Oct 2014, 13:34 by Gurok »

Monsieur OUXX

  • Mittens Half Initiate
    • I can help with proof reading
    • I can help with translating
    • I can help with voice acting
    • Monsieur OUXX worked on one or more games that won an AGS Award!
    •  
    • Monsieur OUXX worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #5 on: 28 Oct 2014, 18:40 »
specific notes, like you attach a note to a room

+1
 

Adeel

  • Cavefish
    • Adeel worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #6 on: 29 Oct 2014, 14:40 »
Useful plugin, especially for planning the puzzles. I won't have to open notepad and keep track of a my to-do list myself now. Please make it an integral part of AGS Editor, if possible.

What happened to your cat, btw? I hope it's okay.
-

cat

  • Mittens Baronet
    • cat worked on one or more games that won an AGS Award!
    •  
    • cat worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #7 on: 29 Apr 2015, 20:00 »
I just tried this with AGS 3.4.0.4 Alpha (just copied the dll in the folder of the exe - this is the way it works, I guess?) and got an error when trying to create a new note:
Spoiler: ShowHide

Error: Object reference not set to an instance of an object.
Version: AGS 3.4.0.4

System.NullReferenceException: Object reference not set to an instance of an object.
   at AGS.Plugin.Notes.NotesComponent.AGS.Typ es.IEditorComponent.CommandClick(String control)
   at AGS.Editor.GUIController._mainForm_OnMe nuClick(String menuItemID)
   at AGS.Editor.ProjectTree.ContextMenuEvent Handler(Object sender, EventArgs e)
   at System.Windows.Forms.ToolStripItem.Rais eEvent(Object key, EventArgs e)
   at System.Windows.Forms.ToolStripMenuItem. OnClick(EventArgs e)
   at System.Windows.Forms.ToolStripItem.Hand leClick(EventArgs e)
   at System.Windows.Forms.ToolStripItem.Hand leMouseUp(MouseEventArgs e)
   at System.Windows.Forms.ToolStripItem.Fire EventInteractive(EventArgs e, ToolStripItemEventType met)
   at System.Windows.Forms.ToolStripItem.Fire Event(EventArgs e, ToolStripItemEventType met)
   at System.Windows.Forms.ToolStrip.OnMouseU p(MouseEventArgs mea)
   at System.Windows.Forms.ToolStripDropDown. OnMouseUp(MouseEventArgs mea)
   at System.Windows.Forms.Control.WmMouseUp(Message& m, MouseButtons button, Int32 clicks)
   at System.Windows.Forms.Control.WndProc(Message& m)
   at System.Windows.Forms.ScrollableControl. WndProc(Message& m)
   at System.Windows.Forms.ToolStrip.WndProc(Message& m)
   at System.Windows.Forms.ToolStripDropDown. WndProc(Message& m)
   at System.Windows.Forms.Control.ControlNat iveWindow.OnMessage(Message& m)
   at System.Windows.Forms.Control.ControlNat iveWindow.WndProc(Message& m)
   at System.Windows.Forms.NativeWindow.Callb ack(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)


After closing the box I got another error message:
Spoiler: ShowHide

---------------------------
Adventure Game Studio
---------------------------
A serious error occurred and the AGS Editor may now be in an unstable state. You are STRONGLY ADVISED to shut down the editor and restart it. Before saving your work, make a backup copy of your game folder in case any data has been corrupted.



Error: System.NullReferenceException: Object reference not set to an instance of an object.

   at AGS.Plugin.Notes.NotesComponent.AGS.Typ es.IEditorComponent.CommandClick(String control)

   at AGS.Editor.GUIController._mainForm_OnMe nuClick(String menuItemID)

   at AGS.Editor.ProjectTree.ContextMenuEvent Handler(Object sender, EventArgs e)

   at System.Windows.Forms.ToolStripItem.Rais eEvent(Object key, EventArgs e)

   at System.Windows.Forms.ToolStripMenuItem. OnClick(EventArgs e)

   at System.Windows.Forms.ToolStripItem.Hand leClick(EventArgs e)

   at System.Windows.Forms.ToolStripItem.Hand leMouseUp(MouseEventArgs e)

   at System.Windows.Forms.ToolStripItem.Fire EventInteractive(EventArgs e, ToolStripItemEventType met)

   at System.Windows.Forms.ToolStripItem.Fire Event(EventArgs e, ToolStripItemEventType met)

   at System.Windows.Forms.ToolStrip.OnMouseU p(MouseEventArgs mea)

   at System.Windows.Forms.ToolStripDropDown. OnMouseUp(MouseEventArgs mea)

   at System.Windows.Forms.Control.WmMouseUp(Message& m, MouseButtons button, Int32 clicks)

   at System.Windows.Forms.Control.WndProc(Message& m)

   at System.Windows.Forms.ScrollableControl. WndProc(Message& m)

   at System.Windows.Forms.ToolStrip.WndProc(Message& m)

   at System.Windows.Forms.ToolStripDropDown. WndProc(Message& m)

   at System.Windows.Forms.Control.ControlNat iveWindow.OnMessage(Message& m)

   at System.Windows.Forms.Control.ControlNat iveWindow.WndProc(Message& m)

   at System.Windows.Forms.NativeWindow.Callb ack(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)
---------------------------
OK   
---------------------------

horusr

  • Just joining everything for no reason.
    • I can help with play testing
    • I can help with translating
    • I can help with voice acting
    • horusr worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.0
« Reply #8 on: 18 Jan 2016, 12:39 »
I just tried this with AGS 3.4.0.4 Alpha (just copied the dll in the folder of the exe - this is the way it works, I guess?) and got an error when trying to create a new note:

I think it works for new games. I had same errors too for old games or demos but I deleted old and started new game and it workes fine on that.

Gurok

  • Rottwheelers
  • When life hands you lemons, combine them with the mop
    • I can help with AGS tutoring
    • Best Innovation Award Winner 2016, for improving and extending the AGS scripting language
    • I can help with proof reading
    • I can help with scripting
    • Gurok worked on one or more games that won an AGS Award!
    •  
    • Gurok worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.1
« Reply #9 on: 11 Jun 2016, 15:03 »
Good news, Cat! I was able to replicate and fix the bug you reported. The Notes will now work on existing projects that were created before the plugin was added to the AGS directory.

It's been er... almost two years, wow. I've been meaning to take another look at the plugin for a while, but it just wasn't very high on my list of priorities. Anyway, finally fixed a few things. There are no new features, just bug fixes.

Changes:
  • Fixed creating notes in projects that existed prior to installing the Notes plugin
  • Fixed phantom blank entry in the notes list when there were no notes associated with a project
  • Removed syntax highlighting from the notes editor
  • Removed folding margin from the notes editor
  • Asterisk to indicate unsaved changes will now appear without delay

The new version can be downloaded here:
Notes for AGS 1.1 (21 KB)

Next version should be out by the end of the decade. Can't make any promises though.

I will look at adding new features next -- room notes and stuff like that.
« Last Edit: 11 Jun 2016, 16:10 by Gurok »

Re: EDITOR PLUGIN: Notes 1.1
« Reply #10 on: 24 Sep 2019, 02:36 »
I am so sorry this thread is really old but I am really curious.

Gurok, does the source for this plug-in exists somewhere? I would be really interested in looking into it to learn how it works.  :-D

Gurok

  • Rottwheelers
  • When life hands you lemons, combine them with the mop
    • I can help with AGS tutoring
    • Best Innovation Award Winner 2016, for improving and extending the AGS scripting language
    • I can help with proof reading
    • I can help with scripting
    • Gurok worked on one or more games that won an AGS Award!
    •  
    • Gurok worked on one or more games that was nominated for an AGS Award!
Re: EDITOR PLUGIN: Notes 1.1
« Reply #11 on: 24 Sep 2019, 03:09 »
Hi eri0, I've uploaded it here: https://github.com/gurok/AGSNotes

Re: EDITOR PLUGIN: Notes 1.1
« Reply #12 on: 24 Sep 2019, 10:14 »
Thank you  ;-D