Editing Atom
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
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 was created and is being actively developed by the GitHub team. | ||
It can be downloaded from the [https://atom.io/ official Atom site]. | It can be downloaded from the [https://atom.io/ official Atom site]. | ||
Atom's interface and functionality is very similar to | 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. | Atom has an extremely flexible package system that allows customization of virtually everything about the editor. | ||
==Installation== | ==Installation== | ||
Line 11: | Line 9: | ||
#Go to [https://atom.io/ the Atom website], download the setup file, and run it. | #Go to [https://atom.io/ the Atom website], download the setup file, and run it. | ||
===Install | ===Install Packages=== | ||
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. | 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 | #In Atom, open the settings tab (File -> Settings, or Ctrl + Comma) | ||
#Select the Install tab on the side | #Select the Install tab on the side | ||
#Search for <code>language-papyrus</code>, then click install on the package when the results appear | #Search for <code>language-papyrus</code>, then click install on the package when the results appear | ||
Line 25: | 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: | 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 | #In Atom, open the settings tab (File -> Settings, or Ctrl + Comma) | ||
#Select the Packages tab on the side | #Select the Packages tab on the side | ||
#Search for <code>build-papyrus</code> or find it in the list, and click on Settings | #Search for <code>build-papyrus</code> or find it in the list, and click on Settings | ||
Line 32: | Line 27: | ||
==Usage== | ==Usage== | ||
===Snippets=== | ===Snippets=== | ||
Snippets are nearly identical to the [[Sublime Text Papyrus Plugin#Existing_Snippets|Sublime Text plugin's snippets]]. | |||
===Compilation=== | ===Compilation=== | ||
Line 41: | 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. | 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. | Manual configuration will only compile the file you currently have open. | ||
In either case, you can use | 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 <code>Fallout 4\Data\Scripts\Source</code>. | 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 50: | Line 39: | ||
These are also the folders you should have open in Atom. | 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. | 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 ( | 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'''). | ||
====Project file==== | ====Project file==== | ||
Line 59: | Line 46: | ||
====Manual configuration==== | ====Manual configuration==== | ||
Place the below text into a file called <code>.build-papyrus.yml</code> in the base folder you have open in Atom: | Place the below text into a file called <code>.build-papyrus.yml</code> in the base folder you have open in Atom: | ||
< | <pre>game: fallout4 | ||
game: fallout4 | |||
imports: | 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\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\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\DLC01 | ||
- C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\Source\Base | - 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</pre> | |||
If your mod's scripts are outside of the game's scripts directory, make sure you add it to the <code>imports</code> setting, and change the <code>output</code> directory. | If your mod's scripts are outside of the game's scripts directory, make sure you add it to the <code>imports</code> setting, and change the <code>output</code> directory. | ||
If you do not have the DLC, simply remove them from the <code>imports</code> setting. | If you do not have the DLC, simply remove them from the <code>imports</code> setting. | ||
==Recommended packages== | ==Recommended packages== | ||
Line 97: | Line 72: | ||
*[https://atom.io/packages/clipboard-plus clipboard-plus] - Keeps your clipboard history | *[https://atom.io/packages/clipboard-plus clipboard-plus] - Keeps your clipboard history | ||
[[Category:Scripting]] | |||
[[Category:Text Editors]] | [[Category:Text Editors]] | ||