Setup

These are verbose instructions on how to set up Danmokou on your first run.

Part 0: Check Your Files

• Get Danmokou from GitHub. Details are as follows:
  • Install git if you don't have it.
  • Locate a folder in which you'd like to store the project files. The files will be stored directly in this directory. CD to the folder in your command line / terminal / bash shell.
  • Run git init.
  • Run git remote add super https://github.com/Bagoum/danmokou.git. This will allow you to reference the project repository via the alias "super".
  • Run git pull super master.
    • master is the latest version. You can also pick any version available on the tags page and run eg. git pull super v11.1.0.
  • Run git submodule update --init --recursive. This will import code from several submodules, including SiMP, which is a fully structured game, and SuzunoyaUnity, which is a visual novel engine that powers the dialogue system.
    • If you do not want code from the extra submodules, then you can run git submodule update --init --recursive Assets/SZYU to only handle SuzunoyaUnity, which is required for the engine to work.
• If you already have a git repository with Danmokou, you can update it as follows:
  • Assuming you have not made edits to any submodules:
    • Run git pull --rebase super master.
    • Run git submodule update --recursive.
      • Again, you can run git submodule update --recursive Assets/SZYU if you want to ignore the other submodules.
      • If updating from v7.0.0 or earlier, you will need to add an --init when updating SZYU.
  • If you have made edits to submodules, you will need to git pull --rebase the individual submodules instead of running git submodule update.
• If you have VSCode, get the extension Danmokou Scripting, which provides a lot of convenience for writing behavior scripts in DMK.

Part 1: Unity Setup

• Download/Install Unity Hub (https://store.unity.com/download-nuo), then run it
• Within Unity Hub > Installs, add Unity version 2023.2.9 (Preferred for DMK v11, though any 2023.2 or higher should work)
• Within Unity Hub > Projects, click ADD and browse to the root Danmokou folder.
• Click on the project to load it. The first time you load it, Unity may take several minutes to import resources.
  • If you get an error that the project contains compilation errors, click "Ignore". Once the project has loaded, you may see a compilation error saying something about PanelSettings missing. If you trigger a recompile (eg. by adding code or comments to any C# file in the solution), the error should disappear.
• Once you are in the Unity Editor, click on the Project tab (by default in the bottom window) and browse to Assets/Danmokou/Scenes/BasicSceneOPENME.
• (Error handling) If you see a lot of pink squares in the game view where text should be, then go to Window > TextMesh Pro > Import TMP Essential Resources and click Import in the popup window. If you can see the text, then you don't need to do this.

Part 2: What is DMK?

• At the top of the game view, you should see three text boxes, saying something like: Display 1 | Resolution | Scale ----. Click on the second box, which shows the resolution of the game view. Either set it to the aspect ratio 16x9, or manually input a resolution at the bottom with 16x9 ratio (3840x2160 is the native resolution). You may want to set the "Vsync" checkbox to true if it exists.
• You should still be in Assets/Danmokou/Scenes/BasicSceneOPENME. Go to the Hierarchy window (by default on the left side) and click on the "mokou-boss" object.
• The Inspector window (by default on the right side) will open up and list all the components on the object. The important component here is Boss BEH. Look under Boss BEH for the variable named "Behavior Script". To the right of it, you should see a text file titled "DMK Tutorial Setup 00". Click this once to make it show up in the Project window. Right-click it and select "Show in Explorer" to show it in Windows Explorer.
• This is a BDSL file, which is a raw text file. If you have VSCode, you can get the extension Danmokou Scripting and open it with VSCode. Otherwise, you can open it with whatever text editor you prefer to use.
• The file should have the following contents:

// Go to https://dmk.bagoum.com/docs/articles/t01.html for the tutorial. 
pattern { } {
	phase 0 {} {
		paction 0 {
			shiftphaseto(1)
		}
	}
			
	// This is phase #1. 
	phase 0 {
		type(non, "Hello World")
		hp(4000)
	} {
		paction 0 {
			position(0, 1)
		}
	}
}

• This is a behavior script. Almost all interesting behavior in DMK is defined through behavior scripts, written in Bagoum Danmaku Scripting Language (BDSL).
• Run the scene by pressing the play button at the top of the screen. Objects should start animating and you should see the message "Hello World" at the top of the game UI.
  • Note: you may seen cyan squares on the screen when certain objects first appear. This should only happen once per object type. For example, the first time you open the pause menu, you might see a cyan square. This is due to shader recompilation and is harmless. It does not occur in builds.
• Make sure that the FPS counter (bottom right of the game UI) is stable. If it is excessively high, then press Esc to open the in-game pause menu and turn Vsync OFF. If your computer is old, you may need to turn shaders OFF as well. These settings will be saved as soon as you close the menu.
• Because behavior in DMK is written in BDSL and not in C#, you can recompile scripts at runtime without significant overhead. To do this, simply press R in the game view while the game is running. If you are successful, you should see the "Hello World" message disappear and fade back in, and the boss health bar should empty out a bit.
• That's all for setup. If you'd like to get right into firing bullets, you can move onto the first tutorial, or if you'd like to get a feel for the scripting language first, you can reference the language guide.

Part Extra: IDE Setup

When you get around to eventually extending the engine with your own functions and mechanics, you'll probably use some IDE for editing C#. The three most common are Rider, Visual Studio, and VS Code. I use Rider.

If using VS Code, you may come across an issue where many references in the codebase do not compile. In this case, reinstall your C# extension to version 1.23.2.