Difference between revisions of "Atom Setup"

Atom is an open-source, highly-extensible text editor based on Chromium and Node.js. It was created and is being actively developed by the GitHub team. It can be downloaded from the [https://atom.io/ official Atom site]. Atom has an extremely flexible package system that allows customization of virtually everything about the editor.

== Syntax highlighting and snippets ==

Syntax highlighting for Papyrus and Papyrus assembly is provided by the [https://atom.io/packages/language-papyrus language-papyrus] package. To install it, follow these instructions:

=== Method 1 ===

Open the settings tab (File -> Settings, or Ctrl + Comma), select the "Install" tab on the side, and search for "language-papyrus". When the results appear, click "Install" on the package.

Obtain the [https://atom.io/packages/build build] package the same way as above. Then, place the below text in a file called '''.atom-build.json''' (yes, with the leading dot!) in your <code>Skyrim\Data\Scripts\Source</code> directory. Change the path in the <code>cwd</code> setting if you need to (make sure to use double-backslashes). If you don't have the DLC, just remove them from the <code>-import</code> argument.

<pre>{

"cmd": "Papyrus Compiler\\PapyrusCompiler.exe",

"cwd": "C:\\Program Files (x86)\\Steam\\SteamApps\\common\\Skyrim\\",

"sh": false,

"-import=Data\\Scripts\\Source;Data\\Scripts\\Source\\Dawnguard;Data\\Scripts\\Source\\Dragonborn;Data\\Scripts\\Source\\Hearthfire",

"-output=Data\\Scripts",

"errorMatch": "\n(?<file>[A-Za-z0-9_:\\-\\.\\/ \\\\]+\\.(psc|PSC))\\((?<line>[0-9]+),(?<col>[0-9]+)\\): (?<message>.+)"

}</pre>

After placing the .atom-build.json file there, any of the scripts you open in Atom will be able to be compiled simply by pressing '''Ctrl-Alt-B'''.<br />

One of the most common problem modders have with Mod Organizer is getting Papyrus compilation working correctly. Setting up Atom to work with Mod Organizer is simple. You do '''not''' need to launch Atom through Mod Organizer. Instead, just place the above '''.atom-build.json''' file in the mod's scripts source directory that you're working on, e.g. <code>Mod Organizer\mods\Ultra Cool Mod\Scripts\Source</code>. Some tweaking to the file needs to be done, namely changing the <code>-import</code> and <code>-output</code> arguments. Using the prior mod example, your import and output lines would look similar to this:

<pre>"-import=C:\\Program Files (x86)\\Mod Organizer\\mods\\Ultra Cool Mod\\Scripts\\Source;Data\\Scripts\\Source;Data\\Scripts\\Source\\Dawnguard;Data\\Scripts\\Source\\Dragonborn;Data\\Scripts\\Source\\Hearthfire",

"-output=C:\\Program Files (x86)\\Mod Organizer\\mods\\Ultra Cool Mod\\Scripts",</pre>

If your scripts depend on another mod, just add its script source directory to the <code>-import</code> argument as well, after your mod's directory, but before the Skyrim and DLC directories. Example:

<pre>"-import=C:\\Program Files (x86)\\Mod Organizer\\mods\\Ultra Cool Mod\\Scripts\\Source;C:\\Program Files (x86)\\Mod Organizer\\mods\\Some Other Mod\\Scripts\\Source;Data\\Scripts\\Source;Data\\Scripts\\Source\\Dawnguard;Data\\Scripts\\Source\\Dragonborn;Data\\Scripts\\Source\\Hearthfire",</pre>