Difference between revisions of "Atom"

Revision as of 11:46, 20 June 2016

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

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. Compilation is provided by the build and build-papyrus packages.

In Atom, open the settings tab (File -> Settings, or Ctrl+,)
Select the Install tab on the side
Search for language-papyrus, then click install on the package when the results appear
Repeat the previous step for build and build-papyrus
To see compiler errors inline with your code, also install the linter package

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:

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

Usage

Snippets

Snippets are nearly identical to the Sublime Text plugin's snippets.

Compilation

There are two methods to configure compilation of your scripts; using a Papyrus project file, or manually configuring the build-papyrus settings. Using a project file is highly recommended, as it can handle compiling entire folders at the same time, and will always compile all of your scripts when building. Manual configuration will only compile the file you currently have open. In either case, you can use Ctrl+Alt+B or F9 to trigger the build.

If you are keeping your scripts inside the game folder, the project/configuration file should be placed in Fallout 4\Data\Scripts\Source. Otherwise, the file should be placed in your mod's folder. These are also the folders you should have open in Atom. You should only have one project/configuration file in any folder, as build-papyrus only uses the first one it locates. Upon adding or removing a project/configuration file, make sure you run the Build: Refresh Targets command in the palette (Ctrl+⇧ Shift+P).

Project file

Make sure your Papyrus project file is in the base folder that you have open in Atom. No additional configuration is necessary.

Manual configuration

Place the below text into a file called .build-papyrus.yml in the base folder you have open in Atom:

game: fallout4
imports:
    - C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\Source\User
    - C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\Source\DLC03
    - C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\Source\DLC02
    - C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\Source\DLC01
    - C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\Source\Base
output: C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\
optimize: true
release: false
final: false

If your mod's scripts are outside of the game's scripts directory, make sure you add it to the imports setting, and change the output directory. If you do not have the DLC, simply remove them from the imports setting.

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:

minimap - Adds a minimap preview of your source code like Sublime Text does
minimap-find-and-replace - Highlights all found text on the minimap when finding/replacing code
minimap-selection - Highlights your text selection on the minimap
highlight-selected - Highlights all occurrences of your text selection
minimap-highlight-selected - Highlights all occurrences of your text selection on the minimap
project-manager - Lets you save your Atom workspace as a project, and easily reopen them
clipboard-plus - Keeps your clipboard history

@@ Line 12: / Line 12: @@
 Syntax highlighting and snippets are provided by the [https://atom.io/packages/language-papyrus language-papyrus] package.
 Compilation is provided by the [https://atom.io/packages/build build] and [https://atom.io/packages/build-papyrus build-papyrus] packages.
-#In Atom, open the settings tab (File -> Settings, or Ctrl + Comma)
+#In Atom, open the settings tab (File -> Settings, or {{key press|Ctrl|,}})
 #Select the Install tab on the side
 #Search for <code>language-papyrus</code>, then click install on the package when the results appear
@@ Line 20: / Line 20: @@
 If your Papyrus Compiler isn't in the default location (<code>C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Papyrus Compiler\PapyrusCompiler.exe</code>), then you must set it in the build-papyrus package settings:
-#In Atom, open the settings tab (File -> Settings, or Ctrl + Comma)
+#In Atom, open the settings tab (File -> Settings, or {{key press|Ctrl|,}})
 #Select the Packages tab on the side
 #Search for <code>build-papyrus</code> or find it in the list, and click on Settings
@@ Line 33: / Line 33: @@
 Using a project file is highly recommended, as it can handle compiling entire folders at the same time, and will always compile all of your scripts when building.
 Manual configuration will only compile the file you currently have open.
-In either case, you can use '''Ctrl-Alt-B''' or '''F9''' to trigger the build.
+In either case, you can use {{key press|Ctrl|Alt|B}} or {{key press|F9}} to trigger the build.
 If you are keeping your scripts inside the game folder, the project/configuration file should be placed in <code>Fallout 4\Data\Scripts\Source</code>.
@@ Line 39: / Line 39: @@
 These are also the folders you should have open in Atom.
 You should only have one project/configuration file in any folder, as build-papyrus only uses the first one it locates.
-Upon adding or removing a project/configuration file, make sure you run the <code>Build: Refresh Targets</code> command in the palette ('''Ctrl-Shift-P''').
+Upon adding or removing a project/configuration file, make sure you run the <code>Build: Refresh Targets</code> command in the palette ({{key press|Ctrl|Shift|P}}).
 ====Project file====