Home

Welcome to the foundryvtt-shadowdark wiki!

Setting up Your Development Environment

The following software/versions are required for building and testing the system at the current time.

• NodeJS v18.14

If you use the Visual Studio Code editor, a number of helpful extensions are recommended (but not required):

• EditorConfig for VS Code
• ESLint
• i18n Ally
• Prettier - Code formatter
• Todo Tree

Installation

Coding Style

Please use the existing code as a guide, as well as conforming to Editor Config and ESLint settings included within the repository.

There are a few golden rules which should be adhered to:

• All files should be in UTF-8 format with LF end-of-lines
• Tabs are used for indentation
• Trailing whitespace should be trimmed before committing code

Other than that, use your best judgement and try to make your code as easy to read as possible, with sensible variable names, etc.

If you are a new developer, the Code Complete book by Steve Mcconnell is an excellent starting place.