Atom Setup

From the CreationKit Wiki
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.

See Wikipedia's page for more information.

Installation[edit | edit source]

Install Atom[edit | edit source]

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

Install Packages[edit | edit source]

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

  1. In Atom, open the settings tab (File -> Settings, or Ctrl+,)
  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
  5. 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\Skyrim\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+,)
  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

Usage[edit | edit source]

Snippets[edit | edit source]

The language-papyrus package includes hundreds of snippets you can use for vanilla Skyrim functions and events, as well as various library mods. To use a snippet, just begin typing the name of a function/event/other snippet, and a list of matched snippets will appear. You can choose which one to use with the arrow keys or mouse, and complete it by pressing Tab ↹ or clicking on it. Immediately after autocompletion, you may be able to cycle through pieces of it by pressing Tab ↹ again, depending on the snippet.

Compilation[edit | edit source]

Place the below text in a file called .build-papyrus.yml (yes, with the leading dot!) in your Skyrim\Data\Scripts\Source directory. If you don't have the DLC, just remove them from the imports list.

game: skyrim
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Dawnguard
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Dragonborn
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Hearthfire
output: C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\
optimize: true

After placing the .build-papyrus.yml file there, any of the scripts you open in Atom will be able to be compiled simply by pressing Ctrl+Alt+B or F9.
If there are errors during compilation, clicking a filename in the build output window will take you directly to the spot in your code in which the error occurred. Ctrl+Alt+G will also jump between any errors.

Mod Organizer[edit | edit source]

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 .build-papyrus.yml file in the mod's scripts source directory that you're working on, e.g. Mod Organizer\mods\Ultra Cool Mod\Scripts\Source. Some tweaking to the file needs to be done, namely changing the imports and output settings. Using the prior mod example, your imports and output settings would look similar to this:

    - C:\Program Files (x86)\Mod Organizer\mods\Ultra Cool Mod\Scripts\Source
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Dawnguard
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Dragonborn
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Hearthfire
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source
output: C:\Program Files (x86)\Mod Organizer\mods\Ultra Cool Mod\Scripts

If your scripts depend on another mod, just add its script source directory to the imports list as well, after your mod's directory, but before the Skyrim and DLC directories. Example:

    - C:\Program Files (x86)\Mod Organizer\mods\Ultra Cool Mod\Scripts\Source
    - C:\Program Files (x86)\Mod Organizer\mods\Some Other Mod\Scripts\Source
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Dawnguard
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Dragonborn
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source\Hearthfire
    - C:\Program Files (x86)\Steam\SteamApps\common\Skyrim\Data\Scripts\Source

Tips and tricks[edit | edit source]

  • The command palette (Ctrl+⇧ Shift+P) lists every single command available in Atom, with a fuzzy finder. If you ever forget a hotkey, you can search for the command with its full/partial name or whatever shorthand you come up with. Searching brt will find Build: Refresh Targets, for example.
  • Pressing Ctrl+P will open a fuzzy finder for all files in the folder you have open. It will list files that match your search in real-time. You can type file names in just about any shorthand you can think of, and it will find them correctly. "comph" will match a file named "CompanionsHousekeepingScript.psc", for example.
  • After compiling, if there are any errors, you can cycle through them with Ctrl+Alt+G or F4. You can also jump straight to the first error with Ctrl+Alt+H or ⇧ Shift+F4. Additionally, you can click on the errors at the bottom of the window to jump to them. The linter package will also list the errors in a much prettier, more usable way.
  • Holding Ctrl allows you to move lines up and down with the arrow keys.
  • Ctrl+⇧ Shift+D duplicates a line.
  • Highlight a word, then press Ctrl+D repeatedly to highlight each occurrence of it in succession. This makes renaming variables and functions quite simple!
  • All Events that the compiler supports have been added as snippets, so if you type the name of the event and hit Tab ↹, it will autocomplete to the full event (with parameters) so you don't have to check the wiki for syntax.
  • All the functions on the wiki have been added as snippets. You can type part of the function name and hit Tab ↹ to fill out the function with all the parameters. Hit Tab ↹ to switch between each parameter.

Recommended packages[edit | edit source]

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:

Language: [[::Atom Setup|English]]