https://github.com/darklight1337/my-homebrew

A personal FoundryVTT module containing homebrew items.
https://github.com/darklight1337/my-homebrew

foundry-vtt foundryvtt

Last synced: 10 days ago
JSON representation

A personal FoundryVTT module containing homebrew items.

• Host: GitHub
• URL: https://github.com/darklight1337/my-homebrew
• Owner: DarkLight1337
• License: mit
• Created: 2023-11-16T06:44:50.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-03-31T06:57:26.000Z (7 months ago)
• Last Synced: 2024-10-07T08:03:25.484Z (about 1 month ago)
• Topics: foundry-vtt, foundryvtt
• Language: JavaScript
• Homepage:
• Size: 464 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# My Homebrew

A personal [FoundryVTT](https://foundryvtt.com) module containing homebrew items.

## Usage

### Installation

1. Open the setup page in Foundry VTT.

2. Click on the Add-on Modules tab.

3. Click the Install Module button.

4. Copy the [Manifest URL](https://raw.githubusercontent.com/DarkLight1337/my-homebrew/master/dist/module.json) to the bottom of the dialog.

5. Click on the Install button.

### Compendium Packs

The compendium pack "My Homebrew" contains the main content of this module. This content can be directly added to your world from the compendium without having to import them first.

### Macros

The macros are available under the global variable `MyHomebrew.Macros`. You can open the Developer tab of your browser (usually by pressing F12) and explore the code through the console.

## Development

### Requirements

- [npm](https://www.npmjs.com) 10.2+

- [Python](https://www.python.org) 3.8+

### Installation

1. Clone this repository to your machine.

2. Run `npm install` to setup the environment for JavaScript development.

3. Create a new world for testing this module.

4. Edit `./link_vtt.py` and run it in Python to create symbolic links between this repository and Foundry VTT.

    - On Windows, you may need administrator privileges to create symbolic links.

    - If you are using [WSL](https://learn.microsoft.com/en-us/windows/wsl/), make sure to execute this in the same operating system as the one Foundry VTT is installed on.

### Live Testing

1. Open the test world.

    - For compendium content:

        1. Right-click the compendium pack and remove the edit lock.

        2. Edit the content of the compendium directly in the world.

        3. Any changes are automatically reflected in this repository.

    - For macros:

        1. Update the code in this repository.

        2. Run `npm run lint` to check the code.

            - Since TypeScript is unable to ignore errors in external packages while providing type information, it is not run in the `lint` step. To type check the code in this package only, use the filter feature in IDEs such as [VSCode](https://code.visualstudio.com/) to ignore errors originating elsewhere.

        3. Reload the web page to use the updated code.

            - If the code is somehow not updated, you may have to fully reload the world.

### Distributing

1. Increment the version number in `package.json`.

2. Run `npm run build` to generate the bundled files for other users to download the module.

3. Release the new version by pushing the commit to the remote repository.