Frictional Games Forum (read-only)
Tools for Atom (v0.1.1) - Printable Version

+- Frictional Games Forum (read-only) (https://www.frictionalgames.com/forum)
+-- Forum: SOMA (https://www.frictionalgames.com/forum/forum-55.html)
+--- Forum: User created content (https://www.frictionalgames.com/forum/forum-79.html)
+---- Forum: Development (https://www.frictionalgames.com/forum/forum-82.html)
+---- Thread: Tools for Atom (v0.1.1) (/thread-30921.html)

Tools for Atom (v0.1.1) - Apjjm - 09-26-2015

Soma Mod Tools For Atom
A plugin for the Atom text editor which provides various tools and utilities to aid with mod creation for SOMA. You can follow the project, or contribute over at github.

[Image: screenshot.png]

Features
  • Angelscript syntax highlighting (.hps files)
  • Symbols support for .hps files using ctags
  • Detect lang, nodes, mat, cmb, ent, cfg, gui, ps, fnt, hpm, hpm_* files as xml

Installation (Current Version: V0.1.1)
Spoiler below!

  1. Download and install Atom
  2. Go to File->Settings->Install
  3. Search for soma-mod-tools & Press enter.
  4. Click Install on the soma-mod-tools package
  5. The package may notify you that it has disabled symbols-view. If this did not happen, go to the "packages" tab and search symbols-view and verify it is disabled (click disable if it isn't).

You can see a change-log over on github

Note: If you already use atom and have installed atom-ctags please note that this package may conflict with it, as that package also replaces symbols-view.


Usage
Spoiler below!
  • Go to File->Add Project Folder and select your soma directory (the place with soma.exe in it).
  • You will see a list of folders and files down the left hand side of the screen.
  • You can open files from this list, or you can use ctrl+P to search for files.
  • Use ctrl+r when inside a .hps file bring up the symbols view. This will list all the functions / clases / interfaces inside the file you are currently working on, which you can search through.
  • If you wish to update to a later version of this package go to file->settings->Updates
  • You can find more detailed information on using atom here


Known issues
Spoiler below!
  • Parameters don't color correctly in constructors
  • Parameters with defaults (e.g. void function(type x=1)) don't color properly for non-built in types


Future Features & Wishlist
Spoiler below!
  • Detect hpsl as shader filers, and apply a similar shader grammar
  • Add menu options & keyboard short-cuts for opening up .ent, .hpm etc files using the appropriate editor
  • Option/shortcut for launching the game using a specific mod in develop mode
  • Have a look and see what other editor tools we can integrate with
  • Stop replacing symbols-view, when symbols-view provides a means of providing tags to it.
  • Snippets for the default soma angelscript api functions. Maybe even support special coloring for them.
  • Fix syntax highlighting issues on parameters in function calls



RE: Tools for Atom - Romulator - 09-26-2015

I would definitely love to have some tools to at least help get us started. HPL3 seems rather different to HPL2, so getting an application that can assist with that transition between the two would be very helpful :3

RE: Tools for Atom - triadtimes - 09-26-2015

If this would be anything like the Notepad++ support tool from HPL2 then yes, I'd be very interested. That thing saved me a ton of time back in HPL2.

RE: Tools for Atom - Apjjm - 09-28-2015

Started work on the project:

https://github.com/Apjjm/soma-mod-tools

So far we have some basic code colouring (still need to highlight parameters for functions correctly) and ctags support for symbols browser.
For the moment I have just forked the symbols view until we have a way to provide symbols to it, as I don't really want to commit a patch for a game-specific file extension.

Going to move this thread over to the Development sub-forum.

RE: Tools for Atom - Apjjm - 10-03-2015

I have updated this project to v0.1.1 and made an initial release.

Change-log
Spoiler below!
  • Angelscript grammar & colouring
  • Auto-detect the grammar for the various soma xml resource files
  • Fork symbols-View to provide ctags support for angelscript on .hps files


Updated the OP with installation instructions & a quick usage guide.