diff --git a/wiki/users/custom-compendiums.md b/wiki/users/custom-compendiums.md index a07f43b..32583f8 100644 --- a/wiki/users/custom-compendiums.md +++ b/wiki/users/custom-compendiums.md @@ -1,10 +1,59 @@ -# Custom Compendiums -Never directly edit the system compendiums. +# Compendiums +**Never directly edit the system compendiums**. They will be erased anytime you update the system. -The better options to keep the links between items and properties for example, is to fill a custom compendium using babel. +The best option to keep the links between items and properties for example, is to fill a custom compendium using Babele. This way, the system compendiums will be overridden by this module. + +## Using the Custom Compendiums Maker (recommended) +Here is a quick guide to fill the compendiums with Custom Compendium Maker. + +1. Go to the [Custom Compendiums Maker Website](https://vly.yn.lu/l5r5e-custom-compendium-maker/) +2. Download the template file : + +![Download](img/ccm_usage_dl.png) + +3. Open the template file with any software who can open and write an Excel sheet (.xlsx). +4. Check instruction on `Infos` sheet. +5. Go into the `Configuration` sheet, and changes the values in the `Values` column.
If your language is `English` you'll probably only need to change the `Author` value. + +![Template config](img/ccm_excel_config.png) + +6. Add the various descriptions on all sheets.
Here an example on the `Techniques` sheet : + +![Template Techniques](img/ccm_excel_tech.png) + +7. Regularly save the file ! +8. When it's done, visit the website again and follow the instructions. + +![Options](img/ccm_usage_options.png) + +9. Download the generated archive file. + +![Archive](img/ccm_archive.png) + +10. Extract it in your FoundryVTT `modules` directory. + +![FVTT Modules](img/ccm_foundry_datadir.png) +![FVTT CCM](img/ccm_archive_extracted.png) + +11. Open FoundryVTT and load an L5R5e World. +12. Make sure to have all these modules enabled : + - Babele + - L5R5e Custom Compendiums + - LibWrapper + +![FVTT Loaded](img/ccm_foundry_module_manager.png) + +13. Open an item you know you had added a description to see the result : + +![FVTT Tech](img/ccm_foundry_tech_filled.png) + +14. Done, have a good time playing L5R ! + + +## Using the Custom Compendiums Module You will need to manually download the following module, and edit json files. Please follow the instructions on : > https://gitlab.com/teaml5r/l5r5e-custom-compendiums diff --git a/wiki/users/img/ccm_archive.png b/wiki/users/img/ccm_archive.png new file mode 100644 index 0000000..6d77a82 Binary files /dev/null and b/wiki/users/img/ccm_archive.png differ diff --git a/wiki/users/img/ccm_archive_extracted.png b/wiki/users/img/ccm_archive_extracted.png new file mode 100644 index 0000000..b12f1f8 Binary files /dev/null and b/wiki/users/img/ccm_archive_extracted.png differ diff --git a/wiki/users/img/ccm_excel_config.png b/wiki/users/img/ccm_excel_config.png new file mode 100644 index 0000000..610781f Binary files /dev/null and b/wiki/users/img/ccm_excel_config.png differ diff --git a/wiki/users/img/ccm_excel_tech.png b/wiki/users/img/ccm_excel_tech.png new file mode 100644 index 0000000..0fbbe79 Binary files /dev/null and b/wiki/users/img/ccm_excel_tech.png differ diff --git a/wiki/users/img/ccm_foundry_datadir.png b/wiki/users/img/ccm_foundry_datadir.png new file mode 100644 index 0000000..7de511d Binary files /dev/null and b/wiki/users/img/ccm_foundry_datadir.png differ diff --git a/wiki/users/img/ccm_foundry_module_manager.png b/wiki/users/img/ccm_foundry_module_manager.png new file mode 100644 index 0000000..cdb12f0 Binary files /dev/null and b/wiki/users/img/ccm_foundry_module_manager.png differ diff --git a/wiki/users/img/ccm_foundry_tech_filled.png b/wiki/users/img/ccm_foundry_tech_filled.png new file mode 100644 index 0000000..7a742be Binary files /dev/null and b/wiki/users/img/ccm_foundry_tech_filled.png differ diff --git a/wiki/users/img/ccm_usage_dl.png b/wiki/users/img/ccm_usage_dl.png new file mode 100644 index 0000000..1cf2b6c Binary files /dev/null and b/wiki/users/img/ccm_usage_dl.png differ diff --git a/wiki/users/img/ccm_usage_options.png b/wiki/users/img/ccm_usage_options.png new file mode 100644 index 0000000..3c223e5 Binary files /dev/null and b/wiki/users/img/ccm_usage_options.png differ