# General Information [WIP]

<p class="callout info">This feature is available in **1.20.1-1.5+** and will **NOT** be added to outdated versions.</p>

Community Packs is a feature that allows players to add NEW assets to the mod without the use of an add-on mod.

---

#### Important- Update Changes

<p class="callout danger">Existing worlds should be safe to update but always take a backup in case you encounter an issue!</p>

To support community packs, some changes have been made. See additional pages for feature-specific changes.

- Common, Client and Recipe configs now generate in `config/swem`
- Community Pack features will likely break add-on mods.  
    **PLEASE BE PATIENT AND ALLOW CREATOR'S TIME TO UPDATE THEIR MODS**

---

#### Supported Features

<table border="1" id="bkmrk-feature-mod-version-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 15.204%;"></col><col style="width: 17.4289%;"></col><col style="width: 67.3671%;"></col></colgroup><tbody><tr style="background-color: rgb(52, 5, 93);"><td class="align-center"><span style="color: rgb(255, 255, 255);">**Feature**</span></td><td class="align-center"><span style="color: rgb(255, 255, 255);">**Mod Version**</span></td><td class="align-center"><span style="color: rgb(255, 255, 255);">**Notes**</span></td></tr><tr><td class="align-center">Coats</td><td class="align-center">**1.20.1-1.5 Beta +**</td><td>Custom coats that do not override default, and support coat cycling + breeding tags.</td></tr><tr><td class="align-center">Tack</td><td class="align-center" style="height: 29.7969px;">**1.20.1-1.5 Release**</td><td>Custom tack that does not override default tack and can be purchased via EQ Shop.</td></tr><tr><td class="align-center">Animations</td><td class="align-center" style="height: 29.7969px;">**1.20.1-1.5 Release**</td><td>Custom animations that can be triggered via command (loop). </td></tr></tbody></table>

---

#### Frequently Asked Questions

<details id="bkmrk-%5B1%5D-community-pack-%26"><summary>\[1\] Community &amp; Content Packs</summary>

**⮞ WHAT IS A COMMUNITY PACK?** Community Packs are folders that include all the files necessary to add NEW assets such as custom coats to SWEM.

**⮞ WHAT IS A CONTENT PACK?** Content Packs is also a Community Pack, but usually with less content. It will merge into any Community Packs with the same name. This allows:

- Creators to set a consistent pack name and release smaller 'add-ons' to their main pack(s)
- Creators to easily provide updated file (ie fixes or improved) that override their original files
- Players to have fewer individual Community Packs to sort
- Players to have fewer Community Packs listed in game, and easier results by Creator   
    **Example:** `artist_kofi:`  
    **Example:** `artist_fantasy:` or `artist_bays:`

**⮞ HOW DO I KNOW IF A PACK IS READY TO USE (PREMADE)?** This depends on the source, most creators should clearly state if their content is files only or a read to use pack.

- Look at the file contents (unzip the file if it comes zipped)  
      
    ✅ Must be a folder, not a ZIP (or any other)file  
    ✅ Must have a lowercase name with no spaces. ✅`artist_packname` **❌** `Artist Pack Name`  
    ✅ Must have two folders inside it: `json` and `textures`  
    ✅ Must have at least one coats or tack item with all required files.  
     See Creator Corner if you are making a community pack and are unsure what is required.  
      
    **❌** Individual files in a single folder  
    **❌** PNG files in `json > coats` or JSON files in `textures > coats > legacy`   
    **❌** Files or folders with spaces, symbols or capital letters

<p class="callout info">There can still be other errors that prevent a pack working, but this criteria means the pack is structured correctly!</p>

**⮞ WHAT IF PACKS HAVE AN IDENTICAL NAME?**

Community Packs that do not use recommended format could have a duplicate name like `free_coats` or `kofi_coats`.

- Duplicate folders will merge into one with the files of both folders
- Files will not override or replace each other **unless** they have identical names

