Atom

From the Fallout4 CreationKit Wiki
Revision as of 19:38, 6 June 2016 by imported>Kicoax (Added recommended packages)
Jump to navigation Jump to search

Atom is a completely free, 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 official Atom site. Atom's interface and functionality is very similar to Sublime Text, so it's a fairly painless transition if you have experience with it. Atom has an extremely flexible package system that allows customization of virtually everything about the editor.

Installation

Install Atom

  1. Go to the Atom website, download the setup file, and run it.

Install Packages

Syntax highlighting and snippets are provided by the language-papyrus package. Building is provided by the build and build-papyrus packages.

  1. In Atom, open the settings tab (File -> Settings, or Ctrl + Comma)
  2. Select the Install tab on the side
  3. Search for language-papyrus, then click install on the package when the results appear
  4. Repeat the previous step for build and build-papyrus


If your Papyrus Compiler isn't in the default location (C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Papyrus Compiler\PapyrusCompiler.exe), then you must set it in the build-papyrus package settings:

  1. In Atom, open the settings tab (File -> Settings, or Ctrl + Comma)
  2. Select the Packages tab on the side
  3. Search for build-papyrus or find it in the list, and click on Settings
  4. Change the compiler path setting to your appropriate path


To see compiler errors inline with your code, also install the linter package.

Usage

The build-papyrus package currently only supports using Papyrus project files to compile. Make sure whatever folder you have open in Atom contains your project file in its root, and use Ctrl-Alt-B to trigger the build. If you add, delete, or rename a project file, make sure you run the Build: Refresh Targets command in the palette (Ctrl-Shift-P). Snippets are nearly identical to the Sublime Text plugin's snippets.

Recommended packages

To further enhance your experience with Atom, there are thousands of packages for Atom available. You can browse them within the editor itself, or on the official packages site. Here are a few worth taking a look at: