Tutorial:Getting Started

From Spiral Framework
Jump to: navigation, search

Spiral being a command-line only program may seem confusing and difficult to truly grasp, but by taking it slowly we'll be able to, hopefully, guide you through being able to understand the basic concepts of how to use Spiral, so you can begin working with the game files yourself.

Before We Begin

Before we get started, we need to cover a few basic concepts with command line usage.

  1. When a command lists the parameters it accepts, it may format them like so
    extract [folder] {regex}
    In these scenarios, a parameter denoted between square brackets ([]) is required, while a parameter specified between braces or curly brackets ({}) is optional.
  2. If you ever are supplying a parameter that has spaces in it (Such as Spiral Workspace), you must supply it between speech marks (""). This will treat it as one parameter, rather than multiple. For instance: "Spiral Workspace".

Workspace Setup

There are a few things we'll need before we can even begin to think about modding the game.

The first is a copy of either Danganronpa: Trigger Happy Havoc or Danganronpa 2: Goodbye Despair.

Hmmm...
WARNING:
If either game is installed in a Steam Library outside of the default, SPIRAL will be unable to find it by default. See Manual Registration
Hmmm...
WARNING:
If you have obtained WAD files from anything but the latest Steam release, there is no guarantee that anything here will work. Regardless of how the files were obtained, SPIRAL only guarantees compatibility with the latest WAD files fresh from Steam.

The second thing you'll need is access to a command prompt or terminal of some kind (Referred to as a terminal throughout these guides). For Windows, this will be the Command Prompt. For macOS and Mac OSX, this will be the Terminal, and on Linux it'll be some variant of a terminal (You should know how to find this).

Next up on our list of requirements is a copy of Java 8. To test this, open your terminal and type java -version. You should see one of two things.

  • Some variation of "Command not found" (On Windows, you'll get 'java' is not recognised as an internal or external command, on macOS/OSX/Linux you'll get java: command not found).
    • This means you'll need to install Java. You'll likely want Java 8, however Java 9 should work too.
  • java version x
    • This means you have Java installed in some capacity. If it says 1.8 followed by some numbers, or 9 followed by some numbers, then good news! You have a recent enough version of Java installed. If it says anything lower than 8, you'll need to install a recent Java version, see above.
Hmmm...
WARNING:
SPIRAL is developed with, built with, and tested against Java 8. While Java 9 does not seem to break anything at this time, be warned that it is not unheard of. If this occurs, file a bug report here, and I'll investigate

Finally, we're gonna need SPIRAL itself. Download the latest version here.

Initialisation

After we have our tools installed, it's time to boot up SPIRAL.

To start things off, open your terminal program. By default, this will be initialised in your home directory (C:\\Users\\<username> for Windows, /Users/<username> for macOS, and /home/<username> on Linux). If this is not where you want SPIRAL to work from, you'll need to navigate to the directory you want with the cd command, which accepts a directory.

Hmmm...
Note:
I would recommend creating a directory for SPIRAL, and putting the JAR file in there. This way, everything's neatly contained, and you don't have to drag and drop the JAR file each time. It also helps if this directory is in your home directory.

Next up, we need to start SPIRAL itself. If the JAR file is in the directory you're currently navigated into, then you can just use the filename for the next part, otherwise you'll have to type the full path in, or drag the file from a file program. It may help to rename the JAR file from it's downloaded name for easier use, as well.

Our command will be formatted like so: java -jar [SPIRAL JAR file]

For instance, if we have a folder named "Spiral Workspace", and put the JAR file in there and called it "Program.jar", we would run in succession cd "Spiral Workspace" (Put in apostrophes because it has a space) java -jar Program.jar

SPIRAL will take a few moments on each startup to check to see if you're running the latest version (With a lot of things, this will be dependent on your system), and then, after a while, you should be greeted by Initialising SPIRAL

And with that, we're in!

Steam Registration

If you have your Steam library located on your main hard drive in the regular location (For Windows this is C:\\Program Files\\Steam\\steamapps and for macOS this is ~/Library/Application Support/Steam/steamapps. SPIRAL does not currently support auto registration on Linux), then you should be able to just run find, and SPIRAL will automatically register any WAD or CPK files it finds.

If SPIRAL does not find the files you need, see the next section - Manual Registration.

Manual Registration

Sometimes, SPIRAL won't be able to find the Danganronpa files. This can happen if you have Steam set up with a separate library, used the Steam command line (For situations where the game is not supported on your operating system), or you copied the files over. Regardless, you have two ways of registering these files.

  1. Register an individual file with register [archive file or directory]
  2. Register files in a folder with locate [directory]
Hmmm...
WARNING:
Using the locate command is a great way to save time, but if you supply a directory that has too many subfiles it will take a long time to traverse and scan each file!
Hmmm...
Note:
You may have noticed that register accepts a directory, despite registering an individual file. This is because Danganronpa V3: Killing Harmony on Steam is able to iterate through directories as opposed to individual CPK files. See: Folder Archive

Registered Files

To see what files you have registered, to make sure you have the right one, you can run registered