<span style="background-color: rgb(132, 63, 161); color: rgb(236, 240, 241);"> <span style="color: rgb(255, 255, 255);">**Creators** </span></span>

- Avoid conflicting names with recommended unique format of `coatname_artist` in all files and packs
- Avoid content 'options' with the same name - if you offer variants (ie braids vs roached) give them a unique name
- Avoid creating packs with 'old' files that may override new versions (ie fixed or improved textures)
- Update or remove old packs that may have any such files.

<p class="callout info">Always check that merged files maintain the correct folder structure and file names are valid (ie not coat\_name\_copy)</p>

**⮞ WHAT IF IT ASKS ME TO REPLACE FILES?** There is no correct answer to this:

- Replacing existing files to update a texture error is usually safe.
- Replacing existing files to update coat info for breeding tags, inspiration info is usually fine.
- Replacing existing files with outdated files could revert changes (replace with pre-fix version)  
    If you replace a file with a broken texture or non-functional json, you will need to fix it or re-download the original!

**⮞ CAN I HAVE MULTIPLE COMMUNITY PACKS?** Yes. You can install multiple Community Packs, but you should read **\[4\] Performance** if adding a lot of additional content.

</details><details id="bkmrk-%5B2%5D-modified-packs-%26"><summary>\[2\] Modifying Community Packs</summary>

<p class="callout info">Always read the Creator's Terms Of Use (TOU) as significant non-private alterations or reupload may be prohibited!</p>

**⮞ CAN I REUPLOAD A COMMUNITY PACK +/- MODIFIED?**

**✅**`JSON FILES` You can edit and distribute json files or overrides freely.  
**❌**`PNG FILES` You should not modify, re-upload, distribute or monetize Creator's work without explicit consent.

`PNG FILES` Creators have the right to set and enforce appropriate use of their content.

- You must not modify, re-upload, distribute or monetize Creator's work without explicit consent.

`JSON FILES` Creators can set reasonable requests on json modification, but do not own this asset.

**✅** You can provide **FREE** override files or packs.  
**❌** You must not create and distribute files that violate platform (ie Discord) or Community (ie SWEM) rules.  
**❌** You must not monetize file edits to profit off the original Creator(s) work without consent.  
**❌**You must not provide premade packs that include the content (pngs) of Creator(s) without consent.  
**❌** You must not remove artist credits, or add false credits.  
**❌** You must not remove artist reference, excluding reasonable modification.  
`Esperanza from Spirit` -&gt; ✅ `Palomino (Dreamwork's Spirit: "Esperanza")` **❌** `N/A`

**⮞ CAN I RENAME A PACK (AS A PLAYER / CLIENT)?**

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Multiplayer </span><span style="color: rgb(255, 255, 255);"> </span>**<span style="color: rgb(0, 0, 0);">No. This may prevent you from seeing any custom coats, even if you have all the correct files.</span>

<span style="color: rgb(0, 0, 0);">**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Singleplayer </span><span style="color: rgb(255, 255, 255);"> </span>**</span>Yes. This can sometimes help you organize custom content or shorten pack IDs.

- You must use a unique **lowercase** name with **no spaces** or **symbols**
- You should not edit information **in use by an existing save** (will need to change coats / tack affected).

**⮞ CAN I RENAME A COAT / TACK ITEM?**

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Multiplayer </span><span style="color: rgb(255, 255, 255);"> </span>**<span style="color: rgb(0, 0, 0);">No. This may prevent you from seeing any custom coats or tack, even if you have all the correct files.</span>

<span style="color: rgb(0, 0, 0);">**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Singleplayer </span><span style="color: rgb(255, 255, 255);"> </span>**</span>Yes, though this is **not recommended**.

- You must use a unique **lowercase** name with **no spaces** or **symbols**
- You must set this for the file names of both `json`, `png`, and the texture path inside the `json` file.
- You should not edit information **in use by an existing save** (will need to change coats / tack affected).

<p class="callout warning">You should use standard naming format `coatname_artist` with **appropriate artist credit** by name!</p>

**⮞ CAN I EDIT CUSTOM CONTENT INFORMATION (JSON)?**

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Multiplayer </span><span style="color: rgb(255, 255, 255);"> </span>**<span style="color: rgb(0, 0, 0);">Yes. Important information:</span>

- <span style="color: rgb(0, 0, 0);">Client-side (player) edits will only apply to your singleplayer worlds.</span>
- <span style="color: rgb(0, 0, 0);">Server-side edits will apply to all players, regardless of their individual pack settings.  
    `Texture Path` Players must use the same path to avoid black horses (missing texture)</span>

<span style="color: rgb(0, 0, 0);">**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Singleplayer </span><span style="color: rgb(255, 255, 255);"> </span>**</span>Yes, depending on type:

<table border="1" style="border-collapse: collapse; width: 100%; height: 287.094px;"><colgroup><col style="width: 16.0692%;"></col><col style="width: 25.5842%;"></col><col style="width: 58.3465%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td class="align-center" style="background-color: rgb(52, 5, 93); height: 29.7969px;">**<span style="color: rgb(255, 255, 255);">Content</span>**</td><td class="align-center" style="background-color: rgb(52, 5, 93); height: 29.7969px;">**<span style="color: rgb(255, 255, 255);">Variable</span>**</td><td class="align-center" style="background-color: rgb(52, 5, 93); height: 29.7969px;">**<span style="color: rgb(255, 255, 255);">Comments</span>**</td></tr><tr style="height: 198.703px;"><td class="align-center" style="height: 198.703px;">Coats</td><td style="height: 198.703px;">✅ Artist Credits \*  
  
✅ Inspiration \*  
  
✅ `lapis_cyclable`  
  
✅ `obtainable_by_breeding`  
  
✅ `base_colors`  
  
**❌** Model  
</td><td style="height: 198.703px;">Can include capital letters, spaces and symbols **inside the "" entry**.

Can include capital letters, spaces and symbols **inside the "" entry**.

Effect will apply to future lapis/redstone changes. **Must be true/false.**

Effect will apply to future breeding. **Must be true/false.**

Effect will apply to future breeding. Must use **valid tags.**

Must use Legacy until additional models are supported.

</td></tr><tr style="height: 28.7969px;"><td class="align-center" style="height: 28.7969px;">Tack</td><td class="align-center" style="height: 28.7969px;">TBC</td><td style="height: 28.7969px;"></td></tr><tr style="height: 29.7969px;"><td class="align-center" style="height: 29.7969px;">Animations</td><td class="align-center" style="height: 29.7969px;">TBC</td><td style="height: 29.7969px;"></td></tr></tbody></table>

<p class="callout warning">You must not remove or (unreasonably) modify Artist credits +/- reference and inspiration comments.</p>

</details><details id="bkmrk-%5B3%5D-multiplayer-use-"><summary>\[3\] Multiplayer Use</summary>

**⮞ HOW TO ADD COMMUNITY PACKS TO A SERVER?**

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> Multiplayer </span><span style="color: rgb(255, 255, 255);"> </span>**Paste the community pack(s) into the server's `config > swem > communitypacks` folder as normal.

- Players (clients) must also use the exact same mod version as the server.
- Players (clients) must have a copy of the same community pack folder(s).
- Clients can have additional community packs installed for SP use.

<p class="callout info">See individual pages for troubleshooting common issues for each feature.</p>

**⮞ CAN I USE THE OFFICIAL SWEM COMMUNITY PACK ON A SERVER?** Yes. You can use this on a multiplayer server provided it is free to all players, not re-uploaded externally or monetized.  
You should not modify the contents, except to remove unwanted files or edit obtaining information (tags, breeding etc).

**⮞ CAN I USE CREATOR'S COMMUNITY PACK ON A SERVER?**

<p class="callout info">Always read the Creator's Terms Of Use (TOU) as public multiplayer use, alterations or reupload may be prohibited!  
</p>

