Skip to main content

neon_crisp / Modules

Dev Quick Start

  • Use npm run dev to start a watcher that compiles and emits lua and script when you save
  • Use npm run build to just compile your ts, sans watcher
  1. Initialize
cd game_client
npm install
  1. Generate
npm run build # Transpile the TypeScript files to lua
# or
npm run dev # Watch for changes and regenerate files on save
  1. Open app/game.project in Defold
  • Start making games

Boiler plate:​

There is simple cli for generating some of the boiler plate you need

npm run boilerPlate <template> <path>

Example:

npm run boilerPlate test .\src\code\gameContextManger\

Other commands and what they do.​

None of these commands do you ever need to run they are all here for automation.

  • gendocs-> run docsGen.js that scrapes all of our ts source files and pumps them into typedoc because we have a lot of entry points to our code.
  • setupTests-> runs setupTests.js with the arg "test" that will make the main view in defold our testing view that runs tests and closes
  • setmain-> runs setupTests.js with the arg "main" this is used to set our main view to our main view used in building incase we forget to swap views back before a commit we will still build the main view instead of say "board level 1"
  • resolve-> library resolve ( I dont know what does does) I think this pulls down types for defold plug in that has types.
  • lint-> runs eslint on src dir to lint our code.