Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 3.03 KB

design.md

File metadata and controls

49 lines (39 loc) · 3.03 KB
Raw

Modules

Independent pieces with their own goal. Have their own top level tab.

Most(/all?) of these files are extensions of UI classes

  • levelEditor/: Module for editing levels and running scripts on them. Tab is called "Workshop".
    • workshop/: All the code that doesn't deal with an individual level.
    • details/: All the stuff that appears in the left pane of the level editor.
  • dataExplorer/: Module for investigating/reverse engineering misc. stuff in the PlatformerBuilder folder.
    • viewers/: The lasses that display the contents of a file in various ways.
  • campaignEditor/: Module for editing campaigns.
    • overview/: All the code that doesn't deal with editing an individual campaign

Core systems

The stuff on which the rest of CH is built.

  • chaoshead/: All the top-level/module-independent UI stuff.
  • levelhead/: All the code for integrating with Levelhead stuff
    • data/: Wrappers around the data files.
    • lhs/: All the code directly dealing with a .lhs file.
      • read & write convert between the file and a direct representation in Lua
      • parse & serialize convert between that direct representation and usable representations of actual levels
    • level/: Everything dealing with the Lua representation of a LH level.
      • limits.lua: A list of functions for checking various limits imposed by several different things.
  • ui/: The main UI system. Has its own design.md describing (some of) the design of the UI system.

Misc code

  • script/: The scripting system. Probably shouldn't be its own folder in its current state.
  • exePatch/: Stuff related to patching the executable.
    • noCache.md: Description of how te recreate the patch to disable level caching
    • noCache.1337: Actual file saying which bytes to change. File format is from x64dbg.
  • tools/: Code that should be accessible from user scripts.
  • scripts/: Built-in scripts. Limited to /.built-in/ to keep them apart from user scripts.
  • libs/: Contains external libraries
  • utils/: Other code that didn't fit anywhere else.

Resources

  • data/: Contains .tsv data files based on the spreadsheet
  • settings/: The default settings.
  • docs/: Documentation for user scripts.
  • resources/: Contains non code misc. stuff (font & image used in README)
  • licenses/: All the licenses of third-party stuff used by Chaoshead. Has a naming scheme for the licenses.
  • .github/: Contains the release Github Action.
  • https.dll: HTTPS library, has to be top-level because DLL libraries are weird. This is the 64x bit Windows version, which is included because I think that's what most developers would use. CH will report a nice error modal and where to get a different version if it fails to load when you use a different system.
  • https32.dll: Manual build HTTPS library. Build commit https://github.com/love2d/lua-https/commit/34035b6d5135c253b6c36a4547287da4d487ce3c for Windows 32 bit.