Home modified by Horváth Péter

Horváth Péter — Sun, 17 Apr 2016 22:37:51 -0000

--- v1
+++ v2
@@ -1,8 +1,67 @@
-Welcome to your wiki!
+# Papyrus Make System

-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
+## Cause and Purpose

-The wiki uses [Markdown](/p/papyrus-make/wiki/markdown_syntax/) syntax.
+This project was born to support directory structures of organized papyrus scripts. The behavior is similar to the GNU make, but more simplistic and tailored to the specific needs of papyrus scripts.
+
+## Installation
+
+The .msi file should install everything to the correct place and sets everything needed to use it. If something appears not working see the Troubleshooting part or open a ticket.
+
+Alternatively it can be installed by hand setting the correct registry values, adding the install dir to PATH and copy the executable in place. For more info see Troubleshooting.
+
+WARNING: if you have the GNU make installed (msys, cygwin or just because you use it anyway) it will cause problems because of the name collision. It can be solved by renaming this make. exe something else, and correct the registry values accordingly. See Troubleshooting.
+
+## Usage
+
+This program serves the purpose to compile the papyrus scripts in the directory structure. It can be used from command line and context menu. Sublime and Notepad++ plugin support will come soon. Creation Kit support is considered.
+
+### command line:
+
+make -h: displays help
+
+make <target>: compiles target
+
+target can be phony target, or file or subdirectory(TODO)
+phony target support is not as sophisticated as GNU make uses, because the lack of makefiles.
+supported phony targets:
+   * all: compiles all scripts under scripts/source
+   * clean: removes all compiled scripts
+TODO: all should only recompile changed scripts and the ones depending on it
+
+make <scriptname>.psc: compiles the specified script
+
+### context menu:
+
+Right clicking on a .psc fie brings up a context menu where a new option Compile can be found. Choosing that compiles the clicked script.
+
+## Packing into exe:
+
+pyinstaller -F make.py; rm make.exe; cp dist/make.exe ./
+
+## Troubleshooting
+
+After installation run cmd (win+r cmd enter), and type "make --version". It should display the papyrus make version.
+If it can be seen, the executable is in the right place, and the PATH env var is set correctly
+
+If not, check the "Program Files\Papyrus Make\" folder, the make.exe should be there. The make.exe is based on 64 bit python, it won't start.
+The PATH should contain this folder. You can set it by rightcick my computer > properties > Advanced system settings > Environment variables. append the full path of the folder where make.exe is separated by ';' to the PATH env var.
+
+If right clicking on a .psc file the context menu does not contain the Compile option, or it doesn't work or displays some error: probably the registry settings aren't correct.
+You can set them by downloading the .reg file and installing it (doubleclicking on it).
+Manually: open regedit (win+r regedit enter) and look for these values:
+
+hkey_classes _root \ .psc \ (Default) = papyrusscript
+hkey_classes _root \ papyrusscript \ shell \ Compile \ command \ (Default) = <where you="" installed="" the="" make.exe=""> %1
+
+If you installed papyrus make differently (other folder or other name) or these values are missing or wrong then correct them to the value should be set for your install.
+
+### if neither of these worked
+create a ticket or notify b8horpet somehow, i appreciate every feedback
+
+## Additional Info
+
+Created by b8horpet for the Skywind project

 [[members limit=20]]
 [[download_button]]

Home modified by Horváth Péter

Horváth Péter — Sun, 10 Apr 2016 17:11:26 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Project Members:

Horváth Péter (admin)

Recent changes to Home

Home modified by Horváth Péter

Home modified by Horváth Péter

Project Members: