{"id":21112122,"url":"https://github.com/alpyen/overgrowth-scripting-helper","last_synced_at":"2025-03-14T10:10:02.141Z","repository":{"id":153637827,"uuid":"200236361","full_name":"alpyen/Overgrowth-Scripting-Helper","owner":"alpyen","description":"A Notepad++ plugin, calltip and language definitions to enhance scripting for Overgrowth in Angelscript.","archived":false,"fork":false,"pushed_at":"2023-04-19T19:27:24.000Z","size":2200,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-28T04:29:17.662Z","etag":null,"topics":["angelscript","notepad-plusplus-plugin","overgrowth"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alpyen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-02T13:07:41.000Z","updated_at":"2023-03-27T16:56:00.000Z","dependencies_parsed_at":"2023-06-01T00:45:29.446Z","dependency_job_id":null,"html_url":"https://github.com/alpyen/Overgrowth-Scripting-Helper","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpyen%2FOvergrowth-Scripting-Helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpyen%2FOvergrowth-Scripting-Helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpyen%2FOvergrowth-Scripting-Helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpyen%2FOvergrowth-Scripting-Helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alpyen","download_url":"https://codeload.github.com/alpyen/Overgrowth-Scripting-Helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243558477,"owners_count":20310573,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angelscript","notepad-plusplus-plugin","overgrowth"],"created_at":"2024-11-20T01:26:33.822Z","updated_at":"2025-03-14T10:10:02.110Z","avatar_url":"https://github.com/alpyen.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg width=\"48\" height=\"48\" src=\"ReadmeContents/rabbit.png\" /\u003eOvergrowth Scripting Helper\nA Notepad++ plugin, calltip and language definitions to enhance scripting for Overgrowth in Angelscript.\n\n## Feature List\u003ca id=\"feature-list\"\u003e\u003c/a\u003e\n- Angelscript Syntax Highlighting extended with Overgrowth Type Support\n- Function Calltips for every script type and enabled Angelscript standard library functions\n- Customizable Helper Window to browse and filter Classes, Enumerations, Functions and Variables\n- Script Templates for Camera, Character, Hotspot and Level scripts\n- Cheat Sheet to check root folders for specific paths\n\n## Navigation\n1. [Feature List](#feature-list)\n2. [Preview](#preview)\n3. [Requirements](#requirements)\n4. [Installation Guide](#installation-guide)\n5. [Troubleshooting \u0026 FAQ](#troubleshooting-and-faq)\n6. [Developing](#developing)\n7. [Stuff for the future](#stuff-for-the-future)\n8. [Known Bugs](#known-bugs)\n9. [Licensing and Credits](#licensing-and-credits)\n\n## Preview\u003ca id=\"preview\"\u003e\u003c/a\u003e\nCheck parameters of function overloads with the Notepad++ calltips for the available Overgrowth and Angelscript standard library functions.\n\n\u003cimg src=\"ReadmeContents/Calltip.gif\" /\u003e\n\u003cbr\u003e\u003cbr\u003e\n\nBrowse through all available classes, enumerations, functions and variables.\n\n\u003cimg src=\"ReadmeContents/BrowsingHelperWindow.gif\" /\u003e\n\u003cbr\u003e\u003cbr\u003e\n\nStart off new scripts with a template and have every script function ready to go.\n\n\u003cimg src=\"ReadmeContents/InsertingScriptTemplate.gif\" /\u003e\n\n## Requirements\u003ca id=\"requirements\"\u003e\u003c/a\u003e\n- .NET Framework 4 (comes preinstalled on Windows 10)\n- Notepad++ 32 bit or 64 bit\n- Windows\n\n## Installation Guide\u003ca id=\"installation-guide\"\u003e\u003c/a\u003e\n\u003e All steps can be also reproduced on the portable version of Notepad++\n1. Download the \u003ca href=\"https://github.com/alpyen/Overgrowth-Scripting-Helper/releases\"\u003elatest release\u003c/a\u003e which matches your Notepad++ installation (32 bit or 64 bit)\n2. Extract the archive and merge the `autoComplete` and the `plugins` folders into the root folder of your Notepad++ installation in Program Files.\n3. Start Notepad++ and a rabbit icon should appear in the toolbar.\n4. Open the folder for the user defined languages by navigating through the menu \u003cbr\u003e`Language \u003e User Defined Language \u003e Open User Defined Language folder...`\n5. Copy the `Angelscript UDL.xml` file into the folder and restart Notepad++.\n6. That's it, enjoy!\n\n## Troubleshooting \u0026 FAQ\u003ca id=\"troubleshooting-and-faq\"\u003e\u003c/a\u003e\n- *Notepad++ shows the error \"Cannot load 32-bit plugin.\" on startup*\n  - It seems like you downloaded the wrong version of the plugin.\u003cbr\u003eRun Notepad++ and check the version through the menu `? \u003e About Notepad++`.\u003cbr\u003eYou have to download exactly the same version as the application regardless of your operating system.\u003cbr\u003e\u003cbr\u003e\n- *The syntax highlighting is incorrect, it uses ActionScript*\n  - This can happen the first time you're launching Notepad++ with the new language definition and had already an \\*.as file open. Just switch once to Angelscript by selecting it in the language menu.\u003cbr\u003eIt shouldn't happen again, if it does you can disable ActionScript in the settings.\u003cbr\u003e\u003cbr\u003e\n- *Notepad++ takes ages to start after installing the plugin*\n  - This is because the plugin has to load and parse the database file. Since the file is almost 2 MB it might take a second or two on startup.\n\n## Developing\u003ca id=\"developing\"\u003e\u003c/a\u003e\n\u003e Development requires to enable .NET Framework 3.5 from the windows features because one of the N++ Plugin Build DLLs depends on an older version, this is only needed to build the plugin.\n\nThe project consists of two solutions: `AsDocs2XML` and `Overgrowth Scripting Helper`.\n\n**AsDocs2XML** is used to parse the header files the game outputs into the XML file format so the plugin can load it.\nHowever the original *_docs.h files are as of right now (Overgrowth 1.4) malformatted and also incorrect which will make them not compliant with the the parser, they'll flat out crash it.\n\nI sanitized and corrected all header files and saved them at `CalltipDefinitions\\Overgrowth 1.4`, these files are also references as the command line parameters for the parser.\nSadly VS does not save the command line parameters, so here's an example one: `\"../../../CalltipDefinitions/Overgrowth1.4/Camera.txt\" `. Just concatenate them all one after the other.\n\nWhen successfully built and run, AsDocs2XML will output the Notepad++ calltips file `angelscript.xml` and the database file `database.xml` into `AsDocs2XML\\bin`.\n\n**Overgrowth Scripting Helper** is the actual plugin and uses post-build commands to move the two files, mentioned above, into their respective folders.\nSince these folders are in Program Files, they might be write protected.\n\nIf you don't want to run Visual Studio with elevated privileges\nyou have the option to either use a portable Notepad++ instance, or set the `autoComplete` and the `plugins` folders (and their subfolders) writable as the user you're logged in as.\n\nThis is done to streamline the development process, if you are fine with moving the files manually you can simply disable the post-build commands.\n\u003e Note that the language definition `Angelscript UDL.xml` is not moved on build since this files does not change.\n\u003e It has to be moved once manually.\n\nWhen successfully built and run, Notepad++ should start with the plugin enabled and ready to test.\n\u003e Changes made in the settings will remain because the config file stored in AppData will not be deleted.\n\n## Stuff for the future\u003ca id=\"stuff-for-the-future\"\u003e\u003c/a\u003e\n#### Helper Window\n- Save the steps while filtering so the tree view can be rebuilt faster\n- Option to hide empty groups\n- Contextmenu options to collapse levels\n\n#### Settings\n- Set Cheat Sheet and Helper Window OnToppable\n- PreScriptReload\n\n#### Plugins Menu\n- Script Templates for `Scriptable Campaign` and `Scriptable UI`\n\n## Known Bugs\u003ca id=\"known-bugs\"\u003e\u003c/a\u003e\n- Notepad++ shows the wrong calltip if previously a calltip with the same prefix has been opened:\n  - Open DebugDrawLine, try to open DebugDrawLines, it will still show DebugDrawLine.\n\n- The filter textbox retains its colors when the plugin is in Dark Mode.\n  - This is a bug with .NET which usually appears when the box is ReadOnly, but its the otherway round here.\n\n## Licensing and Credits\u003ca id=\"licensing-and-credits\"\u003e\u003c/a\u003e\nOvergrowth Scripting Helper is released under the MIT license.\n\nThis project includes various other projects which made this project possible in the first place. Thanks to:\n\n- The rabbit icon has been taken off the Overgrowth game files created by \u003ca href=\"https://www.wolfire.com/\"\u003eWolfire Games\u003c/a\u003e.\n- The Notepad++ plugin base \u003ca href=\"https://github.com/kbilsted/NotepadPlusPlusPluginPack.Net\"\u003eNotepadPlusPlusPluginPack.Net\u003c/a\u003e version 0.95.00 was developed by kbilsted and provided under the Apache-2.0 license.\n- Some icons have been used and modified from the \u003ca href=\"https://www.famfamfam.com/lab/icons/silk/\"\u003eSilk Icon Set 1.3\u003c/a\u003e by Mark James and provided under the CC-BY-2.5 license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpyen%2Fovergrowth-scripting-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falpyen%2Fovergrowth-scripting-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpyen%2Fovergrowth-scripting-helper/lists"}