StudyCrafterAssistant
|
We would like to thank past and current members of the StudyCrafter team, and especially Dr. Camillia Matuk and Dr. Steven Sutherland. We further acknowledge the grant support from Northeastern University, NSF (IIS-1736185), and DARPA (D16AP0011).
On Windows: Drag the "StudyCrafterAssistant" folder to your installation location of choice. Double-click "StudyCrafterAssistant.exe" to run the tool.
On Mac: Drag the "StudyCrafterAssistant.app" to your Applications folder. Double-click "StudyCrafterAssistant.app" to run the tool.
On Linux: Move the "StudyCrafterAssistant" folder to your installation location of choice. Ensure the "StudyCrafterAssistant" executable has execute permissions, and run it.
Place one or more projects made using StudyCrafter into the "StreamingAssets" directory (or a subdirectory thereof) inside the StudyCrafterAssistant directory. The project should be a folder that contains multiple .json files.
On a Windows or Linux build of StudyCrafter, these projects are located inside the "StreamingAssets/NewProjectSystem" folder inside StudyCrafter_Data.
Note: On a Mac build, this folder may be accessed by right-clicking on the "StudyCrafter.app," and selecting "Show Package Contents." Inside the package, the projects are located in the folder: "Contents/Resources/Data/StreamingAssets/NewProjectSystem"
Open the "Asset Store" window in Unity, and find "Json.NET for Unity". Download and import it into your project.
(This asset: https://assetstore.unity.com/packages/tools/input-management/json-net-for-unity-11347)
You can use Doxygen to build automatic HTML documentation for this project.
To build the documentation for this project, run "doxygen Doxyfile" in the base StudyCrafterAssistant folder.
The documentation will be found in the "Documentation" folder. The start page is "html/index.html"
The code is split into namespaces based on its functionality.
In the generic namespaces, without "StudyCrafter" in the name, is code that does not rely on any StudyCrafter-specific definitions or concepts.
This project includes libraries written by other authors. These are:
Sprache (https://github.com/sprache/Sprache)
QuickGraph (https://github.com/davidgutierrezpalma/quickgraph4unity)
They are redistributed in accordance with, and retain, their original licenses.