higurashi-assembly: A repository from OtameganeMinh

Code base and resulting assembly for Assembly-CSharp.dll

There's not much going on with this branch; it just hosts the README at the moment.

Branches and Arcs

There are three branches per arc, the most pertinent being <arc>-mod, the mod version of a given arc. The vanilla MG and reconstructed vanilla Steam (may not be exactly the same) versions of the game can be found for each arc at <arc>-mg and <arc>-steam respectively, and should be useful for comparison.

The branch lineage looks like this, where the parent of a branch at depth n is the nearest branch above at depth n-1; for example, the parent of hima-mg is tata-mg.

oni-mg
* oni-steam
** oni-mod
*** mod <-- development
**** f-lipsync <-- example feature in progress
* wata-mg
** wata-steam
*** wata-mod
** tata-mg
*** tata-steam
**** tata-mod
*** hima-mg
**** hima-steam
***** hima-mod
****** console-arcs
**** mea-mg

...etc. The rationale behind this is that each arc seems to build on the code from the previous arc, and the Steam versions seem to be extensions of the MG versions, while our mods are based on the Steam version.

Ongoing development will be based on the mod branch and the relevant branch for each arc is <arc>-mod, with the exception of console-arcs, which is branched off hima-mod.

Decompilation

The decompiled code was created via ILSpy commit 3fb25e543bda4ac6664b44b7183b5e29161b51b9.

This requires both the MG and the steam versions of the game.

Steps to get the code for a new game (using Minagoroshi as an example)):

Prepare a new branch
- Checkout the previous branch's vanilla arc, let's assume tsumi-mg
- git checkout -b mina-mg
- Take note of the DLLs in the ./DLLs folder
- Delete all code from this branch's folders without commmitting yet
Open ILSpy
Load Assembly-CSharp.dll from that MG-version <data>/Managed directory
Save the code as a project to the repo's workspace, where the tsumi code was and is now deleted
- Now, the Minagoroshi code will be there
Carry over any DLLs from the new game's directory to the DLLs folder that were there for the previous game's DLLs folder (also, the Assembly-CSharp.csproj file will reference these DLLs)
Try to build. If it fails, the decompiler may have failed to decompile some things correctly
- Compare to the previous arc's code using git diff.
- If the diff looks substantial, then it may require manually analyzing the code to figure out its intended behavior and correction from there.
- If the diff looks trivial, then it is probably the same old code as the last arc; you can checkout the corresponding code from the previous arc instead.
- Once the build succeeeds and the resulting Assembly-CSharp.dll works for the vanilla game, then it is ready to be checked in.
For the -steam branch, this process can either be repeated with the steam version's DLL with the parent branch being the mg version of this game instead of the previous arc, or one can merge the steam branch (recommended).
- If doing it from the Steam DLL, check the steam branch history to see what changes we have made to the base Steam code and apply those accordingly.
For the -mod branch, create the -mod branch based on the steam branch and merge the mod branch. It may also be possible to base this branch off of the previous branch's mod branch for less conflicts, but the previous arcs all has a branch parentage of arc-mg <- arc-steam <- arc-mod as in the diagram above.

Build details

Build info:

These projects (Assembly-CSharp.csproj) have been built successfully with Visual Studio Community 2017 v15.7.5 and msbuild v15.7.180.61344, though in theory any compiler supporting C# 7.1 should suffice.
To build with Visual Studio, load the sln file and use build command.
To build with msbuild, execute msbuild Assembly-CSharp.csproj via the command line. On Windows, this may require a developer command prompt to have msbuild in your PATH; this comes with Visual Studio.
The resulting Assembly-CSharp.dll will be located at bin/Debug/Assembly-CSharp.dll.

The built DLLs are available here:

Onikakushi