Author Topic: Style and contribution guide.  (Read 18331 times)


  • Developer
  • Convict
  • ******
  • Posts: 15
  • *chirp
    • View Profile
Style and contribution guide.
« on: November 30, 2017, 01:58:52 am »
Quick and dirty guide:
  • Always use absolute paths, it makes it a ton easier to search code.
  • If you want to use a colon, cast the var to the appropriate path instead. It's only one extra line.
  • New features/items go in their own folders or files if possible, this will minimize merge conflicts later.
  • Merge policy for PRs will be 24 hours with no complaints/controversy, or two developers signing off, whichever comes first.
  • Bugfixing should be a priority over features and features should be a priority over sprites, but any contribution at all is good.

First-time merge driver steup:
After cloning the repo using your preferred git client (if you don't know how to use git, ask someone on Discord or make a post on this forum), either:
- Run tools/mapmerge/git_merge_installer.bat and tools/dmitool/git_merge_installer.bat.
- Add the following block to your .git/config file:
Code: [Select]
[merge "merge-dmm"]
    name = mapmerge driver
        driver = ./tools/mapmerge/ %O %A %B
[merge "merge-dmi"]
   name = iconfile merge driver
   driver = ./tools/dmitool/ %O %A %B

When making map edits:
  • Run tools/mapmerge/1prepare_map.bat.
  • Make your changes.
  • Run tools/mapmerge/2clean_map.bat.
There was a hole.