</details><details id="bkmrk-%5B4%5D-performance-%E2%AE%9E-wi"><summary>\[4\] Performance</summary>

**⮞ WILL COMMUNITY PACKS MAKE MY GAME LAG?** Performance loss with the community pack features has not been reported, but individual results may vary.

- Community Packs store text and coat files in your config file which will occupy storage space.
- Community Packs require your game to load and register these on load, which may marginally increase load times.
- Community Packs add new content into the game, similar to adding more and more mods it can impact performance.

<p class="callout info">PCs with limited resources or low performance may have a limit on how much custom content it can realistically support.</p>

</details>---

#### Using Community Packs

<p class="callout info">This section explains how to use **PREMADE** Community Packs \[1\] - see [Creators' Corner](https://wiki.swequestrian.com/books/swequestrian-mod/page/creators-corner-wip) to create your own.</p>

<p class="callout warning">Read **\[2\] Modifying Community Packs** before you edit any Community Pack files.</p>

To install your custom content, you need to download or create a Community Pack or Content Pack.

- You can install multiple packs if they have a unique and valid name such as `artist_packname`.
- Content packs will merge into community packs of the same name, or work as a new pack if one does not exist.

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> STEP ONE: </span> GENERATE THE CONFIG FOLDER**

This is only required the first time you add or update the 1.20.1-1.5+ mod file.

1. **\[Optional\]** Backup any existing saves files (recommended)
2. Install the latest 1.20.1-1.5 Beta file
3. Load the game to the menu screen
4. Exit the game

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> STEP TWO: </span> INSTALL THE COMMUNITY PACK**

1. Download or Create your Community Pack  
    → Free Official Community Pack can be found [here](https://discord.com/channels/715626418893095012/737144919717707896/1266908931423469609)!  
    → Free and Paid Community Packs can be found on many creators pages [here](https://discord.com/channels/715626418893095012/1198308571130122250)!
2. Check the file is ready to install  
    → See **\[1\] Community &amp; Content Packs** above (FAQ)
3. Copy the Community Pack
4. Go to `config > swem > community-packs`
5. Paste the Community Pack file  
    → It should look like: `config > swem > community-packs > artist_pack_name`

**<span style="background-color: rgb(132, 63, 161); color: rgb(255, 255, 255);"> STEP THREE: </span> VIEW THE CONTENT IN-GAME**

1. Load the game
2. Load into a save or (recommended) a new test world
3. See relevant pages:  
    → [Coats](https://wiki.swequestrian.com/books/swequestrian-mod/page/coats-new)  
    → [Tack](https://wiki.swequestrian.com/books/swequestrian-mod/page/tack-wip)  
    → [Animations](https://wiki.swequestrian.com/books/swequestrian-mod/page/animations-wip) <span style="color: rgb(255, 255, 255); background-color: rgb(132, 63, 161);"> **COMING SOON** </span>

---


#### Known Issues

If you find an issue, please report it to our bugs channel on [Discord](https://discord.com/channels/715626418893095012/898242623716855868). We ask that you look to see if your issue was reported first!

---

#### Changelog

<details id="bkmrk-this-is-not-a-comple"><summary>View Changes</summary>

<p class="callout info">This is not a complete list of version changes / fixes. It is a changelog of relevant wiki-related version information.</p>

<table border="1" style="border-collapse: collapse; width: 100%; height: 121.781px;"><tbody><tr style="height: 29.7969px;"><td class="align-center" style="width: 13.3504%; height: 29.7969px;">**MC Version**</td><td class="align-center" style="width: 20.0257%; height: 29.7969px;">**Release**</td><td class="align-center" style="width: 66.6239%; height: 29.7969px;">**Notes**</td></tr><tr><td style="width: 13.3504%;">  
</td><td style="width: 20.0257%;">  
</td><td style="width: 66.6239%;">  
</td></tr></tbody></table>

</details>