Difference between revisions of "Atom"

← Older edit

Atom (edit)

Revision as of 04:28, 3 December 2018

6,691 bytes added , 04:28, 3 December 2018

Added categories

Anonymous user

imported>Qazaaq

@@ Line 1: / Line 1: @@
-Atom is an open-source, highly-extensible text editor based on Chromium and Node.js.
+'''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 [https://atom.io/ 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|Atom (text editor)}}
 ==Installation==
@@ Line 8: / Line 11: @@
 #Go to [https://atom.io/ the Atom website], download the setup file, and run it.
-===Install Packages===
+===Install packages===
-Syntax highlighting and snippets are provided by the [https://atom.io/packages/language-papyrus language-papyrus] package.
+* Fallout 4 [https://atom.io/packages/language-papyrus language-papyrus]
-Building is provided by the [https://atom.io/packages/build build] and [https://atom.io/packages/build-papyrus build-papyrus] packages.
+* F4SE [https://github.com/Neanka/atom-language-papyrus language-papyrus]
-#In Atom, open the settings tab (File -> Settings, or Ctrl + Comma)
+Syntax highlighting and snippets are provided by the one of the language 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 {{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
 #Repeat the previous step for <code>build</code> and <code>build-papyrus</code>
+#To see compiler errors inline with your code, also install the <code>[https://atom.io/packages/linter linter]</code> package
-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 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
 #Change the compiler path setting to your appropriate path
-==Building==
+==Usage==
-The build-papyrus package currently only supports using Papyrus project files to compile.
+===Snippets===
-Make sure whatever folder you have open in Atom contains your project file in its root, and use <code>Ctrl-Alt-B</code> to trigger the build.
+The available snippets are nearly identical to the [[Sublime Text#Existing_Snippets|Sublime Text plugin's snippets]].
-Snippets are nearly identical to the Sublime Text plugin's snippets.
+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 {{key press|Tab}} or clicking on it.
+Immediately after autocompletion, you may be able to cycle through pieces of it by pressing {{key press|Tab}} again, depending on the snippet.
+===Compilation===
+There are two methods to configure compilation of your scripts; using a [[Papyrus Projects|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 {{key press|Ctrl|Alt|B}} or {{key press|F9}} to trigger the build.
+You can choose if you want to compile for default, release (strip out debugOnly), or final release (strip out debugOnly and betaOnly) by selecting the build target.
+To select the active build target, press {{key press|Ctrl|Alt|T}} or {{key press|F7}}.
+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>.
+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 <code>Build: Refresh Targets</code> command in the palette ({{key press|Ctrl|Shift|P}}).
+More information is available in the [https://github.com/Gawdl3y/atom-build-papyrus/blob/master/README.md build-papyrus readme file].
+====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 <code>.build-papyrus.yml</code> in the base folder you have open in Atom:
+<source lang="yaml">
+game: fallout4
+output: C:\Program Files (x86)\Steam\SteamApps\common\Fallout 4\Data\Scripts\
+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
+</source>
+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.
+==Tips and tricks==
+*The command palette ({{key press|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 {{kbd|brt}} will find <code>Build: Refresh Targets</code>, for example.
+*Pressing {{key press|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 {{key press|Ctrl|Alt|G}} or {{key press|F4}}. You can also jump straight to the first error with {{key press|Ctrl|Alt|H}} or {{key press|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 {{key press|Ctrl}} allows you to move lines up and down with the arrow keys.
+*{{key press|Ctrl|Shift|D}} duplicates a line.
+*Highlight a word, then press {{key 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 {{key press|Tab}}, it will autocomplete to the full event (with parameters) so you don't have to check the wiki for syntax.
+**For remote-registered events, use the name of the event followed by {{kbd|-rem}} to have the correct syntax filled out.
+**For reference collection aliases, use the name of the event followed by {{kbd|-rc}} to have the sender parameter auto-added
+**Both of the above are combined into {{kbd|-rem-rc}} if you happen to need a remote event from a ref collection alias.
+*All the functions on the wiki have been added as snippets. You can type part of the function name and hit {{key press|Tab}} to fill out the function with all the parameters. Hit {{key press|Tab}} to switch between each parameter.
+==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 [https://atom.io/packages official packages site].
+Here are a few worth taking a look at:
+*[https://atom.io/packages/minimap minimap] - Adds a minimap preview of your source code like Sublime Text does
+*[https://atom.io/packages/minimap-find-and-replace minimap-find-and-replace] - Highlights all found text on the minimap when finding/replacing code
+*[https://atom.io/packages/minimap-selection minimap-selection] - Highlights your text selection on the minimap
+*[https://atom.io/packages/highlight-selected highlight-selected] - Highlights all occurrences of your text selection
+*[https://atom.io/packages/minimap-highlight-selected minimap-highlight-selected] - Highlights all occurrences of your text selection on the minimap
+*[https://atom.io/packages/project-manager project-manager] - Lets you save your Atom workspace as a project, and easily reopen them
+*[https://atom.io/packages/clipboard-plus clipboard-plus] - Keeps your clipboard history
+==See Also==
+*[[:Category:Text Editors|Other Text Editors]]
+[[Category:Text Editors]]
 [[Category:Scripting]]
-[[Category:Text Editors]]
+[[Category:Tooling]]