Giter Club home page Giter Club logo

makaikit's Introduction

Makai Kit

Collection of utilities for modifying Disgaea and other NIS games.

Mod Loader Installation

Either extract the contents of a distribution zip for the particular game into the installation directory of that game, or place a compiled dinput8.dll in the base game directory and makaikit-modloader-{GAME}.dll in a mkplugins subdirectory.

- Disgaea 7 Vows of the Virtueless/
  - Disgaea7.exe
  - dinput8.dll
  - mkplugins/
    - makaitkit-modloader-d7.dll
  - mods/

Mod installation

Place the mod's directory in the mods subdirectory, for example:

- Disgaea 7 Vows of the Virtueless/
  - Disgaea7.exe
  - dinput8.dll
  - mkplugins/
  - ...
  - mods/
    - downloaded-mod-v1/
      - ...

Mod Creation

Mods are loose-file directories placed under the mods subdirectory. All directory names prefixed by 1 or more underscores (_) are reserved for this purpose (e.g. don't name it _generated).

Example layout:

- mods/
  - my-mod-v1/
    - databases/
      - item/
        - 10000_ITEM_MYMOD_CUSTOM_01.json
    - files/
      - data/
        - sound/
          - CUSTOM_SOUND.nlsd
    - README.md

Mods are loaded in lexicographic order.

Flat file replacement

All files in the files subdirectory of a mod will be used to replace file requests in the virtual filesystem used by the game. For example, if the game requests data/sound/CUSTOM_SOUND.nlsd, the mod loader will attempt to find the file and substitute it by mod load order.

Database patching

Database entries for supported databases will be combined from all mods into a new generated database. These are placed in _generated/ on startup.

Database entries may come in 3 forms:

  • Full JSON record. These are the output of the database unpacker. The file extension for these must be .json.
  • RFC7368 JSON Merge-patch. These patches will be applied in mod load order to accumulate the final database record. The file extension of these must be .merge.json, and include either the record ID as a prefix, or the record's Lua enum name (ideally both).
  • RFC6902 JSON Patch. These follow the same rules as merge patches but must have the extension .patch.json.

Script replacement

Only applies to Disgaea 6. Lua scripts in the scripts subdirectory of a mod will be patched into a new script.dat on startup in mod load order.

License

makaikit is made available under the terms of the GNU General Public License 3.0. Mods created for use with makaikit are not required to be made available under the same license unless code from makaikit itself is used.

makaikit's People

Contributors

hybrideidolon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

yamgifhub

makaikit's Issues

Disgaea 7 support

Tracking issue for Disgaea 7 loading support.

*I don't own the game yet

D7 Database Mapping Tracking Issue

  • act.dat
  • acteffect.dat
  • actfeature.dat
  • actlearn.dat
  • actmap.dat
  • ai.dat
  • aiparts.dat
  • anime.dat
  • animebank.dat
  • archive.dat
  • area.dat
  • battleflag.dat
  • bgm.dat
  • bu.dat
  • calc.dat
  • cellfeature.dat
  • characlass.dat - CharaClassData
  • character.dat
  • charactersetting.dat
  • charactersettingdebug.dat
  • charafeature.dat
  • charaflag.dat
  • charahelp.dat
  • charazukan.dat
  • cheatsetting.dat
  • cmd.dat
  • credit.dat
  • debugconfig.dat
  • debugtestconfig.dat
  • demo.dat
  • democharacter.dat
  • doping.dat
  • drink.dat
  • dungeon.dat
  • ending.dat
  • enemycreatetable.dat
  • enemyparameterstable.dat
  • eventcg.dat
  • eventviewer.dat
  • evility.dat
  • evility_capacity.dat
  • featuretext.dat
  • font.dat
  • framebuffer.dat
  • framework_anime.dat
  • framework_animebank.dat
  • framework_archive.dat
  • framework_bgm.dat
  • framework_calc.dat
  • framework_cmd.dat
  • framework_credit.dat
  • framework_debugconfig.dat
  • framework_font.dat
  • framework_framebuffer.dat
  • framework_gamedefine.dat
  • framework_history.dat
  • framework_icon.dat
  • framework_model.dat
  • framework_msg.dat
  • framework_networkdefine.dat
  • framework_number.dat
  • framework_pad.dat
  • framework_particle.dat
  • framework_particlebank.dat
  • framework_renderstep.dat
  • framework_scripttype.dat
  • framework_se.dat
  • framework_shader.dat
  • framework_string.dat
  • framework_talkcommand.dat
  • framework_texture.dat
  • framework_trophy.dat
  • framework_updatelevel.dat
  • framework_vkey.dat
  • framework_vkeycategory.dat
  • framework_waterparam.dat
  • framework_window.dat
  • framework_zdefine.dat
  • gamedefine.dat
  • gameeffect.dat
  • gameeffect_condition.dat
  • gameeffect_effect.dat
  • gameeffect_feature.dat
  • gameeffect_value.dat
  • gameflag.dat
  • gamesetting.dat
  • gamesettinglist.dat
  • geoeffect.dat
  • geopanel.dat
  • group.dat
  • history.dat
  • hospitalgacha.dat
  • icon.dat
  • innocent.dat
  • innocentaffinity.dat
  • item.dat
  • itemcustom.dat
  • itemeffect.dat
  • itemeffecttable.dat
  • itemfeature.dat
  • itemshoplineup.dat
  • itemstrengthen.dat
  • itemtype.dat
  • itemworldlottery.dat
  • job.dat
  • lotterytable.dat
  • makaijingi.dat
  • map.dat
  • mapobject.dat
  • model.dat
  • modelinfo.dat
  • modelsequence.dat
  • modelsequencelist_record.dat
  • modelsequencetype.dat
  • msg.dat
  • music.dat
  • notice.dat
  • number.dat
  • pad.dat
  • particle.dat
  • particlebank.dat
  • personality.dat
  • placement_battle.dat
  • placement_character.dat
  • placement_town.dat
  • quest.dat
  • quest_type.dat
  • randommap.dat
  • randommap_area.dat
  • randommap_areamask.dat
  • randommap_light.dat
  • randommap_material.dat
  • randommap_object.dat
  • randommap_posteffect.dat
  • randomname.dat
  • rankbattle.dat
  • rankbattle_partysetting_debug.dat
  • rankbattle_reward.dat
  • rankbattle_testenemy.dat
  • record_allrecord.dat
  • record_networkrecord.dat
  • renderstep.dat
  • reward.dat
  • rewardtable.dat
  • saveicon.dat
  • scripttype.dat
  • se.dat
  • senator.dat
  • shader.dat
  • shoprank.dat
  • sounddefine.dat
  • stage.dat
  • stagemission.dat
  • stagemissionlist.dat
  • stagemissionreward.dat
  • string.dat - StringData
  • talk.dat
  • talkcommand.dat
  • talkdefine.dat
  • talklist.dat
  • texture.dat
  • tournament.dat
  • tournament_team.dat
  • towntalklist.dat
  • trophy.dat
  • tsumeshogi.dat
  • tsumeshogi_reward.dat
  • tutorial.dat
  • tutoriallist.dat
  • updatelevel.dat
  • victorycondition.dat
  • vkey.dat
  • vkeycategory.dat
  • voice.dat
  • voicetype.dat
  • waterparam.dat
  • weapontogether.dat
  • window.dat
  • wish.dat
  • zdefine.dat

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.