dmitry_k
/
compendium-browser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Described new behavior and differentiation from old version

v0.3.1-spetzel2020
Spetzel 2021-02-17 14:11:54 -08:00 committed by GitHub
parent 4ddad55232
commit d96a339991
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,8 +1,7 @@
# Compendium Browser # Compendium Browser
> This version only works for Foundry v0.4.4 and up. To use the previous version please visit https://github.com/syl3r86/compendium-browser/tree/pre-0.4.4 A module to easily browse and filter spells, feats, items, and npcs loaded from compendia.
**NEW** Compendium Browser is faster and better-behaved; **it no longer loads all the compendia into memory on start-up** (which sometimes hung servers because of memory or CPU requirements). Instead, it filters and loads on-demand, as well as giving you a Module Setting to control how many rows are loaded at a time.
A module to easily browse and filter spells as well as npcs loaded from compendia.
## Installation ## Installation
1. Copy this link and use it in Foundrys Module Manager to install the Module 1. Copy this link and use it in Foundrys Module Manager to install the Module
@ -14,11 +13,11 @@ A module to easily browse and filter spells as well as npcs loaded from compendi
![example](preview.jpg) ![example](preview.jpg)
## Details ## Details
Only the Gamemaster has access to the Settings, where they can enable or disable player access to the spell or npc-browser. It is **highly** recommended to disable any compendia that do not contain spell or should not be used in the NPC Browser. This reduces the initial loading time, that happens after a client connects to foundry, immensly. Only the Gamemaster has access to the Settings, where they can enable or disable player access to the spell or npc-browser. It is **highly** recommended to disable any compendia that do not contain spell or should not be used in the NPC Browser. .
This application enables anyone to add their own custom spell or npc filters via the api. After initialization the app can be found under game.compendiumBrowser where either addSpellFilter or addNpcFilter can be used to add a filter. This does support any data that the spell or npc has, including flags. This application enables anyone to add their own custom spell or npc filters via the api. After initialization the app can be found under game.compendiumBrowser where either addSpellFilter or addNpcFilter can be used to add a filter. This does support any data that the spell or npc has, including flags.
All filters featured in the app are included in this manor and can be found in the compendium-browser.js at around line 726. All filters featured in the app are included in this manner and can be found in the compendium-browser.js at around line 726.
## Contribution ## Contribution
If you feel like supporting my work, feel free to leave a tip at my paypal felix.mueller.86@web.de If you feel like supporting my work, feel free to leave a tip at my paypal felix.mueller.86@web.de